general edits and corrections

docs/archived.rst

@@ -0,0 +1,11 @@
+SSL Orchestrator Lab Guide Archive
+================================================================================
+
+The following Lab Guides apply to older/deprecated versions of F5 SSL Orchestrator. They are provided here for reference.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   archive*/archive*
+

docs/class5/module2/lab1.rst

@@ -57,7 +57,7 @@ If you are not familiar with the process for joining a training course, refer to
 
 
  .. note::
-    You will only need your local web browser access the lab VMs.
+    You will only need your local web browser to access the lab VMs.
 
 
 .. |join_link| raw:: html

docs/class5/module2/lab2.rst

@@ -145,7 +145,7 @@ The following tables provide device/service network configuration details. Login
      - 10.1.1.7/24
      - Management VLAN
    * - 1.1
-     - 10.0.10.7/24
+     - 10.1.10.7/24
      - Client-Side VLAN (Ubuntu-Client)
    * - 1.2 (Tag 30)
      - 198.19.96.7/25

docs/class5/module3/lab2.rst

@@ -77,7 +77,7 @@ Now, you will create a simple HTTPS application.
 
 #. Enable (toggle on) the **Enable HTTPS (Client-Side TLS)** option to show additional settings.
 
-   - Click on the **Add** button to open the configuration panel.
+   - In the **SPECIFY THE CERTIFICATES DETAILS FOR THIS APPLICATION** section, click on the **Add** button to open the configuration panel.
    - In the **Add Client-Side TLS** panel, enter ``wildcard.f5labs.com`` as the name
    - Select **wildcard.f5labs.com** in the **RSA certificate** dropdown list box. This certificate was pre-installed in your lab environment.
    - Click on the **Save** button to close the panel.
@@ -96,7 +96,7 @@ Now, you will create a simple HTTPS application.
 
 #. Click on the **Save** button to the close the **Protocols & Profiles** panel. 
 
-   Notice that the **TLS** and **HTTPS** badges were added, and **MIRRORING** was removed.
+   Notice that the **TLS** and **HTTPS** labels were added, and **MIRRORING** was removed.
 
    .. image:: ./images/add-app-7.png
 

docs/class5/module3/lab3.rst

@@ -34,6 +34,15 @@ You will now test the HTTPS application by sending a command line **cURL** reque
 
       curl -vk https://10.1.10.20
 
+
+   .. tip::
+      To avoid errors in typing the shell commands, hover your mouse over the right side of the gray text block to reveal the **copy** shortcut. Click on it to copy the text block to your local workstation's clipboard.
+
+      You can **paste** into the **Web Shell** with the following keyboard shortcuts:
+
+      - Windows: **<Control-Shift-V>** or **<Shift-Insert>**
+      - Mac: **<Control-V>**
+
    The output of this command will contain the full HTML payload of the web page.
 
 

docs/class5/module4/lab4.rst

@@ -17,7 +17,7 @@ You will now create a traffic policy with a TLS decryption bypass rule for a spe
 
 #. In the **SSL Orchestrator** menu, click on **Policies**.
 
-#. Since there are no **Service Chains** yet, click on the **Start Creating** button to get started.
+#. Since there are no **Policies** yet, click on the **Start Creating** button to get started.
 
 #. In the **Create Policy** panel's **General Properties** section:
 

docs/class5/module4/lab5.rst

@@ -62,7 +62,7 @@ Create an Inbound Application with SSL Orchestrator Policy
 
 #. Click on the **Save** button to the close the **Protocols & Profiles** panel. 
 
-   Notice that the **TLS** and **HTTPS** badges were added, and **MIRRORING** was removed.
+   Notice that the **TLS** and **HTTPS** labels were added, and **MIRRORING** was removed.
 
 
 #. In the **Security Policies** column, click the **edit icon** to open the **Security Profiles** panel.

docs/class5/module5/lab2.rst

@@ -56,13 +56,10 @@ Now, you will create an ICAP inspection service.
 
    - If Validation is successful, click the **Deploy Changes** button to push this inspection service configuration to the BIG-IP Next instance.
 
-     .. image:: ./images/icap-4.png
-
-
    - At the **Deploy Inspection Service?** prompt, click on the **Yes, Deploy** button and wait for the task to complete.
 
 
 After deployment, the new inspection service will appear in the list.
 
-   .. image:: ./images/icap-5.png
+   .. image:: ./images/icap-4.png
 

docs/class5/module5/lab5.rst

