The Decision Intelligence Client Managed Software installation
script installs the Decision Intelligence Client Managed Software operator and
its dependencies, specifically, IBM Usage Metering Service (UMS). UMS is used to collect usage
metrics from Decision Intelligence Client Managed Software, and send them to
IBM Software Central to create compliance evidence for the auditing purposes and visualizing metric
usage in reporting tools.
Before you begin
Use a bastion server as your host. You must run the script from a bastion server in a session
where you are connected to the targeted cluster.
- Bastion host
-
A bastion host is a server that is provisioned with a public IP address that is accessible
through remote access Secure Shell (SSH). When configured, the bastion server acts as an
intermediate server that allows a secure connection to the instances made available without a public
IP address.
About this task
The installation script (di-install.sh) is available in the following GitHub
repository: https://github.com/icp4a/automation-decision-services-kubernetes
. Go
to the branch that matches the product version 26.0.0.
This script installs the Decision Intelligence Client Managed Software
operator (named ibm-ads-operator in the cluster) and its dependencies in a targeted
namespace.
Procedure
- Create the secret requirement for the UMS exporter to Software Central. For the
installation in an air-gapped environment, you can skip this step because UMS cannot connect to
Software Central to push data.
export ENTITLEMENT_KEY=<your_ibm_entitlement_key>
kubectl create namespace <di_namespace>
kubectl create secret generic software-central-key \
--from-literal=token=${ENTITLEMENT_KEY} \
-n <di_namespace>
<di_namespace> is the
namespace where
Decision Intelligence Client Managed Software is installed in
the next step.
For more information about the entitlement key, see Getting an IBM entitlement API key.
-
Run the
di-install.sh script:
./scripts/di-install.sh [-h] [-a] -n <di_namespace> [-d <domain_name>] [-x]
Description of the options:
Table 1. Options
| Option |
Description |
Purpose |
-a |
Accept license.
|
|
-n <di_namespace> |
Namespace where Decision Intelligence Client Managed Software is
installed.
|
The -n switch is to set the namespace where you are aiming to install Decision Intelligence Client Managed Software.
|
-d <domain_name> |
Domain name where the Decision Intelligence Client Managed Software URL is
available.
This option is mandatory unless you are using Red Hat®
OpenShift® where it is ignored.
|
The -d switch is to pass the domain name.
It is used by the foundational services to derive the Platform UI (Zen) console URL and the Cloud
Pak console URL where your Decision Intelligence Client Managed Software
instance is reachable from a user browser.
These URLs are also declared internally in authentication mechanism, and must be recognized
before the installation.
On Red Hat
OpenShift, the same domain name as the one that is used
in the Red Hat
OpenShift admin console URL is used by default.
Therefore, you do not need to provide one.
|
-x |
Do not configure the created UMS instance to push usage metrics to Software Central. |
- If you are using Decision Intelligence Client Managed Software through the
IBM Cloud Pak® for
Business Automation entitlements, you can use this
option because the UMS reporting to Software Central is optional. Without the IBM Cloud Pak for
Business Automation entitlements, you cannot use this
option.
- If you are installing in an air-gapped environment, you must use this option to disable the UMS
exporter to Software Central.
|
Results
When the script finishes running, you have everything that you need in your cluster to
instantiate Decision Intelligence Client Managed Software custom resources (CR)
into the target namespace.The AutomationDecisionService name is used in the
kind for Kubernetes.