service-instance upgrade

Upgrade Cloud Pak for Data service instances.

Important: Do not use this command unless you are explicitly instructed to do so as part of your service instance upgrade instructions.

To perform a service instance upgrade, you must be the service instance owner or have Admin privileges to the service instance.

Syntax

cpd-cli service-instance upgrade <cpd-service-instance-name> \
[--all] \
[--cpdconfig=<cpd-configuration-location>] \
[--helm-force-upgrade] \
[--helm-no-hooks] \
[--instance-name=<cpd-service-instance-name>] \
[--override=<override-file-path.yaml>] \
--profile=<cpd-configuration-profile-name> \
[--service-type=<cpd-service-name>] \
[--verbose] \
[--version=<cpd-service-upgrade-version>] \
[--watch]

Arguments

Table 1: Command arguments
Argument Description
<cpd-service-instance-name> The Cloud Pak for Data service instance name to upgrade.

Options

Option Description

--all

-a

 Retrieve all Cloud Pak for Data service instances and save to the specified --output-dir location (when an --output-dir location is specified).
Status
Optional.
Syntax
--all
Default value
No default.
Valid values
Not applicable.
--cpdconfig The Cloud Pak for Data configuration location.
Status
Optional.
Syntax
--cpdconfig=<cpd-configuration-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.
--helm-force-upgrade Make a helm run upgrade with the --force option. The upgrade deletes all old objects and recreates new objects. This option should be used with caution.
Status
Optional.
Syntax
--helm-force-upgrade
Default value
Not applicable.
Valid values
Not applicable.
--helm-no-hooks Make a helm run upgrade without using any hooks from chart files.
Status
Optional.
Syntax
--helm-no-hooks
Default value
Not applicable.
Valid values
Not applicable.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--instance-name Specify the Cloud Pak for Data service instance name.
Status
Optional.
Syntax
--instance-name=<cpd-service-instance-name>
Default value
No default.
Valid values
A Cloud Pak for Data service instance name.
--override The override file path and file name (*.yaml) for the upgrade.
Status
Optional.
Syntax
--override=<override-file-path.yaml>
Default value
No default.
Valid values
Any valid path and override *.yaml file name.
--profile The profile-name from the Cloud Pak for Data configuration.
Status
Required.
Syntax
--profile=<cpd-configuration-profile-name>
Default value
default
Valid values
Any valid profile name from the Cloud Pak for Data configuration.

--service-type

-t

 The Cloud Pak for Data service type to upgrade.
Status
Optional.
Syntax
--service-type=<cpd-service-name>
Default value
No default.
Valid values
Any valid OpenShift® Container Platform service type.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.
--version The version number to which the Cloud Pak for Data service will be upgraded (for example 2.0.0.0).
Status
Optional.
Syntax
--version=<cpd-service-upgrade-version>
Default value
No default.
Valid values
A valid OpenShift Container Platform service version number.
--watch Wait for the service instance upgrade to complete.
Status
Optional.
Syntax
--watch
Default value
Not applicable.
Valid values
Not applicable.

Examples

Note: The following examples use the recommended installation environment variables.

Use a script to create environment variables with the correct values for your environment. For more information, see Best practice: Setting up install variables.

Upgrade a specific service instance in a Cloud Pak for Data instance.
cpd-cli service-instance upgrade --instance-name <cpd-instance-name> \
--service-type=<cpd-service-name> \
--profile=<cpd-configuration-profile-name>
Upgrade all service instances of the same service type.
cpd-cli service-instance upgrade \
--all \
--service-type=<cpd-service-name> \
--profile=<cpd-configuration-profile-name>