Upgrading Voice Gateway from Version 4.7.x to Version 5.0
An instance administrator can upgrade Voice Gateway from Cloud Pak for Data Version 4.7 to Version 5.0.
- Who needs to complete this task?
-
Instance administrator To upgrade Voice Gateway, you must be an instance administrator. An instance administrator has permission to manage software in the following projects:
- The operators project for the instance
-
The operators for this instance of Voice Gateway are installed in the operators project. In the upgrade commands, the
${PROJECT_CPD_INST_OPERATORS}environment variable refers to the operators project. - The operands project for the instance
-
The custom resources for the control plane and Voice Gateway are installed in the operands project. In the upgrade commands, the
${PROJECT_CPD_INST_OPERANDS}environment variable refers to the operands project.
- When do you need to complete this task?
-
Review the following options to determine whether you need to complete this task:
- If you want to upgrade the control plane and one or more services at the same time, follow the process in Upgrading an instance of Cloud Pak for Data instead.
- If you didn't upgrade Voice
Gateway when you upgraded the control plane, complete this task to upgrade Voice
Gateway.
Repeat as needed If you are responsible for multiple instances of Cloud Pak for Data, you can repeat this task to upgrade more instances of Voice Gateway on the cluster.
Information you need to complete this task
Review the following information before you upgrade Voice Gateway:
- Version requirements
-
All the components that are associated with an instance of Cloud Pak for Data must be installed at the same release. For example, if the Cloud Pak for Data control plane is at Version 5.0.3, you must upgrade Voice Gateway to Version 5.0.3.
- Environment variables
- The commands in this task use environment variables so that you can run the commands exactly as
written.
- If you don't 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
- Storage requirements
- You don't need to specify storage when you upgrade Voice Gateway.
Before you begin
This task assumes that the following prerequisites are met:
| Prerequisite | Where to find more information |
|---|---|
| The cluster meets the minimum requirements for Voice Gateway. | If this task is not complete, see System requirements. |
The workstation from which you will run the upgrade is set up as a client workstation and
has the following command-line interfaces:
|
If this task is not complete, see Updating client workstations. |
| The Cloud Pak for Data control plane is upgraded. | If this task is not complete, see Upgrading an instance of Cloud Pak for Data. |
| For environments that use a private container registry, such as air-gapped environments, the Voice Gateway software images are mirrored to the private container registry. | If this task is not complete, see Mirroring images to a private container registry. |
For environments that use a private container registry, such as air-gapped environments,
the cpd-cli is configured to pull the olm-utils-v3 image from the private container registry. |
If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry. |
Procedure
Complete the following tasks to upgrade Voice Gateway:
Upgrading the service
cpd-cli
manage
apply-olm updates all of the OLM objects in the operators
project at the same time.To upgrade Voice Gateway:
The Voice Gateway custom resource does not include a version entry, so the Voice Gateway service is automatically upgraded when you install a newer version of the Voice Gateway operator on the cluster.
Validating the upgrade
To validate the Voice Gateway installation, enter the following command:
cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=voice_gateway