Upgrading watsonx Assistant from Version 4.8 to Version 5.1

Information you need to complete this task

Review the following information before you upgrade watsonx Assistant:

Version requirements

All the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is at Version 5.1.3, you must upgrade watsonx Assistant to Version 5.1.3.

Environment variables

The commands in this task use environment variables so that you can run the commands exactly as written.

• If you do not have the script that defines the environment variables, see Setting up installation environment variables.
• To use the environment variables from the script, you must source the environment variables before you run the commands in this task. For example, run:

  source ./cpd_vars.sh

Common core services

watsonx Assistant requires the IBM Software Hub common core services.

If the common core services are not at the correct version in the operands project for the instance, the common core services are automatically upgraded when you upgrade watsonx Assistant. The common core services upgrade increases the amount of time the upgrade takes to complete.

Before you begin

This task assumes that the following prerequisites are met:

Procedure

Complete the following tasks to upgrade watsonx Assistant:

1. Back up your data.

   For more information, see Backing up your data in IBM Software Hub in the watsonx Assistant product documentation.

2. Backing up and retaining temporary patches
3. Specifying additional installation options
4. Upgrading the service
5. Validating the upgrade
6. Validating the EDB Postgres upgrade
7. Cleaning up resources
8. Upgrading existing service instances
9. What to do next

Specifying installation options

When you upgrade watsonx Assistant, specify the following option in the install-options.yml file in the work directory.

################################################################################
# watsonx Assistant parameters
################################################################################
#watson_assistant_size: Production
#watson_assistant_bigpv: false
#watson_assistant_analytics_enabled: true
#watson_assistant_watsonx_ai_type: embedded
#watson_assistant_syom_models: []
#watson_assistant_ootb_models: []

Backing up and retaining temporary patches

Upgrading watsonx Assistant removes all pre-existing temporary patches that do not have the label 'type=critical-configuration'. If you need to retain some temporary patches, you can preserve them before upgrading by labeling them as critical. For example, you might have a custom configuration that is specific to your environment and was not included in the new release.

To back up and label the patches that need to be retained, follow these steps:

1. Run the following command to list all temporary patches for your instances. Save the list to the file patches_list.txt.

   oc get temporarypatch -n ${PROJECT_CPD_INST_OPERANDS}   >patches_list.txt
   

2. Save the YAML file for your existing temporary patches by running the following command:

   oc get temporarypatch -o yaml > old_patch_backups.yaml
   

3. Get the list of the temporary patches from your deployment to determine which patches you want to preserve.

   oc get temporarypatch -n ${PROJECT_CPD_INST_OPERANDS}
   

4. Apply or remove the "type": "critical-configuration" label as appropriate:
   • For all patches that you want to retain, use the following command:

     oc label temporarypatch <patch_name> type=critical-configuration
     

     For example:

     oc label temporarypatch wa-store-assistant-limits type=critical-configuration

   • For the patches that you want to remove, use the following command:

     oc label temporarypatch <patch_name> type-
     

     For example:

     oc label temporarypatch wa-store-assistant-limits type-
     

5. Run the following commands to verify that the temporary patches you want to preserve have the label type=critical-configuration:

   oc get temporarypatch -n ${PROJECT_CPD_INST_OPERANDS} -l type=critical-configuration

   oc get temporarypatch -n ${PROJECT_CPD_INST_OPERANDS} --show-labels

Upgrading the service

To upgrade watsonx Assistant:

1. Log the cpd-cli in to the Red Hat OpenShift Container Platform cluster:

   ${CPDM_OC_LOGIN}

   Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
2. Update the custom resource for watsonx Assistant.

   cpd-cli manage apply-cr \
   --components=watson_assistant \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --param-file=/tmp/work/install-options.yml \
   --license_acceptance=true \
   --upgrade=true

Validating the upgrade

[SUCCESS]... The apply-cr command ran successfully

If you want to confirm that the custom resource status is Completed, you can run the cpd-cli manage get-cr-status command:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=watson_assistant

Validating the EDB Postgres upgrade

When do you need to complete this task?

Complete this task after you successfully upgraded watsonx Assistant to Version 5.1.

Cleaning up resources

Who needs to complete this task?

You must be an administrator of the project where watsonx Assistant is installed.

When do you need to complete this task?

Complete this task to clean up resources after you upgrade watsonx Assistant to Version 5.1.

To delete the store-cronjob:

1. Use the following command to delete the store-cronjob:

   oc delete cronjob ${INSTANCE}-store-cronjob

2. Verify that the job is deleted successfully:

   oc get cronjob -n ${PROJECT_CPD_INST_OPERANDS}

   After a few minutes, a new job with the same name must reappear.

Upgrading existing service instances

The service instances are automatically upgraded when you upgrade watsonx Assistant.

What to do next

watsonx Assistant is ready to use. To get started with watsonx Assistant, see Administering watsonx Assistant.