@@ -1,7 +1,7 @@
 Creating an Inbound Gateway Deployment
 ================================================================================
 
-You have completed the create of SSL Orchestrator Inspection Services, Service Chain, and Traffic Policy. The next step is to apply this to an application.
+You have created an SSL Orchestrator Inspection Service, a Service Chain, and a Traffic Policy. The next step is to apply this to an application.
 
 Create an Inbound Gateway Application with SSL Orchestrator Policy
 --------------------------------------------------------------------------------
@@ -59,7 +59,7 @@ Create an Inbound Gateway Application with SSL Orchestrator Policy
 
 #. Click on the **Save** button to the close the **Protocols & Profiles** panel. 
 
-   Notice that the **TLS** and **HTTPS** badges were added.
+   Notice that the **TLS** and **HTTPS** labels were added.
 
    .. image:: ./images/igm-app-4.png
 

docs/class5/module6/lab2.rst

@@ -1,11 +1,13 @@
-Setting up the API Client
+Accessing the Rest API Client
 ================================================================================
 
-|thunder-client| is a lightweight Rest API client for testing APIs. It has a similar look and feel to the **Postman** tools, but implemented as a |vscode| extension. If you choose to use **Postman** in other environments, the **Thunder Client** can convert its collections and environments to **Postman** format.
+In this lab, you will need to log into the **Client VM desktop** to launch **VS Code** and access the **Thunder Client** extension. Then, you will send Rest API requests to the **F5 BIG-IP Central Manager** in order to create and deploy an SSL Orchestrator configuration (with an HTTPS application).
+
+|thunder-client| is a lightweight Rest API client for testing APIs. It has a similar look and feel to the **Postman** Rest API tool, but implemented as a |vscode| extension. If you choose to use **Postman** outside of the F5 UDF lab environment, the **Thunder Client** can convert its collections and environments to **Postman** format.
 
 .. |vscode| raw:: html
 
-   <a href="https://code.visualstudio.com/" target="_blank">Visual Studio Code (VS Code)</a>
+   <a href="https://code.visualstudio.com/" target="_blank"><b>Visual Studio Code (VS Code)</b></a>
 
 .. |thunder-client| raw:: html
 
@@ -15,8 +17,6 @@ Setting up the API Client
 Log into the Client Remote Desktop
 --------------------------------------------------------------------------------
 
-In this lab, you will need to log into the **Client VM desktop** to launch **VS Code** and the **Thunder Client** to send API requests to the **F5 BIG-IP Central Manager**.
-
 #. In the UDF **Deployment** tab, find the **Ubuntu-Server** resource.
 
 #. Under **Ubuntu-Server**, click on **ACCESS** to see the list of available access methods.
@@ -42,6 +42,10 @@ You will now set up the **Thunder Client** extension in **VS Code**.
    .. image:: ./images/vscode-3.png
 
 
+   .. caution::
+      **VS Code** might notify you that a software update is available. Do NOT install the update because a newer version might break this lab.
+
+
 #. In **VS Code** , click on the **Thunder Client** icon in the left side bar to see the extension's interface.
 
    .. image:: ./images/vscode-4.png
@@ -50,13 +54,17 @@ You will now set up the **Thunder Client** extension in **VS Code**.
 About Thunder Client Environment Variables
 --------------------------------------------------------------------------------
 
-Environment variables provide shortcuts by substituting stored values into API requests when they are sent. All of the API calls in the SSL Collection will minimally include a **{{CM}}** variable value. Several variables are provided in the included SSLO Environment file.
+**Environment** variables provide shortcuts by substituting stored values into API requests when they are sent. Several variables are provided in the included SSL Orchestrator **Environment** file.
 
 #. To view these Environment values, click on the **Env** tab in the Thunder Client top menu bar (under the **New Request** button), and then click on **sslo-environment**. The list will contain both user-defined variables, and variables captured dynamically from API responses.
 
    .. image:: ./images/thunder-env.png
 
 
+.. note:: 
+   All of the API calls in the SSL Orchestrator **Collection** will minimally include a **{{CM}}** variable that contains the management IP address of the BIG-IP CM.
+
+
 About Thunder Client API Collections
 --------------------------------------------------------------------------------
 

docs/class5/module6/lab3.rst

@@ -51,6 +51,7 @@ A similar API request has already been created for you and is stored in the SSL
 
    .. image:: ./images/login-2.png
 
