upgrade-cluster¶
- subtitle
Upgrades the OS or data platform on a datahub cluster.
- version
0.9.121
Description¶
Upgrades the OS or data platform on a datahub cluster. You have the option to either specify one of ‘imageId’, ‘runtime’ or ‘lockComponents’ or both ‘imageId’ and ‘lockComponents’ or none of the parameters.
Synopsis¶
upgrade-cluster
--cluster-name <value>
[--image-id <value>]
[--runtime <value>]
[--lock-components | --no-lock-components]
[--dry-run | --no-dry-run]
[--show-available-images | --no-show-available-images]
[--show-latest-available-image-per-runtime | --no-show-latest-available-image-per-runtime]
[--rolling-upgrade-enabled | --no-rolling-upgrade-enabled]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--cluster-name
(string)
The name or CRN of the datahub.
--image-id
(string)
The id of an image to upgrade to.
--runtime
(string)
The runtime version to upgrade to.
--lock-components
| --no-lock-components
(boolean)
Perform an os upgrade only.
--dry-run
| --no-dry-run
(boolean)
Checks the eligibility of an image to upgrade but do not perform the upgrade.
--show-available-images
| --no-show-available-images
(boolean)
Returns the list of images that are eligible for the upgrade.
--show-latest-available-image-per-runtime
| --no-show-latest-available-image-per-runtime
(boolean)
Returns the latest image that is eligible for the upgrade for each runtime version with at least one available upgrade candidate.
--rolling-upgrade-enabled
| --no-rolling-upgrade-enabled
(boolean)
Enables the ability to perform rolling runtime upgrade.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
--generate-cli-skeleton
(boolean)
Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for
--cli-input-json
.
Output¶
current -> (object)
Basic information about an image.
imageName -> (string)
The name of the image.
imageId -> (string)
The id of the image.
imageCatalogName -> (string)
Name of the image catalog, the image is from.
created -> (integer)
Image creation timestamp.
componentVersions -> (object)
Versions of the image components.
cm -> (string)
Version of CM.
cdp -> (string)
CDP version.
os -> (string)
OS name.
osPatchLevel -> (string)
OS patch level.
upgradeCandidates -> (array)
List of images and components to upgrade to.
item -> (object)
Basic information about an image.
imageName -> (string)
The name of the image.
imageId -> (string)
The id of the image.
imageCatalogName -> (string)
Name of the image catalog, the image is from.
created -> (integer)
Image creation timestamp.
componentVersions -> (object)
Versions of the image components.
cm -> (string)
Version of CM.
cdp -> (string)
CDP version.
os -> (string)
OS name.
osPatchLevel -> (string)
OS patch level.
reason -> (string)
The reason why upgrade is not possible.
Form Factors¶
public