Merge branch 'rhds' into 6.8

Author: alexgroom

documentation/antora.yml

@@ -1,6 +1,6 @@
 name: inner-loop
-title: OpenShift Inner Loop Workshop
-version: "6.8"
+title: OpenShift Inner Loop Workshop for Developer Sandbox
+version: "rhds"
 nav:
   - modules/ROOT/nav.adoc
 

documentation/modules/ROOT/assets/images/enter-devfile.png

@@ -1,5 +1,5 @@
 * xref:introduction.adoc[1. Introduction]
-* xref:developer-workspace.adoc[2. Get your Developer Workspace]
+* xref:developer-workspace.adoc[2. Get your Developer Sandbox and Workspace]
 * xref:inventory-quarkus.adoc[3. Create Inventory Service with Quarkus]
 * xref:catalog-spring-boot.adoc[4. Create Catalog Service with Spring Boot]
 * xref:gateway-dotnet.adoc[5. Create Gateway Service with .NET]

documentation/modules/ROOT/assets/images/launch-crw.png

@@ -1,7 +1,5 @@
 :markup-in-source: verbatim,attributes,quotes
-:CHE_URL: http://devspaces.%APPS_HOSTNAME_SUFFIX%
-:USER_ID: %USER_ID%
-:OPENSHIFT_CONSOLE_URL: https://console-openshift-console.%APPS_HOSTNAME_SUFFIX%/topology/ns/my-project{USER_ID}
+:PROJECT: %PROJECT%
 
 = Externalize Application Configuration
 :navtitle: Externalize Application Configuration
@@ -64,7 +62,7 @@ making it simple to re-create complex deployments by just deploying a single tem
 be parameterized to get input for fields like service names and generate values for fields like passwords.
 ====
 
-In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], `*click on the 'Home' menu, and choose 'Software Catalog'*` 
+In the OpenShift Web Console `*click on the 'Home' menu, and choose 'Software Catalog'*` 
 and then select `*Databases*` within the catalog.
 
 image::openshift-add-database.png[OpenShift - Add database, 800]
@@ -80,7 +78,7 @@ Then, enter the following information:
 |Value
 
 |Namespace*
-|my-project{USER_ID}
+|_user_-dev
 
 |Memory Limit*
 |512Mi
@@ -124,7 +122,7 @@ Then, enter the following information:
 |Value
 
 |Namespace*
-|my-project{USER_ID}
+|_user_-dev
 
 |Memory Limit*
 |512Mi
@@ -159,11 +157,11 @@ Now you can move on to configure the Inventory and Catalog service to use these
 
 By default, due to security reasons, **containers are not allowed to snoop around OpenShift clusters and discover objects**. Security comes first and discovery is a privilege that needs to be granted to containers in each project. 
 