-   .. note::
-      The token will expire after a few minutes, so it may be necessary to regenerate this request periodically and fetch a new bearer token for subsequent API calls.
+
+   .. important::
+      The token will expire after a few minutes, so it will be necessary to resend this request periodically to fetch a new bearer token for subsequent API calls.
 

docs/class5/module6/lab4.rst

@@ -11,6 +11,18 @@ Creation of an SSL Orchestrator Inspection Service involves two steps:
 
 
 
+
+#. In the **Create SSLO Deployment** folder, click on the **Create SSLO Inspection Service - TAP** request to select it.
+
+   .. image:: ./images/api-tap-1.png
+
+#. Click on the **Send** button to submit the request to the BIG-IP CM API. 
+
+
+
+
+
+
 #. To create a TAP Inspection Service, send the following API call to BIG-IP CM (remember your **Authorization: Bearer** token):
 
    .. code-block:: text
@@ -36,7 +48,7 @@ Creation of an SSL Orchestrator Inspection Service involves two steps:
 
 
 
-#. Once defined in BIG-IP CM, the Inspection Service must then be deployed to a BIG-IP Next instance. The above API call will return a JSON payload containing the **id** value of the new TAP Inspection Service object. Copy this value because you it will be needed in the instance deploy API call, as well as the service chain creation API call. 
+#. Once defined in BIG-IP CM, the Inspection Service must then be deployed to a BIG-IP Next instance. The above API call will return a JSON payload containing the **id** value of the new TAP Inspection Service object. Copy this value because it will be needed in the instance deploy API call, as well as the service chain creation API call. 
 
 
 #. The instance deployment also requires knowledge of the BIG-IP Next instance **id**. To retrive that, send the **Get BIG-IP Instances** request from the **Collection**.

docs/conf.py

@@ -171,7 +171,7 @@
 
 # General information about the project.
 project = classname
-copyright = '2019, F5 Networks, Inc.'
+copyright = '2019-2024, F5 Networks, Inc.'
 author = 'F5 Networks, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -188,7 +188,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/index.rst

@@ -8,47 +8,62 @@ visibility into the encrypted traffic on their networks. If you require
 a pre-built lab environment, please contact your F5 account team and
 they can provide access to environments on an as-needed basis.
 
-The content contained here adheres to a DevOps methodology and
-automation pipeline.  All content contained here is sourced from the
-following GitHub repository:
 
-|github_repo|
+|
 
-Bugs and Requests for enhancements are handled in two ways:
+Lab Guides
+--------------------------------------------------------------------------------
 
-- Fork the Github Repo, fix or enhance as required, and submit a Pull Request
+The following labs are available:
 
-  - https://help.github.com/articles/creating-a-pull-request-from-a-fork/
+- SSLO 101: Essential SSL Visibility with SSL Orchestrator
+- SSLO 102: Diving into SSL Orchestrator for BIG-IP Next
+- SSLO 201: Advanced Use Cases with SSL Orchestrator
+- SSLO 301: Automating SSL Orchestrator Deployments in Public Cloud
+- SSL Orchestrator with Secure Web Gateway (SWG) as a Service
+- SSL Orchestrator Lab Guide Archive
 
-- Open an :issues:`Issue <>` within the repository.
+Refer to the left-side navigation panel for **links** to the individual lab guides.
 
-|
 
-**Latest**
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
+   :hidden:
    :glob:
 
    class1/class*
    class5/class*
    class2/class*
    class3/class*
    class4/class*
+   archived
+
 
 |
 
-**Archived**
+Documentation Repository
+--------------------------------------------------------------------------------
 
-.. toctree::
-   :maxdepth: 1
-   :glob:
+The content contained here adheres to a DevOps methodology and
+automation pipeline.  All content contained here is sourced from the
+following GitHub repository:
+
+|github_repo|
 
-   archive*/archive*
+Bugs and Requests for enhancements are handled in two ways:
+
+- Fork the Github Repo, fix or enhance as required, and submit a Pull Request
 
+  - https://help.github.com/articles/creating-a-pull-request-from-a-fork/
+
+- Open an :issues:`Issue <>` within the repository.
+
+
+|
 |
 
-(c) 2016-2022 F5, Inc. All rights reserved. F5, F5 Networks, and the F5
+(c) 2016-2024 F5, Inc. All rights reserved. F5, F5 Networks, and the F5
 logo are trademarks of F5, Inc. in the U.S. and in certain
 other countries. Other F5 trademarks are identified at f5.com.