Updated README

Red-Hat-EMEA-SSA-AppDev-Team · Nov 20, 2023 · 7d46d2f · 7d46d2f
1 parent d8ef10d
commit 7d46d2f
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -46,7 +46,25 @@ Red Hat Service Interconnect can be leveraged in order to easily secure multiple
     oc apply -f ./ThreescaleAPIProducts/library-books-api/openshift_manifests/rhsi-hackfest-apibackend_namespace.yaml
     ```
 
-2. Deploy the _Library Books API_ service to be secured by 3scale:
+2. Edit the _Library Books API_ services configMaps in the [`./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v1.yaml`](./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v1.yaml) and [`./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v2.yaml`](./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v2.yaml) manifests to replace the OpenShift domain placeholder with that of your cluster:
+
+    > NOTE: This sets the URL to the Jaeger server collector for distributed tracing.
+    
+    ```script shell
+    sed 's/apps.*com/<Replace with your OpenShift cluster application domain URI>/g' ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v1.yaml > temp.yml && mv temp.yml ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v1.yaml
+    
+    sed 's/apps.*com/<Replace with your OpenShift cluster application domain URI>/g' ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v2.yaml > temp.yml && mv temp.yml ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v2.yaml
+    ```
+
+    Example:
+
+    ```script shell
+    sed 's/apps.*com/apps.cluster-8bcs7.8bcs7.sandbox2056.opentlc.com/g' ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v1.yaml > temp.yaml && mv temp.yaml ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v1.yaml
+    
+    sed 's/apps.*com/apps.cluster-8bcs7.8bcs7.sandbox2056.opentlc.com/g' ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v2.yaml > temp.yaml && mv temp.yaml ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v2.yaml
+    ```
+
+3. Deploy the _Library Books API_ service to be secured by 3scale:
     ```
     oc -n rhsi-hackfest-apibackend apply -f ./ThreescaleAPIProducts/library-books-api/openshift_manifests/books-api-v1.yaml
     oc set env deploy/books-api-v1 DEPLOYMENT_LOCATION="OpenShift on AWS Cloud"
@@ -197,7 +215,7 @@ Red Hat Service Interconnect can be leveraged in order to easily secure multiple
 
     ![](./images/rhsi-books-api-v2_localfavoured-1.png)
 
-    - All authorized HTTP requests are handled by the `aws-ocp` (local) server site
+    - All authorized HTTP requests are handled by the `aws-ocp` (local) server site.
 
     ![](./images/rhsi-books-api-v2_localfavoured-2.png)
 
@@ -233,6 +251,6 @@ Red Hat Service Interconnect can be leveraged in order to easily secure multiple
 
     ![](./images/rhsi-books-api-v2_resilience_remoteaccess-1.png)
         
-    - All authorized HTTP requests are handled by the `aws-azure` (remote) server site
+    - All authorized HTTP requests are handled by the `aws-azure` (remote) server site.
 
     ![](./images/rhsi-books-api-v2_resilience_remoteaccess-2.png)
diff --git a/ThreescaleAPIProducts/README.md b/ThreescaleAPIProducts/README.md
@@ -30,7 +30,7 @@ This repository contains instructions used to secure the _Library Books API_ wit
     1. Edit the 3scale Tenant CR ([`./threescale-tenant/tenant-rhsi-hackfest.yaml`](./threescale-tenant/tenant-rhsi-hackfest.yaml)) to replace the OpenShift domain placeholder with that of your cluster:
     
         ```script shell
-        sed 's/apps.*com/<Replace with your cluster domain URl>/g' ./threescale-tenant/tenant-rhsi-hackfest.yaml > temp.yml && mv temp.yml ./threescale-tenant/tenant-rhsi-hackfest.yaml
+        sed 's/apps.*com/<Replace with your OpenShift cluster application domain URI>/g' ./threescale-tenant/tenant-rhsi-hackfest.yaml > temp.yml && mv temp.yml ./threescale-tenant/tenant-rhsi-hackfest.yaml
         ```
 
         Example:
@@ -45,10 +45,15 @@ This repository contains instructions used to secure the _Library Books API_ wit
         ```
 
 The 3scale `rhsi-hackfest` Admin Portal is then available at `https://rhsi-hackfest-admin.apps.${OCP_DOMAIN}` where:
-    - `${OCP_DOMAIN}`: the application domain of your Red Hat OpenShift cluster.
+- `${OCP_DOMAIN}`: the application domain of your Red Hat OpenShift cluster.
+- Login credentials:
+    - login: `admin`
+    - password: `openshift`
 
 ![](./images/threescale-admin-portal.png)
 
+- Use login/password: admin/openshift
+
 ### II. Setup the 3scale-toolbox CLI
 
 #### Prerequisites

diff --git a/install/3scale-amp/README.md b/install/3scale-amp/README.md
@@ -5,7 +5,7 @@
     1. Edit the 3scale APIManager CR ([`./2.13_manifests/rhsi-hackfest-apimanager_cr.yaml`](./2.13_manifests/rhsi-hackfest-apimanager_cr.yaml)) to replace the OpenShift domain placeholder with that of your cluster:
 
         ```script shell
-        sed 's/apps.*com/<Replace with your cluster domain URl>/g' ./2.13_manifests/rhsi-hackfest-apimanager_cr.yaml > temp.yml && mv temp.yml ./2.13_manifests/rhsi-hackfest-apimanager_cr.yaml
+        sed 's/apps.*com/<Replace with your OpenShift cluster application domain URI>/g' ./2.13_manifests/rhsi-hackfest-apimanager_cr.yaml > temp.yml && mv temp.yml ./2.13_manifests/rhsi-hackfest-apimanager_cr.yaml
         ```
 
         Example: