Merge pull request #198 from DecisionsDev/eks-review

DBACLD-155796 - Review Eks topics

Author: siasin

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-10-11T08:53:41Z",
+  "generated_at": "2024-11-08T08:23:37Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -1296,15 +1296,15 @@
         "hashed_secret": "8b712744eee080d5fe6048e4f589235d00435559",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 132,
+        "line_number": 133,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "b11974a9da0d56698df935ab86e19b127804d6d4",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 156,
+        "line_number": 157,
         "type": "Secret Keyword",
         "verified_result": null
       }

CONTRIBUTING.md

@@ -248,4 +248,4 @@ request.
 [Fork a Repo]: https://help.github.com/articles/fork-a-repo
 [coding guidelines]: https://github.com/ibm-js/sdk/blob/master/GUIDELINES.md
 [interactive rebase]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
-[rebasing]: http://git-scm.com/book/en/Git-Branching-Rebasing
+[rebasing]: https://git-scm.com/book/en/v2/Git-Branching-Rebasing

contrib/monitor/opentelemetry/README.md

@@ -20,7 +20,7 @@ For installations on other platforms, refer to the [Jaeger documentation](https:
 
 ## Deploy the OpenTelemetry Collector
 
-We used the following [descriptor](https://github.com/open-telemetry/opentelemetry-go/blob/main/example/otel-collector/otel-collector.yaml) as the basis for the OTEL Collector deployment.
+We used the following [descriptor](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/examples/otel-collector/otel-collector.yaml) as the basis for the OTEL Collector deployment.
 However, it's likely that you will encounter an error similar to:
 
  ```console

contrib/sticky-session/ingress-dc.yaml

@@ -6,11 +6,11 @@ metadata:
     app: ibm-odm-prod
     ingressroutes: ${RELEASE_NAME}
   annotations:
-    kubernetes.io/ingress.class: nginx
     nginx.ingress.kubernetes.io/backend-protocol: https
     nginx.ingress.kubernetes.io/affinity: cookie
 
 spec:
+  ingressClassName: nginx
   rules:
   - http:
       paths:

contrib/sticky-session/ingress-ds.yaml

@@ -6,10 +6,10 @@ metadata:
     app: ibm-odm-prod
     ingressroutes: ${RELEASE_NAME}
   annotations:
-    kubernetes.io/ingress.class: nginx
     nginx.ingress.kubernetes.io/backend-protocol: https
 
 spec:
+  ingressClassName: nginx
   rules:
   - http:
       paths:

platform/eks/README-NGINX.md

@@ -6,14 +6,18 @@ The aim of this complementary documentation is to explain how to replace the **A
 
 You must have created an EKS cluster and set up your environment by following step 1 of [Deploying IBM Operational Decision Manager on Amazon EKS](README.md#1-prepare-your-environment-20-min).
 
+> **Note**:
+> Make sure that AWS Load Balancer Controller is not provisioned in this cluster.
+
+
 ## Provision an NGINX Ingress Controller
 
 You can replace the [Provision an AWS Load Balancer Controller](README.md#d-provision-an-aws-load-balancer-controller) step by provisioning an NGINX Ingress Controller with the following commands.
 
 ```bash
 helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
 helm repo update
-helm install my-odm-nginx ingress-nginx/ingress-nginx
+helm install my-odm-nginx ingress-nginx/ingress-nginx --set controller.service.annotations."service\.beta\.kubernetes\.io/aws-load-balancer-type"=nlb
 ```
 
 For more information, refer to the [ingress-nginx readme](https://github.com/kubernetes/ingress-nginx/tree/main/charts/ingress-nginx#install-chart).
@@ -24,11 +28,11 @@ The `my-odm-nginx` service should have an available `External-IP` when you run t
 kubectl get service my-odm-nginx-ingress-nginx-controller
 ```
 
-You can then go back to the [main documentation](README.md#2-create-an-rds-database-10-min).
+You can then go back to the main documentation to continue [Step 2: Create an RDS database](README.md#2-create-an-rds-database-10-min) and [Step 3: Prepare your environment for the ODM installation](README.md#3-prepare-your-environment-for-the-odm-installation-5-min).
 
 ## Install an ODM release with NGINX Ingress Controller
 
-During the helm install, you just have to replace  [eks-values.yaml](./eks-values.yaml) with [eks-nginx-values.yaml](./eks-nginx-values.yaml) that contains the relevant Ingress class: `nginx` and annotation: `nginx.ingress.kubernetes.io/backend-protocol: https`
+In this tutorial, you will use [eks-nginx-values.yaml](./eks-nginx-values.yaml) or [eks-rds-nginx-values.yaml](./eks-rds-nginx-values.yaml) file that contains the relevant Ingress class: `nginx` and annotation: `nginx.ingress.kubernetes.io/backend-protocol: https` for the installation.
 
 To install ODM with the AWS RDS PostgreSQL database created in [step 2](README.md#2-create-an-rds-database-10-min):
 
@@ -37,7 +41,7 @@ To install ODM with the AWS RDS PostgreSQL database created in [step 2](README.m
   - `<RDS_DATABASE_NAME>`: the initial database name defined when creating the RDS database
 
 ```bash
-helm install mycompany ibm-helm/ibm-odm-prod --version 23.2.0 -f eks-rds-nginx-values.yaml
+helm install mycompany ibm-helm/ibm-odm-prod --version 24.1.0 -f eks-rds-nginx-values.yaml
 ```
 
 > **Note**
@@ -49,12 +53,13 @@ helm install mycompany ibm-helm/ibm-odm-prod --version 23.2.0 -f eks-rds-nginx-v
 > - Get the [eks-nginx-values.yaml](./eks-nginx-values.yaml) file:
 >
 > ```bash
-> helm install mycompany ibm-helm/ibm-odm-prod --version 23.2.0 -f eks-nginx-values.yaml
+> helm install mycompany ibm-helm/ibm-odm-prod --version 24.1.0 -f eks-nginx-values.yaml
 > ```
 
+
 ## Track ODM usage with the IBM License Service with NGINX Ingress Controller
 
-Install the IBM License Service following a. section of [Track ODM usage with the IBM License Service](README.md#7-track-odm-usage-with-the-ibm-license-service) step of the documentation.
+Install the IBM License Service following 7a. section of [Track ODM usage with the IBM License Service](README.md#7-track-odm-usage-with-the-ibm-license-service) step of the documentation.
 
 To create the IBM Licensing instance using NGINX, get the [licensing-instance-nginx.yaml](./licensing-instance-nginx.yaml) file and run the command:
 
@@ -69,7 +74,9 @@ export LICENSING_URL=$(kubectl get ingress ibm-licensing-service-instance -n ibm
 export TOKEN=$(kubectl get secret ibm-licensing-token -n ibm-common-services -o jsonpath='{.data.token}' |base64 -d)
 ```
 
-You can access the `http://${LICENSING_URL}/status?token=${TOKEN}` URL to view the licensing usage or retrieve the licensing report .zip file by running:
+You can access the `http://${LICENSING_URL}/status?token=${TOKEN}` URL to view the licensing usage. 
+
+Otherwise, you can also retrieve the licensing report .zip file by running:
 
 ```bash
 curl "http://${LICENSING_URL}/snapshot?token=${TOKEN}" --output report.zip

platform/eks/README.md

@@ -4,6 +4,7 @@ This project demonstrates how to deploy an IBM® Operational Decision Manager (O
 
 <img src="./images/eks-schema.jpg" alt="Flow" width="2050" height="600" />
 
+
 The ODM on Kubernetes Docker images are available in the [IBM Cloud Container Registry](https://www.ibm.com/cloud/container-registry). The ODM Helm chart is available in the [IBM Helm charts repository](https://github.com/IBM/charts).
 
 ## Included components
@@ -49,16 +50,16 @@ Set up your environment by [configuring the AWS CLI](https://docs.aws.amazon.com
 ```bash
 aws configure 
 ```
+Where you provide your `AWS Access Key ID`, `AWS Secret Access Key` and the `Default region name`.
 
 #### b. Create an EKS cluster (20 min)
 
 ```bash
-eksctl create cluster <CLUSTER_NAME> --version 1.28 --alb-ingress-access
-
+eksctl create cluster <CLUSTER_NAME> --version 1.30 --alb-ingress-access
 ```
 
 > **Note**
-> The tutorial has been tested with the Kubernetes version 1.28. Check the supported kubernetes version in the [system requirement](https://www.ibm.com/support/pages/ibm-operational-decision-manager-detailed-system-requirements) page.
+> The tutorial has been tested with the Kubernetes version 1.30. Check the supported kubernetes version in the [system requirement](https://www.ibm.com/support/pages/ibm-operational-decision-manager-detailed-system-requirements) page.
 
 > **Warning**
 > If you prefer to use the NGINX Ingress Controller instead of the ALB Load Balancer to expose ODM services, don't use the --alb-ingress-access option during the creation of the cluster !
@@ -177,7 +178,7 @@ helm repo update
 ```bash
 $ helm search repo ibm-odm-prod
 NAME                             	CHART VERSION	APP VERSION	DESCRIPTION
-ibm-helm/ibm-odm-prod           	24.0.0       	9.0.0.0   	IBM Operational Decision Manager
+ibm-helm/ibm-odm-prod           	24.1.0       	9.0.0.1   	IBM Operational Decision Manager
 ```
 
 ### 4. Manage a  digital certificate (10 min)
@@ -229,7 +230,7 @@ To install ODM with the AWS RDS PostgreSQL database created in [step 2](#2-creat
   - `<RDS_DATABASE_NAME>` is the initial database name defined when creating the RDS database
 
 ```bash
-helm install mycompany ibm-helm/ibm-odm-prod --version 23.2.0 -f eks-rds-values.yaml
+helm install mycompany ibm-helm/ibm-odm-prod --version 24.1.0 -f eks-rds-values.yaml
 ```
 
 > **Note**
@@ -239,7 +240,7 @@ helm install mycompany ibm-helm/ibm-odm-prod --version 23.2.0 -f eks-rds-values.
 >   - `<AWS-AccountId>` is your AWS Account Id
 >
 >```bash
->helm install mycompany ibm-helm/ibm-odm-prod --version 23.2.0 -f eks-values.yaml
+>helm install mycompany ibm-helm/ibm-odm-prod --version 24.1.0 -f eks-values.yaml
 >```
 
 > **Note**
@@ -267,6 +268,7 @@ After a couple of minutes, the ALB reflects the Ingress configuration. You can
 
 ```bash
 export ROOTURL=$(kubectl get ingress mycompany-odm-ingress --no-headers |awk '{print $4}')
+echo $ROOTURL
 ```
 
 > **Note**