Skip to content

Update Azure doc wrt ODM 9.5 #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 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": "2025-03-14T10:15:47Z",
"generated_at": "2025-04-29T14:01:45Z",
"plugins_used": [
{
"name": "AWSKeyDetector"
Expand Down Expand Up @@ -1116,31 +1116,31 @@
"hashed_secret": "07596f183f5e91b1778d5e47b2752b8d42aa763d",
"is_secret": false,
"is_verified": false,
"line_number": 174,
"line_number": 181,
"type": "Secret Keyword",
"verified_result": null
},
{
"hashed_secret": "3ea3f9802accf8817bacd6f3df46a73b93ccddec",
"is_secret": false,
"is_verified": false,
"line_number": 175,
"line_number": 182,
"type": "Secret Keyword",
"verified_result": null
},
{
"hashed_secret": "12d57965bd88277e9e9d69dc2b36aae2c0b7e316",
"is_secret": false,
"is_verified": false,
"line_number": 274,
"line_number": 281,
"type": "Secret Keyword",
"verified_result": null
},
{
"hashed_secret": "41b864c967d31ed0bf10562e22faa36324405048",
"is_secret": false,
"is_verified": false,
"line_number": 292,
"line_number": 299,
"type": "Secret Keyword",
"verified_result": null
}
Expand Down
28 changes: 16 additions & 12 deletions platform/azure/README-Azure-SQL-MI.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,44 @@

This page provides instructions on setting up IBM® Operational Decision Manager (ODM) with Azure SQL Managed Instance (MI).

Search for 'Azure SQL' among the available services and create a SQL Managed Instance or a Single instance:
Search for 'Azure SQL' among the available services and create a **SQL Managed Instance** with Resource type: `Single instance`:

![Single instance](images/sqlmi-select_offer.png)

Choose the desired Resource Group for deploying the SQL Managed Instance and specify the Managed Instance name:

![Basics configuration](images/sqlmi-basics.png)

Click the link 'Configure Managed Instance' and reduce the number of CPUs allocated to the instance:
Click the link `Configure Managed Instance` that is next to the *Compute + storage* parameter under **Managed Instance details** section.

Reduce the number of CPUs allocated for the instance to 4 vCores and apply the changes:

![Resources configuration](images/sqlmi-resources.png)

Back to basics, select `Use SQL authentication` as Authentication method and then fill in admin login and password values:
Back to **Basics** tab, select the option `Use SQL authentication` as **Authentication method** and then fill in admin login and password values:

![Authentication](images/sqlmi-authentication.png)

In the Networking tab, enable `Public endpoint` and allow access from `Azure services`:
In the **Networking** tab, enable `Public endpoint` and allow access from `Azure services`:
> NOTE: It is not recommended to use a public IP. In a production environment, you should use a private IP.

![Network access](images/sqlmi-network.png)

You can now review your configuration and proceed to create the Managed Instance. While it can take up to six hours, in most cases, it is created in approximately one hour:
Click the **Review + create** button to review your configuration and proceed to create the Managed Instance. While it can take up to six hours, in most cases, it is created in approximately one hour:

![Review](images/sqlmi-review.png)

Once the SQL Managed Instance is operational, you have the ability to establish a database within it:
Once the SQL Managed Instance is operational, you have the ability to establish a database within it.

Click **+ New database** to create one with `odmdb` as *Database name*:

![New database](images/sqlmi-newdb.png)

Later you'll need the FQDN for your SQL MI; it can be found as `Host` in the instance Overview:

![SQL MI Overview](images/sqlmi-overview.png)

The port to use should always be 3342 but you can verify it in the public JDBC connection string from your SQL Managed Instance:
The port to use should always be 3342. You can verify it in the public *JDBC* connection string of your SQL Managed Instance (under **Setting** section):

![JDBC string](images/sqlmi-jdbcstring.png)

Expand All @@ -49,20 +53,20 @@ kubectl create secret generic <odmdbsecret> --from-literal=db-user=<sqlmiadmin>
> [!WARNING]
> db-user must not contain the `@<managedinstancename>` part!

Then you can deploy ODM with:

You can now install the product.
- Get the [aks-sqlmi-values.yaml](./aks-sqlmi-values.yaml) file and replace the following keys:
- `<registrysecret>` is your registry secret name
- `<postgresqlserver>` is your flexible postgres server name
- `<odmdbsecret>` is the database credentials secret name
- `<mynicecompanytlssecret>` is the container certificate
- `<password>` is the password to login with the basic registry users like `odmAmin`
- `<password>` is the password to login with the basic registry users like `odmAdmin`
- `<sqlminame>` is the name of the SQL managed instance
- `<identifier>` is the identifier of the dnsZone of the SQL managed instance

> [!NOTE]
> Make sure that you have created the registry secret and also the container certificate secret as explained in [Prepare your environment for the ODM installation](README.md#prepare-your-environment-for-the-odm-installation).

```shell
helm install <release> ibmcharts/ibm-odm-prod --version 24.1.0 -f aks-sqlmi-values.yaml
helm install <release> ibm-helm/ibm-odm-prod --version 25.0.0 -f aks-sqlmi-values.yaml
```

Other deployment options (especially using NGINX) and IBM License Service usage are explained in the [NGINX README](README-NGINX.md).
Expand Down
12 changes: 6 additions & 6 deletions platform/azure/README-NGINX.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Installing an NGINX Ingress controller allows you to access ODM components throu
1. Use the official YAML manifest:

```shell
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.12.0-beta.0/deploy/static/provider/cloud/deploy.yaml
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.12.1/deploy/static/provider/cloud/deploy.yaml
```

> [!NOTE]
Expand Down Expand Up @@ -51,14 +51,14 @@ You can now install the product.
- `<postgresqlserver>` is your flexible postgres server name
- `<odmdbsecret>` is the database credentials secret name
- `<mynicecompanytlssecret>` is the container certificate
- `<password>` is the password to login with the basic registry users like `odmAmin`
- `<password>` is the password to login with the basic registry users like `odmAdmin`

```shell
helm install <release> ibmcharts/ibm-odm-prod --version 24.1.0 -f aks-nginx-values.yaml
helm install <release> ibm-helm/ibm-odm-prod --version 25.0.0 -f aks-nginx-values.yaml
```

> [!NOTE]
> By default, the NGINX Ingress controller does not enable sticky session. If you want to use sticky session to connect to DC, refer to [Using sticky session for Decision Center connection](../../contrib/sticky-session/README.md)
> By default, the NGINX Ingress controller does not enable sticky session. If you want to use sticky session to connect to DC, refer to [Using sticky session for Decision Center connection](../../contrib/sticky-session/README.md#configuring-ingress-to-use-sticky-sessions)


### Edit the file /etc/hosts on your host
Expand Down Expand Up @@ -101,7 +101,7 @@ Where:

This section explains how to track ODM usage with the IBM License Service.

Follow the **Installation** section of the [Manual installation without the Operator Lifecycle Manager (OLM)](https://www.ibm.com/docs/en/cloud-paks/foundational-services/4.9?topic=ils-installing-license-service-without-operator-lifecycle-manager-olm) documentation.
Follow the **Installation** section of the [Manual installation without the Operator Lifecycle Manager (OLM)](https://www.ibm.com/docs/en/cloud-paks/foundational-services/4.12.0?topic=ilsfpcr-installing-license-service-without-operator-lifecycle-manager-olm) documentation.

### Patch the IBM Licensing instance with Nginx configuration

Expand Down Expand Up @@ -140,7 +140,7 @@ Otherwise, you can also retrieve the licensing report .zip file by running:
curl "http://${LICENSING_URL}/snapshot?token=${TOKEN}" --output report.zip
```

If your IBM License Service instance is not running properly, refer to this [troubleshooting page](https://www.ibm.com/docs/en/cloud-paks/foundational-services/4.9?topic=service-troubleshooting-license).
If your IBM License Service instance is not running properly, refer to this [troubleshooting page](https://www.ibm.com/docs/en/cloud-paks/foundational-services/4.12.0?topic=service-troubleshooting-license).

## Troubleshooting

Expand Down
Loading