Skip to content

Commit 66f517a

Browse files
authored
Merge pull request #210 from DecisionsDev/update-ecr
Update ECR doc and also revert back helm install with --version=24.1.0 in the README.md
2 parents 776a68c + 9eaaed5 commit 66f517a

File tree

11 files changed

+45
-58
lines changed

11 files changed

+45
-58
lines changed

.secrets.baseline

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"files": "^.secrets.baseline$",
44
"lines": null
55
},
6-
"generated_at": "2024-11-20T09:47:21Z",
6+
"generated_at": "2024-11-22T09:18:32Z",
77
"plugins_used": [
88
{
99
"name": "AWSKeyDetector"
@@ -100,23 +100,23 @@
100100
"hashed_secret": "5a2ea68e9ea943ea31948fe51388c798e13346a9",
101101
"is_secret": false,
102102
"is_verified": false,
103-
"line_number": 227,
103+
"line_number": 234,
104104
"type": "Secret Keyword",
105105
"verified_result": null
106106
},
107107
{
108108
"hashed_secret": "fa9beb99e4029ad5a6615399e7bbae21356086b3",
109109
"is_secret": false,
110110
"is_verified": false,
111-
"line_number": 488,
111+
"line_number": 495,
112112
"type": "Secret Keyword",
113113
"verified_result": null
114114
},
115115
{
116116
"hashed_secret": "076a042dcb8e3b7be55cbbe95e1f18f577ef1ba5",
117117
"is_secret": false,
118118
"is_verified": false,
119-
"line_number": 534,
119+
"line_number": 541,
120120
"type": "Secret Keyword",
121121
"verified_result": null
122122
}
@@ -134,15 +134,15 @@
134134
"hashed_secret": "5a2ea68e9ea943ea31948fe51388c798e13346a9",
135135
"is_secret": false,
136136
"is_verified": false,
137-
"line_number": 145,
137+
"line_number": 152,
138138
"type": "Secret Keyword",
139139
"verified_result": null
140140
},
141141
{
142142
"hashed_secret": "fa9beb99e4029ad5a6615399e7bbae21356086b3",
143143
"is_secret": false,
144144
"is_verified": false,
145-
"line_number": 387,
145+
"line_number": 394,
146146
"type": "Secret Keyword",
147147
"verified_result": null
148148
}
@@ -404,23 +404,23 @@
404404
"hashed_secret": "5a2ea68e9ea943ea31948fe51388c798e13346a9",
405405
"is_secret": false,
406406
"is_verified": false,
407-
"line_number": 225,
407+
"line_number": 250,
408408
"type": "Secret Keyword",
409409
"verified_result": null
410410
},
411411
{
412412
"hashed_secret": "fa9beb99e4029ad5a6615399e7bbae21356086b3",
413413
"is_secret": false,
414414
"is_verified": false,
415-
"line_number": 379,
415+
"line_number": 405,
416416
"type": "Secret Keyword",
417417
"verified_result": null
418418
},
419419
{
420420
"hashed_secret": "076a042dcb8e3b7be55cbbe95e1f18f577ef1ba5",
421421
"is_secret": false,
422422
"is_verified": false,
423-
"line_number": 425,
423+
"line_number": 451,
424424
"type": "Secret Keyword",
425425
"verified_result": null
426426
}
@@ -1348,7 +1348,7 @@
13481348
"hashed_secret": "b11974a9da0d56698df935ab86e19b127804d6d4",
13491349
"is_secret": false,
13501350
"is_verified": false,
1351-
"line_number": 71,
1351+
"line_number": 72,
13521352
"type": "Secret Keyword",
13531353
"verified_result": null
13541354
}

