Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
siasin committed Nov 4, 2024
1 parent 48b11f7 commit 3908353
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 35 deletions.
6 changes: 3 additions & 3 deletions .secrets.baseline
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"files": "^.secrets.baseline$",
"lines": null
},
"generated_at": "2024-10-11T08:53:41Z",
"generated_at": "2024-11-04T17:05:05Z",
"plugins_used": [
{
"name": "AWSKeyDetector"
Expand Down Expand Up @@ -1296,15 +1296,15 @@
"hashed_secret": "8b712744eee080d5fe6048e4f589235d00435559",
"is_secret": false,
"is_verified": false,
"line_number": 132,
"line_number": 115,
"type": "Secret Keyword",
"verified_result": null
},
{
"hashed_secret": "b11974a9da0d56698df935ab86e19b127804d6d4",
"is_secret": false,
"is_verified": false,
"line_number": 156,
"line_number": 139,
"type": "Secret Keyword",
"verified_result": null
}
Expand Down
48 changes: 16 additions & 32 deletions platform/eks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,17 @@ 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
The project uses the following components:
- [IBM Operational Decision Manager](https://www.ibm.com/docs/en/odm/9.0.0?topic=operational-decision-manager-certified-kubernetes-900)
- [Amazon Elastic Kubernetes Service (Amazon EKS)](https://aws.amazon.com/eks/)
- [Amazon Relational Database Service (Amazon RDS)](https://aws.amazon.com/rds/)
- [AWS Application Load Balancer (ALB)](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html)

## Tested environment
The commands and tools have been tested on Linux and macOS.

## Prerequisites
First, install the following software on your machine:
* [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)
* [eksctl](https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html)
* [Helm v3](https://helm.sh/docs/intro/install/)
* [kubectl](https://kubernetes.io/docs/tasks/tools/)

Then, create an [AWS Account](https://aws.amazon.com/getting-started/).

## Steps to deploy ODM on Kubernetes from Amazon EKS
<!-- TOC depthFrom:3 depthTo:3 withLinks:1 updateOnSave:1 orderedList:0 -->

- [1. Prepare your environment (20 min)](#1-prepare-your-environment-20-min)
- [2. Create an RDS database (10 min)](#2-create-an-rds-database-10-min)
- [3. Prepare your environment for the ODM installation (5 min)](#3-prepare-your-environment-for-the-odm-installation-5-min)
- [4. Manage a  digital certificate (10 min)](#4-manage-a-digital-certificate-10-min)
<!-- TOC depthfrom:3 depthto:3 withlinks:false updateonsave:false orderedlist:false -->

- Prepare your environment (20 min)
- Create an RDS database (10 min)
- Prepare your environment for the ODM installation (5 min)
- Manage a  digital certificate (10 min)
- Install an IBM Operational Decision Manager release (10 min)
- Access the ODM services
- Track ODM usage with the IBM License Service

<!-- /TOC -->a  digital certificate (10 min)](#4-manage-a-digital-certificate-10-min)
- [5. Install an IBM Operational Decision Manager release (10 min)](#5-install-an-ibm-operational-decision-manager-release-10-min)
- [6. Access the ODM services](#6-access-the-odm-services)
- [7. Track ODM usage with the IBM License Service](#7-track-odm-usage-with-the-ibm-license-service)
Expand All @@ -49,16 +32,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 !
Expand Down Expand Up @@ -177,7 +160,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)
Expand Down Expand Up @@ -267,6 +250,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**
Expand Down

0 comments on commit 3908353

Please sign in to comment.