Updating your Business Automation Insights deployment

 For 19.0.2  You can update your IBM Business Automation Insights system by passing new configuration property values on the Helm command line.

 For 19.0.2 Updating a 19.0.2 deployment

About this task

For a full list of the configuration parameters, see the reference tables in Business Automation Insights parameters.
Important: Some parameter values cannot be changed after initial installation and configuration.

Procedure

  1. Retrieve Business Automation Insights Helm chart.
    docker run -v "$(pwd)":/mnt mycluster.icp:8500/<bai-namespace>/bai-ibacc-job:<bai-version-number> cp ../../product-helm-charts/bai.tar.gz /mnt
    Replace <bai-namespace> with the expected namespace and <bai-version-number> with the appropriate version number, such as 19.0.2.
    Attention: Do not change the /mnt directory, otherwise the copy operation fails.
  2. If necessary, delete the job submitter jobs.

    If you are planning to update parameters that affect the execution of processing jobs, delete the job submitter jobs: Apache Flink settings (including RocksDB settings), Kafka configuration options, Elasticsearch general settings, or Kerberos authentication settings. These properties start with flink.*, bpmn.*, ingestion.*, icm.*, odm.*, content.*, bawadv., kafka.*, settings.*, kerberos.*, or elasticsearch.*.

    1. To retrieve the job names, run the get command as follows.
      kubectl get jobs --selector=release=<bai-release> --namespace <bai-namespace> | grep -v setup
    2. Run the delete command on each job in the list as follows.
      kubectl delete job <JOB> --namespace <bai-namespace>
  3. If necessary, delete the bai-setup job by running the delete job command.
    You need to delete the bai-setup job if you update any property that relates to the Elasticsearch instance used by your Business Automation Insights system.
    kubectl delete job <bai-release>-bai-setup --namespace <bai-namespace>
  4. Run the Helm upgrade command with the new property values.
    The following example increases the number of parallel instances for the processing of BPMN events from 1 to 2.
    helm upgrade <bai-release> ibm-business-automation-insights-<CHARTS_VERSION>-charts.tgz --reuse-values --set $PARAMS --namespace <NAMESPACE>
    Note:

    (For 19.0.2) Helm command lines are provided for the OpenShift platform. If you are working from IBM Cloud Private, write the same command lines as for OpenShift but append the --tls option.

    Tip:
    • For a preview before you effectively upgrade or roll back, you can append the --dry-run option to the upgrade or rollback command line.
    • Increasing the parallelism of a job also increases Business Automation Insights memory and CPU usage. For more information, see Scaling an IBM Business Automation Insights system.

 New in 19.0.3 Updating a 19.0.3 deployment

About this task

For a full list of the configuration parameters, see the reference tables in Business Automation Insights parameters.
Important: Some parameter values cannot be changed after initial installation and configuration.

Updates to the custom resources (CR) overwrite the deployed resources during the operator control loop (observe, analyze, act), which occurs as a result of constantly watching the state of the Kubernetes resources. If you choose to modify the installed software, use the same CR YAML file that you deployed with the operator to make the updates (for example, my_icp4a_cr.yaml). To apply the updated custom resources, edit your YAML file, if applicable delete jobs, and run the oc apply command.

Procedure

  1. Edit your CR YAML file to include all your intended modifications.
  2. If necessary, delete the job submitter jobs.

    If you are planning to update parameters that affect the execution of processing jobs, delete the job submitter jobs: Apache Flink settings (including RocksDB settings), Kafka configuration options, Elasticsearch general settings, or Kerberos authentication settings. These properties start with flink.*, bpmn.*, ingestion.*, icm.*, odm.*, content.*, bawadv.*, kafka.*, settings.*, kerberos.*, or elasticsearch.*.

    1. To retrieve the job names, run the get command as follows.
      oc get jobs --selector=release=<bai-cr-name> --namespace <bai-namespace> | grep -v setup
    2. Run the delete command on each job in the list as follows.
      oc delete job <JOB> --namespace <bai-namespace>
  3. If necessary, delete the bai-setup job by running the delete job command.
    You need to delete the bai-setup job if you update any property that relates to the Elasticsearch instance used by your Business Automation Insights system.
    oc delete job <bai-cr-name>-bai-setup --namespace <bai-namespace>
  4. Apply the updates to the operator.
    oc apply -f descriptors/my_icp4a_cr.yaml --overwrite=true
    Note: You can also edit YAML files by using the default UNIX visual editor (vi).
    oc edit ICP4ACluster <MY-INSTANCE>
  5. Verify the updated automation containers.

    The operator reconciliation loop might take several minutes.

    1. Monitor the status of your pods.
      oc get pods -w
    2. When all of the pods are in Running state, access the status of your services.
      oc status