authentication/AzureAD/README_WITH_CLIENT_SECRET.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ You can now install the product. We will use the PostgreSQL internal database an
359359
See the [Preparing to install](https://www.ibm.com/docs/en/odm/9.0.0?topic=production-preparing-install-operational-decision-manager) documentation for additional information.
360360
361361
```shell
362-
helm install my-odm-release ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 \
362+
helm install my-odm-release ibm-helm/ibm-odm-prod --version 24.1.0 \
363363
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=icregistry-secret \
364364
--set oidc.enabled=true \
365365
--set license=true \
@@ -384,7 +384,7 @@ You can now install the product. We will use the PostgreSQL internal database an
384384
When the NGINX Ingress Controller is ready, you can install the ODM release with:
385385
386386
```
387-
helm install my-odm-release ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 \
387+
helm install my-odm-release ibm-helm/ibm-odm-prod --version 24.1.0 \
388388
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=icregistry-secret \
389389
--set oidc.enabled=true \
390390
--set license=true \

authentication/AzureAD/README_WITH_PRIVATE_KEY_JWT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ You can now install the product. We will use the PostgreSQL internal database an
254254
See the [Preparing to install](https://www.ibm.com/docs/en/odm/9.0.0?topic=production-preparing-install-operational-decision-manager) documentation for additional information.
255255
256256
```shell
257-
helm install my-odm-release ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 \
257+
helm install my-odm-release ibm-helm/ibm-odm-prod --version 24.1.0 \
258258
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=icregistry-secret \
259259
--set oidc.enabled=true \
260260
--set license=true \
@@ -275,7 +275,7 @@ You can now install the product. We will use the PostgreSQL internal database an
275275
When the NGINX Ingress Controller is ready, you can install the ODM release with:
276276
277277
```
278-
helm install my-odm-release ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 \
278+
helm install my-odm-release ibm-helm/ibm-odm-prod --version 24.1.0 \
279279
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=icregistry-secret \
280280
--set oidc.enabled=true \
281281
--set license=true \

authentication/Cognito/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ In the **Container software library** tile, verify your entitlement on the **Vie
516516
See the [Preparing to install](https://www.ibm.com/docs/en/odm/9.0.0?topic=production-preparing-install-operational-decision-manager) documentation for more information.
517517

518518
```shell
519-
helm install my-odm-release ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 \
519+
helm install my-odm-release ibm-helm/ibm-odm-prod --version 24.1.0 \
520520
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=icregistry-secret \
521521
--set oidc.enabled=true \
522522
--set license=true \
@@ -536,7 +536,7 @@ In the **Container software library** tile, verify your entitlement on the **Vie
536536
When the NGINX Ingress Controller is ready, you can install the ODM release with:
537537

538538
```
539-
helm install my-odm-release ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 \
539+
helm install my-odm-release ibm-helm/ibm-odm-prod --version 24.1.0 \
540540
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=icregistry-secret \
541541
--set oidc.enabled=true \
542542
--set license=true \

authentication/Okta/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ In this step, we augment the token with meta-information that is required by the
329329
You can now install the product. We will use the PostgreSQL internal database and disable the data persistence (`internalDatabase.persistence.enabled=false`) to avoid any platform complexity concerning persistent volume allocation.
330330
331331
```
332-
helm install my-odm-release ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 \
332+
helm install my-odm-release ibm-helm/ibm-odm-prod --version 24.1.0 \
333333
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=icregistry-secret \
334334
--set oidc.enabled=true \
335335
--set internalDatabase.persistence.enabled=false \

platform/azure/README-Azure-SQL-MI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Then you can deploy ODM with:
5454
```bash
5555
helm install <release> ibmcharts/ibm-odm-prod \
5656
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=<registrysecret> \
57-
--set image.tag=${ODM_VERSION:-9.0.0.0} --set service.type=LoadBalancer \
57+
--version 24.1.0 --set service.type=LoadBalancer \
5858
--set externalDatabase.type=sqlserver \
5959
--set externalDatabase.serverName=<sqlminame>.public.<identifier>.database.windows.net \
6060
--set externalDatabase.databaseName=odmdb \

platform/azure/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ Check that you can access the ODM charts:
269269
```shell
270270
helm search repo ibm-odm-prod
271271
NAME CHART VERSION APP VERSION DESCRIPTION
272-
ibmcharts/ibm-odm-prod 24.0.0 9.0.0.0 IBM Operational Decision Manager License By in...
272+
ibmcharts/ibm-odm-prod 24.1.0 9.0.0.1 IBM Operational Decision Manager License By in...
273273
```
274274

275275
### Manage a digital certificate (10 min)
@@ -310,7 +310,7 @@ You can now install the product:
310310
```shell
311311
helm install <release> ibmcharts/ibm-odm-prod \
312312
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=<registrysecret> \
313-
--set image.tag=${ODM_VERSION:-9.0.0.0} --set service.type=LoadBalancer \
313+
--version 24.1.0 --set service.type=LoadBalancer \
314314
--set externalDatabase.type=postgres \
315315
--set externalDatabase.serverName=<postgresqlserver>.postgres.database.azure.com \
316316
--set externalDatabase.databaseName=postgres \
@@ -398,7 +398,7 @@ You can reuse the secret with TLS certificate created [above](#manage-adigital-c
398398
```shell
399399
helm install <release> ibmcharts/ibm-odm-prod \
400400
--set image.repository=cp.icr.io/cp/cp4a/odm --set image.pullSecrets=<registrysecret> \
401-
--set image.tag=${ODM_VERSION:-9.0.0.0} \
401+
--version 24.1.0 \
402402
--set externalDatabase.type=postgres \
403403
--set externalDatabase.serverName=<postgresqlserver>.postgres.database.azure.com \
404404
--set externalDatabase.databaseName=postgres \

platform/eks/README-ECR.md

Lines changed: 21 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The related instructions in the online documentation are:
1111
## Prerequisites:
1212

1313
- Install the following tools on your bastion host (if needed, refer to [Setting up a host to mirror images to a private registry](https://www.ibm.com/docs/en/odm/9.0.0?topic=installation-setting-up-host-mirror-images-private-registry)):
14+
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)
1415
- Docker or Podman
1516
- OCP CLI (oc)
1617
- [IBM ibm-pak plugin](https://github.com/IBM/ibm-pak)
@@ -21,6 +22,12 @@ The related instructions in the online documentation are:
2122
- github.com for CASE files and tools
2223
- Amazon ECR
2324

25+
- Configure the `aws` CLI environment by running the following command:
26+
```bash
27+
aws configure 
28+
```
29+
You will be prompted to provide your AWS Access Key ID, AWS Secret Access Key and the Default region name.
30+
2431
- Export the following environment variables (replace the placeholders `<AWS-Region>`, `<AWS-AccountId>`, `<ODM-CaseVersion>` and `<amd64|ppc64le|s390x>` with actual values):
2532

2633
```bash
@@ -65,34 +72,11 @@ The related instructions in the online documentation are:
6572

6673
This command generates the files `images-mapping.txt` and `image-content-source-policy.yaml` at `~/.ibm-pak/data/mirror/${CASE_NAME}/${CASE_VERSION}`. The `~/.ibm-pak/mirror` directory is also created.
6774

68-
- For CASE versions up to 1.7.x (included), append `-<architecture>` at the end of each line in `~/.ibm-pak/data/mirror/${CASE_NAME}/${CASE_VERSION}/images-mapping.txt` (where `<architecture>` can be `amd64`, `ppc64le`, or `s390x`).
69-
70-
- either manually,
71-
- or by running the command below (on Linux only, not for MacOS):
72-
73-
```bash
74-
sed -i "s/$/-${ARCHITECTURE}/" ~/.ibm-pak/data/mirror/${CASE_NAME}/${CASE_VERSION}/images-mapping.txt
75-
```
76-
77-
Here is an example of such a file after this modification:
78-
79-
```
80-
cp.icr.io/cp/cp4a/odm/dbserver@sha256:bde14b68043370e9a4e49b1f3394978c202e0d5495e0121bd7972b37a7d99c35=194826081736.dkr.ecr.eu-west-3.amazonaws.com/cp/cp4a/odm/dbserver:9.0.0.0-amd64
81-
cp.icr.io/cp/cp4a/odm/odm-decisioncenter@sha256:869a6a47b5c49865086242e60228eaba7292b8d2e8e56ee4b67ea4fc07d591ad=194826081736.dkr.ecr.eu-west-3.amazonaws.com/cp/cp4a/odm/odm-decisioncenter9.0.0.0-amd64
82-
cp.icr.io/cp/cp4a/odm/odm-decisionrunner@sha256:70824d9aa218c0b768e42a35f6dcc5f424779d1f54540a885fc9395a7a9e07c3=194826081736.dkr.ecr.eu-west-3.amazonaws.com/cp/cp4a/odm/odm-decisionrunner:9.0.0.0-amd64
83-
cp.icr.io/cp/cp4a/odm/odm-decisionserverconsole@sha256:9a2f71ab6b62ffc2adf84d68b9d5fcee54d91ab76b62661265a6842479f4388b=194826081736.dkr.ecr.eu-west-3.amazonaws.com/cp/cp4a/odm/odm-decisionserverconsole:9.0.0.0-amd64
84-
cp.icr.io/cp/cp4a/odm/odm-decisionserverruntime@sha256:b5539e7efbe410d1a874abcd20d170dabf073d91a0ad58ae69ee03b7acea92d3=194826081736.dkr.ecr.eu-west-3.amazonaws.com/cp/cp4a/odm/odm-decisionserverruntime:9.0.0.0-amd64
85-
```
86-
87-
> WARNING:
88-
For some interim fixes, the file `images-mapping.txt` need to be modified differently. The instructions can be found in the readme page of the interim fix.
89-
90-
9175
- Store authentication credentials of the source Docker registry `cp.icr.io` and the target Amazon ECR.
9276

9377
> NOTE:
9478
You must specify the user as `cp` to log in to `cp.icr.io`. The password is your Entitlement key from the [IBM Cloud Container Registry](https://myibm.ibm.com/products-services/containerlibrary).
95-
79+
9680
- If you use Podman:
9781

9882
> Note: by default Podman reads and stores credentials in `${XDG_RUNTIME_DIR}/containers/auth.json`. Read more [here](https://docs.podman.io/en/stable/markdown/podman-login.1.html).
@@ -170,9 +154,9 @@ The related instructions in the online documentation are:
170154

171155
- Find the Helm Chart version related to your CASE version:
172156

173-
For instance, if you choose the CASE version `1.8.0`, then the Helm chart version should be `24.0.0` and you should set:
157+
For instance, if you choose the CASE version `1.9.0`, then the Helm chart version should be `24.1.0` and you should set:
174158
```bash
175-
export CHART_VERSION=24.0.0
159+
export CHART_VERSION=24.1.0
176160
```
177161

178162
You can find the Helm chart version related to a given CASE version:
@@ -181,27 +165,30 @@ The related instructions in the online documentation are:
181165

182166
- For an interim fix: click the link for your version of ODM in the page [Operational Decision Manager Interim Fixes](https://www.ibm.com/support/pages/operational-decision-manager-interim-fixes) and then check the table "Interim fix for ODM on Certified Kubernetes".
183167

184-
- Alternatively, you can also run the command `tree ~/.ibm-pak/data/cases/ibm-odm-prod/` (on the bastion host), and you can find the chart version number in the name of the file `ibm-odm-prod-<CHART_VERSION>.tgz` located in `<CASE_VERSION>/charts/` :
168+
- Alternatively, you can also run the command `tree ~/.ibm-pak/data/cases/ibm-odm-prod/` (on the bastion host), and you can find the chart version number corresponding to the file `ibm-odm-prod-<CHART_VERSION>.tgz`. Below is an example for CASE version `1.9.0` that corresponds to Helm chart version `24.1.0` :
185169

186170
```bash
187171
/home/user/.ibm-pak/data/cases/ibm-odm-prod/
188-
└── 1.8.0
172+
└── 1.9.0
189173
├── caseDependencyMapping.csv
190174
├── charts
191-
│   └── ibm-odm-prod-24.0.0.tgz
175+
│   └── ibm-odm-prod-24.1.0.tgz
192176
├── component-set-config.yaml
193-
├── ibm-odm-prod-1.8.0-airgap-metadata.yaml
194-
├── ibm-odm-prod-1.8.0-charts.csv
195-
├── ibm-odm-prod-1.8.0-images.csv
196-
├── ibm-odm-prod-1.8.0.tgz
177+
├── ibm-odm-prod-1.9.0-airgap-metadata.yaml
178+
├── ibm-odm-prod-1.9.0-charts.csv
179+
├── ibm-odm-prod-1.9.0-images.csv
180+
├── ibm-odm-prod-1.9.0.tgz
197181
└── resourceIndexes
198182
└── ibm-odm-prod-resourcesIndex.yaml
199183
```
200-
- Run the `helm install` command below:
184+
- Run the `helm install` command below to install ODM:
201185

202186
```bash
203187
helm install mycompany ibm-helm/ibm-odm-prod --version ${CHART_VERSION} \
204188
--set image.pullSecrets=ecrodm \
205189
--set image.repository=${TARGET_REGISTRY}/cp/cp4a/odm \
206190
--values eks-values.yaml
207191
```
192+
193+
> **Note:**
194+
> By using `eks-values.yaml`, ODM with a PostgreSQL internal database will be installed. It requires an ALB ingress controller and a server certificate. For more information, see [Provision an AWS Load Balancer Controller](README.md#d-provision-an-aws-load-balancer-controller) and [Manage a digital certificate](README.md#4-manage-a-digital-certificate-10-min).

platform/gcloud/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ It automatically creates an HTTPS GKE load balancer. We will disable the ODM int
247247
- Install the chart from IBM's public Helm charts repository:
248248

249249
```
250-
helm install <release> ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 -f gcp-values.yaml
250+
helm install <release> ibm-helm/ibm-odm-prod --version 24.1.0 -f gcp-values.yaml
251251
```
252252
253253
> NOTE: You might prefer to access ODM components through the NGINX Ingress controller instead of using the IP addresses. If so, please follow [these instructions](README_NGINX.md).

platform/gcloud/README_NGINX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The secured HTTPS communication is managed by the NGINX ingress controller. So,
2828
Replace the placeholders in the [gcp-values.yaml](./gcp-values.yaml) file and install the chart:
2929

3030
```
31-
helm install mycompany ibm-helm/ibm-odm-prod --set image.tag=9.0.0.0 \
31+
helm install mycompany ibm-helm/ibm-odm-prod --version 24.1.0 \
3232
-f gcp-values.yaml \
3333
--set service.ingress.annotations={"kubernetes.io/ingress.class: nginx"}
3434
```

0 commit comments

Comments
 (0)