Installing the IBM Cloud Pak for Data command-line interface

CPD_CLI_MANAGE_WORKSPACE

By default, the first time you run a cpd-cli manage command, the cpd-cli automatically creates the cpd-cli-workspace/olm-utils-workspace/work directory.

The location of the directory depends on several factors:

• If you made the cpd-cli executable from any directory, the directory is created in the directory where you run the cpd-cli commands.
• If you did not make the cpd-cli executable from any directory, the directory is created in the directory where the cpd-cli is installed.

You can set the CPD_CLI_MANAGE_WORKSPACE environment variable to override the default location.

The CPD_CLI_MANAGE_WORKSPACE environment variable is especially useful if you made the cpd-cli executable from any directory. When you set the environment variable, it ensures that the files are located in one directory.

Default value

No default value. The directory is created based on the factors described in the preceding text.

Valid values

The fully qualified path where you want the cpd-cli to create the work directory. For example, if you specify /root/cpd-cli/, the cpd-cli manage plug-in stores files in the /root/cpd-cli/work directory.

To set the CPD_CLI_MANAGE_WORKSPACE environment variable, run:

export CPD_CLI_MANAGE_WORKSPACE=<fully-qualified-directory>

OLM_UTILS_LAUNCH_ARGS

If your environment includes certificates that the cpd-cli must use, you can use the OLM_UTILS_LAUNCH_ARGS environment variable to mount the certificates in the container that the cpd-cli uses.

For example:

CA certificates

Mount CA certificates if you need to reach an external HTTPS endpoint that uses a self-signed certificate.

Tip: Typically the CA certificates are in the /etc/pki/ca-trust directory on the workstation. If you need additional information on adding certificates to a workstation, run:

man update-ca-trust

Determine the correct argument for your environment:

• If the certificates on the client workstation are in the /etc/pki/ca-trust directory, the argument is:

  " -v /etc/pki/ca-trust:/etc/pki/ca-trust"

• If the certificates on the client workstation are in a different directory, replace <ca-loc> with the appropriate location on the client workstation:

  " -v <ca-loc>:/etc/pki/ca-trust"

Kubernetes certificates

Mount Kubernetes certificates if you need to use a certificate to connect to the Kubernetes API server.

The argument depends on the location of the certificates on the client workstation. Replace <k8-loc> with the appropriate location on the client workstation:

" -v <k8-loc>:/etc/k8scert --env K8S_AUTH_SSL_CA_CERT=/etc/k8scert"

Default value

No default value. The directory is created based on the factors described in the preceding text.

Valid values

The valid values depend on the arguments that you need to pass to the OLM_UTILS_LAUNCH_ARGS environment variable.

• To pass CA certificates, specify:

  " -v <ca-loc>:/etc/pki/ca-trust"

• To pass Kubernetes certificates, specify:

  " -v <k8-loc>:/etc/k8scert --env K8S_AUTH_SSL_CA_CERT=/etc/k8scert"

• To pass both CA certificates and Kubernetes certificates, specify:

  " -v <ca-loc>:/etc/pki/ca-trust -v <k8-loc>:/etc/k8scert --env K8S_AUTH_SSL_CA_CERT=/etc/k8scert"

To set the OLM_UTILS_LAUNCH_ARGS environment variable, run:

export OLM_UTILS_LAUNCH_ARGS=" <arguments>"

cpd-cli manage restart-container