DBACLD-43365 - Google cloud documentation review (#119)

* Reorganize

* Fix links

* Review doc and remove unnecessary files

* Review

* Fix links and typo

* Review Nginx doc

* Add file for nginx

* Review

* Fix gcp account creation link

* Remove values-nginx.yaml file

Author: julie-garrone

platform/gcloud/README.md

@@ -3,87 +3,34 @@
 This section explains how to expose the ODM services to Internet connectivity with Ingress.
 For reference, see the Google Cloud documentation https://cloud.google.com/community/tutorials/nginx-ingress-gke
 
-<!-- TOC titleSize:2 tabSpaces:2 depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 skip:0 title:1 charForUnorderedList:* -->
 ## Table of Contents
-- [Install an ODM Helm release and expose it with a NGINX Ingress controller (15 min)](#install-an-odm-helm-release-and-expose-it-with-a-nginx-ingress-controller-15-min)
-  - [Table of Contents](#table-of-contents)
-  - [Create a Kubernetes secret for the TLS certificate](#create-a-kubernetes-secret-for-the-tls-certificate)
-  - [Install the ODM release](#install-the-odm-release)
-  - [Edit your /etc/hosts](#edit-your-etchosts)
-  - [Access the ODM services](#access-the-odm-services)
-  - [Troubleshooting](#troubleshooting)
-- [License](#license)
-<!-- /TOC -->
 
-NGINX has been installed while deploying IBM License Manager, see [README.md](README.md#create-a-nginx-ingress-controller).
+1. [Create a NGINX Ingress controller](#1-create-a-nginx-ingress-controller)
+2. [Install the ODM release](#2-install-the-odm-release)
+3. [Check the deployment and access ODM services](#3-check-the-deployment-and-access-odm-services)
 
-## Create a Kubernetes secret for the TLS certificate
+### 1. Create a NGINX Ingress controller
 
-1. (Optional) Generate a self-signed certificate
+Refer to the [Create a NGINX Ingress controller](README.md#a-create-a-nginx-ingress-controller) section if you have not created it already.
 
-If you do not have a trusted certificate, you can use OpenSSL and other cryptography and certificate management libraries to generate a certificate file and a private key, to define the domain name, and to set the expiration date. The following command creates a self-signed certificate (.crt file) and a private key (.key file) that accept the domain name *mycompany.com*. The expiration is set to 1000 days:
+### 2. Install the ODM release
 
-```
-openssl req -x509 -nodes -days 1000 -newkey rsa:2048 -keyout mycompany.key \
-        -out mycompany.crt -subj "/CN=mycompany.com/OU=it/O=mycompany/L=Paris/C=FR" \
-        -addext "subjectAltName=DNS:mycompany.com"
-```
-
->By default on mac osx, the default Openssl (LibreSSL version) does not have the -addtext option. You need to install the "Official" OpenSSL implementation.  
-
-2. Create the according Kubernetes secret that contains the certificate
-
-```
-kubectl create secret tls <mycompanytlssecret> --key mycompany.key --cert mycompany.crt
-```
-
-## Install the ODM release
-
-You can now install the product:
+You can install the product using the dedicated Ingress annotation `kubernetes.io/ingress.class: nginx`.
 
-The ODM instance is using the externalCustomDatabase parameters to import the PostgreSQL datasource and driver. The ODM services will be exposed through NGINX thanks to the dedicated Ingress annotation (kubernetes.io/ingress.class: nginx).
-The secured HTTPS communication is managed by the NGINX ingress controller. So, we disable TLS at container level
+The ODM services will be exposed through NGINX.
+The secured HTTPS communication is managed by the NGINX ingress controller. So, we disable TLS at container level.
 
-```
-helm install <release> ibmcharts/ibm-odm-prod \
-        --set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=<registrysecret> \
-        --set externalCustomDatabase.datasourceRef=<customdatasourcesecret> --set externalCustomDatabase.driverPvc=customdatasource-pvc \
-        --set service.enableTLS=false --set service.ingress.tlsSecretRef=<mycompanytlssecret> \
-        --set service.ingress.enabled=true --set service.ingress.host=mycompany.com --set service.ingress.tlsHosts={"mycompany.com"} \
-        --set service.ingress.annotations={"kubernetes.io/ingress.class: nginx"}
-```
-
-## Edit your /etc/hosts
+Replace the placeholders in the [gcp-values.yaml](./gcp-values.yaml) file and install the chart:
 
 ```
-# vi /etc/hosts
-<externalip> mycompany.com
+helm install mycompany ibmcharts/ibm-odm-prod --version 22.1.0 \
+             -f gcp-values-nginx.yaml \
+             --set service.ingress.annotations={"kubernetes.io/ingress.class: nginx"}
 ```
 
-## Access the ODM services
+### 3. Check the deployment and access ODM services
 
-Check that ODM services are in NodePort type:
-
-```
-kubectl get services
-NAME                                               TYPE           CLUSTER-IP     EXTERNAL-IP    PORT(S)                      AGE
-mycompany-odm-decisioncenter                       NodePort       10.0.178.43    <none>         9453:32720/TCP               16m
-mycompany-odm-decisionrunner                       NodePort       10.0.171.46    <none>         9443:30223/TCP               16m
-mycompany-odm-decisionserverconsole                NodePort       10.0.106.222   <none>         9443:30280/TCP               16m
-mycompany-odm-decisionserverconsole-notif          ClusterIP      10.0.115.118   <none>         1883/TCP                     16m
-mycompany-odm-decisionserverruntime                NodePort       10.0.232.212   <none>         9443:30082/TCP               16m
-nginx-ingress-ingress-nginx-controller             LoadBalancer   10.0.191.246   51.103.3.254   80:30222/TCP,443:31103/TCP   3d
-nginx-ingress-ingress-nginx-controller-admission   ClusterIP      10.0.214.250   <none>         443/TCP                      3d
-```
-
-ODM services are available through the following URLs:
-
-| SERVICE NAME | URL | USERNAME/PASSWORD
-| --- | --- | ---
-| Decision Server Console | https://mycompany.com/res | odmAdmin/odmAdmin
-| Decision Center | https://mycompany.com/decisioncenter | odmAdmin/odmAdmin
-| Decision Server Runtime | https://mycompany.com/DecisionService | odmAdmin/odmAdmin
-| Decision Runner | https://mycompany.com/DecisionRunner | odmAdmin/odmAdmin
+Refer to the [the main README](README.md#b-check-the-topology) to check the deployment and access the ODM services.
 
 ## Troubleshooting
 
@@ -92,4 +39,3 @@ If your ODM instances are not running properly, please refer to [our dedicated t
 # License
 
 [Apache 2.0](../LICENSE)
-

platform/gcloud/README_NGINX.md

@@ -0,0 +1,27 @@
+license: true
+usersPassword: "odmAdmin"
+
+image:
+  repository: cp.icr.io/cp/cp4a/odm
+  pullSecrets:
+  - <REGISTRY_SECRET>
+
+service:
+  enableTLS: false
+  ingress:
+    enabled: true
+    tlsSecretRef: mycompany-crt-secret
+    host: mycompany.com
+    tlsHosts:
+    - mycompany.com
+
+externalDatabase:
+  type: postgres
+  secretCredentials: <odm-db-secret>
+  port: 5432
+  serverName: <DB_ENDPOINT>
+  databaseName: <DATABASE_NAME>
+  # You can get the last Google Cloud SQL PostgreSQL driver version 
+  # at https://github.com/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory/releases
+  driversUrl:
+  - https://storage.googleapis.com/cloud-sql-java-connector/v1.6.0/postgres-socket-factory-1.6.0-jar-with-driver-and-dependencies.jar