The nz-cloud command

Deployment options: Netezza Performance Server for Cloud Pak for Data

Learn about the nz-cloud installation command, its syntax, arguments, functions, and usage examples.

Prerequisites

Syntax

./nz-cloud ARGUMENTS | SUBCOMMAND

Arguments for nz-cloud

Table 1. Arguments for the nz-cloud command.
Argument Description
-h | --help Displays this help message.
-v | --verbose Displays information about the installation steps.
--version Displays information about the version of the nz-cloud installer.
--supported regions [AWS] Displays the list of supported regions for AWS.
-i | --install=FUNCTION Installs all or specified functions that are separated with commas.
-d | --uninstall=FUNCTION Uninstalls all or specified functions that are separated with commas.
--enable-nps-addon Specifies the installation on an existing Red Hat OpenShift and Cloud Pak for Data instance. AWS only.
  • With --enable-nps-addon, you can check which version of Red Hat OpenShift and Cloud Pak for Data you have.

    Not all --enable-nps-addon versions are compatible with all Red Hat OpenShift versions. Make sure to install only the supported version of nps-addon basing on the Cloud Pak for Data version that you have.

    --enable-nps-addon is supported only for Red Hat OpenShift 4.6 and Cloud Pak for Data 3.5.2.

  • With --enable-nps-addon, you can also specify the validation of an existing properties file. You cannot change and or delete the file by using --enable-nps-addon.
-u | --upgrade=UP_FUNC Updates all or specified functions that are separated with commas. The --update argument must be used with the properties file (-p | -properties) argument to connect to the cluster.
-p | --properties=PROP Specifies the path to the properties file.
-t | --test Does tests for the running cluster.
--token Use the argument to log in to the cluster.
-n | --cpd-namespace Specifies the namespace in which your Cloud Pak for Data instance is deployed. zen is the default namespace.
-b | --backup=[ocp | cpd] Creates a backup of the specified component.

Functions for -u | --upgrade

Table 2. Functions for the-u | --upgrade argument.
Cloud provider Function Description
Common nps-addon Updates the Netezza Performance Server tile in the Cloud Pak for Data web console.
local-csi-plugin Updates the container storage interface plug-in.
all Updates Red Hat OpenShift, Cloud Pak for Data, the Netezza Performance Server add-on, and all dependencies, depending on the platform you are on.
     
AWS efs-provisioner Updates the EFS provisioner.
aws-nzds-csi-driver Updates the NZDS CSI driver.
nps-instance Updates the Netezza Performance Server instance.
ocp Updates Red Hat OpenShift to a specified version. You must provide a specific upgrade path as suggested by Red Hat OpenShift.
cpd Updates Cloud Pak for Data to a specified version.
ocs Updates Red Hat OpenShift Container Storage.
     

Functions for -i | --install

Table 3. Functions for the-i | --install argument.
Cloud provider Function Description
AWS ocp Installs Red Hat OpenShift.
cpd Installs Cloud Pak for Data.
nps-addon Installs the Netezza Performance Server tile in the Cloud Pak for Data web console.
all Installs Red Hat OpenShift, Cloud Pak for Data, and the Netezza Performance Server add-on.

Subcommands

Table 4. Subcommands accepted by the nz-cloud command.
Subcommand Description
show-permissions Displays the list of IAM permissions that are required to run the nz-cloud installer.
validate-permissions Validates whether the user has the necessary IAM permissions.
show-inventory Displays the cloud provider account limit requirements
validate-limits Validates the cloud provider account limit requirements.
user-role Adds a role to the user or removes a role from a user.
clear-prior-runs Clears the state and generated metadata files for previous runs.