-Since you do want our applications to discover the config maps inside the **my-project{USER_ID}** project, you need `*to grant permission to the Service Account to access the OpenShift REST API*` and find the config maps. 
+Since you do want our applications to discover the config maps inside the your project, you need `*to grant permission to the Service Account to access the OpenShift REST API*` and find the config maps. 
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-oc policy add-role-to-user view -n my-project{USER_ID} -z default
+oc policy add-role-to-user view -z default
 ----
 
 [#externalize_quarkus_configuration]
@@ -178,7 +176,7 @@ In Quarkus, Driver is a build time property and cannot be overridden. So as you
 technology, you need to change the 'quarkus.datasource.driver' parameter 
 in **/projects/workshop/labs/inventory-quarkus/src/main/resources/application.properties** and rebuild the application.
 
-In your {CHE_URL}[Workspace^, role='params-link'], `*edit the '/projects/workshop/labs/inventory-quarkus/pom.xml' file and add the
+In your Workspace, `*edit the '/projects/workshop/labs/inventory-quarkus/pom.xml' file and add the
 'JDBC Driver - MariaDB' dependency*`
 
 [source,xml,subs="{markup-in-source}",role=copypaste]
@@ -218,7 +216,7 @@ parameters unchanged. They will be overridden later.
 
 Now, let's create the Quarkus configuration content using the database credentials.
 
-In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], from the `*Workloads*` menu
+In the OpenShift Web Console from the `*Workloads*` menu
 `*click on 'Config Maps' then click on the 'Create Config Map' button*`.
 
 image::openshift-create-configmap.png[Che - OpenShift Create Config Map, 900]
@@ -231,13 +229,12 @@ apiVersion: v1
 kind: ConfigMap
 metadata:
   name: inventory
-  namespace: my-project{USER_ID}
   labels:
     app: coolstore
     app.kubernetes.io/instance: inventory
 data:
   application.properties: |-
-    quarkus.datasource.jdbc.url=jdbc:mariadb://inventory-mariadb.my-project{USER_ID}.svc:3306/inventorydb
+    quarkus.datasource.jdbc.url=jdbc:mariadb://inventory-mariadb.svc:3306/inventorydb
     quarkus.datasource.username=inventory
     quarkus.datasource.password=inventory
 ----
@@ -250,7 +247,7 @@ Wait till the build is complete then, `*Delete the Inventory Pod*` to make it st
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-oc delete pod -l component=inventory -n my-project{USER_ID}
+oc delete pod -l component=inventory
 ----
 
 Now **verify that the config map is in fact injected into the container by checking if the seed data is 
@@ -260,7 +257,7 @@ loaded into the database**.
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-oc rsh -n my-project{USER_ID} dc/inventory-mariadb
+oc rsh dc/inventory-mariadb
 ----
 
 Once connected to the MariaDB container, `*run the following*`:
@@ -321,7 +318,7 @@ configuration using an alternative **application.properties** backed by a config
 
 Let's create the Spring Boot configuration content using the database credentials and create the Config Map.
 
-In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], from the `*Workloads*` menu,
+In the OpenShift Web Console, from the `*Workloads*` menu,
 `*click on 'Config Maps' then click on the 'Create Config Map' button*`.
 
 image::openshift-create-configmap.png[Che - OpenShift Create Config Map, 900]
@@ -334,13 +331,12 @@ apiVersion: v1
 kind: ConfigMap
 metadata:
   name: catalog
-  namespace: my-project{USER_ID}
   labels:
     app: coolstore
     app.kubernetes.io/instance: catalog
 data:
   application.properties: |-
-    spring.datasource.url=jdbc:postgresql://catalog-postgresql.my-project%USER_ID%.svc:5432/catalogdb
+    spring.datasource.url=jdbc:postgresql://catalog-postgresql:5432/catalogdb
     spring.datasource.username=catalog
     spring.datasource.password=catalog
     spring.datasource.driver-class-name=org.postgresql.Driver
@@ -358,15 +354,15 @@ if enabled, triggers hot reloading of beans or Spring context when changes are d
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-oc delete pod -l component=catalog -n my-project{USER_ID}
+oc delete pod -l component=catalog 
 ----
 
 When the Catalog container is *ready* (wait at least 30 seconds), verify that the PostgreSQL database is being 
 used. Check the Catalog pod logs repeatedly:
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-oc logs deployment/catalog-coolstore -n my-project{USER_ID} | grep hibernate.dialect
+oc logs deployment/catalog-coolstore | grep hibernate.dialect
 ----
 
 You should have the following output:
@@ -380,7 +376,7 @@ You can also connect to the Catalog PostgreSQL database and verify that the seed
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-oc rsh -n my-project{USER_ID} dc/catalog-postgresql
+oc rsh dc/catalog-postgresql
 ----
 
 Once connected to the PostgreSQL container, run the following:

documentation/modules/ROOT/assets/images/sandbox-login.png

@@ -1,8 +1,5 @@
 :markup-in-source: verbatim,attributes,quotes
-:APPS_HOSTNAME_SUFFIX: %APPS_HOSTNAME_SUFFIX%
-:CHE_URL: http://devspaces.%APPS_HOSTNAME_SUFFIX%
-:USER_ID: %USER_ID%
-:OPENSHIFT_CONSOLE_URL: https://console-openshift-console.%APPS_HOSTNAME_SUFFIX%/topology/ns/my-project{USER_ID}
+:PROJECT: %PROJECT%
 
 = Monitor Application Health
 :navtitle: Monitor Application Health
@@ -63,16 +60,16 @@ start listening until initialization is complete.
 By default Pods are designed to be resilient, if a pod dies it will get restarted. Let's see
 this happening.
 
-In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], under the Workloads menu
+In the OpenShift Web Console under the Workloads menu
 `*click on 'Topology' -> '(D) inventory-coolstore' -> 'Resources' -> 'P inventory-coolstore-x-xxxxx'*`
 
 image::openshift-inventory-pod.png[OpenShift Inventory Pod, 700]
 
-In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], `*click on 'Actions' -> 'Delete Pod' -> 'Delete'*`
+In the OpenShift Web Console, `*click on 'Actions' -> 'Delete Pod' -> 'Delete'*`
 
 image::openshift-inventory-delete-pod.png[OpenShift Inventory Delete Pod, 700]
 
-A new instance (pod) will be redeployed very quickly. Once deleted `*try to access your http://inventory-coolstore-my-project{USER_ID}.{APPS_HOSTNAME_SUFFIX}[Inventory Service^, role='params-link']*`.
+A new instance (pod) will be redeployed very quickly. Once deleted `*try to access your Inventory application test page*`.
 
 However, imagine the _Inventory Service_ is stuck in a state (Stopped listening, Deadlock, etc)
 where it cannot perform as it should. In this case, the pod will not immediately die, it will be in a zombie state.
@@ -88,7 +85,7 @@ the container could automatically restart (based on its restart policy).
 
 Let's imagine you have traffic coming into the _Inventory Service_. We can do that with simple script.
 
-In your {CHE_URL}[Workspace^, role='params-link'],
+In your Workspace,
 
 [tabs, subs="attributes+,+macros"]
 ====
@@ -110,7 +107,7 @@ CLI::
 ----
 for i in {1..60}
 do 
-    if [ $(curl -s -w "%{http_code}" -o /dev/null http://inventory-coolstore.my-project{USER_ID}.svc:8080/api/inventory/329299) == "200" ]
+    if [ $(curl -s -w "%{http_code}" -o /dev/null http://inventory-coolstore.${DEVWORKSPACE_NAMESPACE}.svc:8080/api/inventory/329299) == "200" ]
     then 
         MSG="\033[0;32mThe request to Inventory Service has succeeded\033[0m"
     else 
@@ -132,14 +129,14 @@ image::che-inventory-traffic.png[Che - Catalog Traffic OK, 500]
 
 Now let's scale out your _Inventory Service_ to 2 instances. 
 
-In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], under the Workloads menu,
+In the OpenShift Web Console under the Workloads menu,
 `*click on 'Topology' -> '(D) inventory-coolstore' -> 'Details' then click once on the up arrows 
 on the right side of the pod blue circle*`.
 
 image::openshift-scale-out-inventory.png[OpenShift Scale Out Catalog, 700]
 
 You should see the 2 instances (pods) running. 
-Now, `*switch back to your {CHE_URL}[Workspace^, role='params-link'] and check the output of the 'Inventory Generate Traffic' task*`.
+Now, `*switch back to your Workspace and check the output of the 'Inventory Generate Traffic' task*`.
 
 image::che-inventory-traffic-ko.png[Che - Catalog Traffic KO, 500]
 
@@ -150,7 +147,7 @@ In order to prevent this behaviour, a **Readiness check** is needed. It determin
 If the readiness probe fails, the endpoints controller ensures the container has its IP address removed from the endpoints of all services. 
 A readiness probe can be used to signal to the endpoints controller that even though a container is running, it should not receive any traffic from a proxy.
 
-First, scale down your _Inventory Service_ to 1 instance. In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], under the Workloads menu,
+First, scale down your _Inventory Service_ to 1 instance. In the OpenShift Web Console, under the Workloads menu,
 `*click on 'Topology' -> '(D) inventory-coolstore' -> 'Details' then click once on the down arrows 
 on the right side of the pod blue circle*`.
 
@@ -164,7 +161,7 @@ It allows applications to provide information about their state to external view
 in cloud environments where automated processes must be able to determine whether the application should be discarded or restarted.
 
 Let's add the needed dependencies to **/projects/workshop/labs/inventory-quarkus/pom.xml**. 
-In your {CHE_URL}[Workspace^, role='params-link'], `*edit the '/projects/workshop/labs/inventory-quarkus/pom.xml' file*`:
+In your Workspace, `*edit the '/projects/workshop/labs/inventory-quarkus/pom.xml' file*`:
 
 [source,xml,subs="{markup-in-source}",role=copypaste]
 ----
@@ -206,20 +203,20 @@ Wait till the build is complete then use the Dev Spaces terminal window to `*Del
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-oc delete pod -l component=inventory -n my-project{USER_ID}
+oc delete pod -l component=inventory
 ----
 
 NOTE: In Dev Spaces, to open a terminal window, `*click on 'Terminal' -> 'New Terminal'*`
 
 
 It will take a few seconds to restart, then verify that the health endpoint works for the **Inventory Service** using `*curl*`
 
-In your {CHE_URL}[Workspace^, role='params-link'], 
+In your Workspace, 
 `*execute the following commands in the terminal window*` - it may take a few attempts while the pod restarts.
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-curl -w "\n" http://inventory-coolstore.my-project{USER_ID}.svc:8080/q/health
+curl -w "\n" http://inventory-coolstore.${DEVWORKSPACE_NAMESPACE}.svc:8080/q/health
 ----
 
 NOTE: To open a terminal window, `*click on 'Terminal' -> 'New Terminal'*`
@@ -239,7 +236,7 @@ You should have the following output:
 }
 ----
 
-In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], under the Workloads menu,
+In the In the OpenShift Web Console under the Workloads menu,
 `*click on 'Topology' -> '(D) inventory-coolstore' -> 'Add Health Checks'*`.
 
 image::openshift-inventory-add-health-check.png[Che - Inventory Add Health Check, 700]
@@ -342,10 +339,10 @@ Therefore, as soon as you define the probe, OpenShift automatically redeploys th
 == Testing Inventory Readiness Probes
 
 Now let's test it as you did previously.
-`*Generate traffic to Inventory Service*` and then, in the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], 
+`*Generate traffic to Inventory Service*` and then, in the OpenShift Web Console, 
 `*scale out the Inventory Service to 2 instances (pods)*`
 
-In your {CHE_URL}[Workspace^, role='params-link'], `*check the output of the 'Inventory Generate Traffic' task*`.
+In your Workspace, `*check the output of the 'Inventory Generate Traffic' task*`.
 
 You should not see any errors, this means that you can now **scale out your _Inventory Service_ with no downtime.**
 
@@ -362,12 +359,12 @@ dependencies which is already done for the **Catalog Service**.
 
 Verify that the health endpoint works for the **Catalog Service** using `*curl*`.
 
-In your {CHE_URL}[Workspace^, role='params-link'], in the *terminal* window, 
+In your Workspace, in the *terminal* window, 
 `*execute the following commands*`:
 
 [source,shell,subs="{markup-in-source}",role=copypaste]
 ----
-curl -w "\n" http://catalog-coolstore.my-project{USER_ID}.svc:8080/actuator/health
+curl -w "\n" http://catalog-coolstore.${DEVWORKSPACE_NAMESPACE}.svc:8080/actuator/health
 ----
 
 You should have the following output:
@@ -380,7 +377,7 @@ You should have the following output:
 Liveness and Readiness health checks values have already been set for this service as part of the build and deploying 
 using Eclipse JKube in combination with the Spring Boot actuator. 
 
-You can check this in the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'], under the Workloads menu,
+You can check this in the OpenShift Web Console, under the Workloads menu,
 `*click on 'Topology' -> '(D) catalog-coolstore' -> 'Actions' -> 'Edit Health Checks'*`.
 
 image::openshift-catalog-edit-health.png[Che - Catalog Add Health Check, 700]
@@ -480,7 +477,7 @@ Now you understand and know how to configure Readiness, Liveness and Startup pro
 |===
 
 Finally, let's configure probes for Gateway and Web Service.
-In your {CHE_URL}[Workspace^, role='params-link'], `*click on 'Terminal' -> 'Run Task...' ->  'devfile: Probes - Configure Gateway & Web'*`
+In your Workspace, `*click on 'Terminal' -> 'Run Task...' ->  'devfile: Probes - Configure Gateway & Web'*`
 
 image::che-runtask.png[Che - RunTask, 600]
 
@@ -493,7 +490,7 @@ gain visibility into how the application behaves and particularly in identifying
 OpenShift provides container metrics out-of-the-box and displays how much memory, cpu and network 
 each container has been consuming over time. 
 //
-//In the {OPENSHIFT_CONSOLE_URL}[OpenShift Web Console^, role='params-link'],
+//In the OpenShift Web Console
 //`*click on 'Observe' then select your 'my-project{USER_ID}' project*`.
 //
 //In the project overview, you can see the different **Resource Usage** sections. 
@@ -504,6 +501,7 @@ each container has been consuming over time.
 From the Workloads menu, `*click on 'Topology' -> any Deployment (D) and click on the associated Pod (P)*`
 
 In the pod `*Metrics*` tab, you can see a more detailed view of the pod consumption.
+
 The graphs can be found under the Metrics heading, or Details in earlier versions of the OpenShift console.
 
 image::openshift-pod-details.png[OpenShift Pod Details,740]