manage install-cpd-config-ac

Install the IBM Software Hub configuration admission controller by creating an instance-scoped webhook.

Required role

Cluster administrator A cluster administrator must run this command.

Extended description

The IBM® Software Hub configuration admission controller is a mutating webhook that injects the cpd-custom-ca-certs secret, the secret mount, and the associated environment variables into IBM Software Hub pods so that they have access to a shared set of custom certificates.

The following services support shared custom certificates:

  • AI Factsheets
  • Analytics Engine powered by Apache Spark
  • Cognos Analytics
  • Data Privacy
  • DataStage
  • Data Virtualization
  • Db2 Big SQL
  • IBM Master Data Management
  • OpenPages
  • RStudio®
  • Watson Studio
  • Watson Studio Runtimes
  • watsonx Assistant
  • watsonx.data™
  • watsonx™ Orchestrate

The webhook is installed in the project where the IBM Software Hub control plane is installed.

If you have multiple instances of IBM Software Hub on the cluster, you must run this command for each instance where you want to use the IBM Software Hub configuration admission controller.

After you install the configuration admission controller, enable it by running the cpd-cli manage enable-cpd-config-ac command.

Syntax

cpd-cli manage install-cpd-config-ac \
--cpd_instance_ns=<project-name> \
[--cpd_config_ac_image=<image-location-and-name>] \
[--preview=true|false] \
[-v][-vv][-vvv]

Arguments

The install-cpd-config-ac command has no arguments.

Options

Table 1: Command options
Option Description
--cpd_instance_ns The project (namespace) where IBM Software Hub is installed.
Status
Required.
Syntax
--cpd_instance_ns=<project-name>
Default value
No default. User-defined.
Valid values
The project where the IBM Software Hub control plane is installed. The configuration admission controller webhook will be created in this project.
--cpd_config_ac_image The location and name of the zen-rsi-adm-controller image to use when installing the admission controller.
Status
Required if you pull images from a private container registry.
Syntax
--cpd_config_ac_image=<image-location-and-name>
Default value
The default value depends on the version of the olm-utils-v4 image on your client workstation.
Valid values
To pull a specific version of the image from the IBM Entitled Registry, specify:
x86-64 clusters
icr.io/cpopen/cpfs/zen-rsi-adm-controller:${ZEN_VERSION}-amd64
ppc64le clusters
icr.io/cpopen/cpfs/zen-rsi-adm-controller:${ZEN_VERSION}-ppc64le
s390x clusters
icr.io/cpopen/cpfs/zen-rsi-adm-controller:${ZEN_VERSION}-s390x
To pull the image from a private container registry, specify:
x86-64 clusters
${PRIVATE_REGISTRY_LOCATION}/cpopen/cpfs/zen-rsi-adm-controller:${ZEN_VERSION}-amd64
ppc64le clusters
${PRIVATE_REGISTRY_LOCATION}/cpopen/cpfs/zen-rsi-adm-controller:${ZEN_VERSION}-ppc64le
s390x clusters
${PRIVATE_REGISTRY_LOCATION}/cpopen/cpfs/zen-rsi-adm-controller:${ZEN_VERSION}-s390x
--preview Preview the commands that run when you issue this CLI command.

The command issues a series of oc commands. You can see the list of oc commands that are associated with the command.

The oc commands are saved to the preview.sh file in the work directory.

Status
Optional.
Syntax
--preview=true|false
Default value
false

If you omit this option, the default value is used.

Valid values
false
Run the commands to apply the changes to your cluster.
true
Preview the commands without running them.

You can copy the oc commands from the output and run them yourself. However, this method is not recommended. When you run the commands manually, you do not have access to the additional helper scripts that are included in the underlying Ansible® playbook.
-v
-vv
-vvv
 Display verbose output.

Options are listed from least verbose to the most verbose.

Status
Optional.
Syntax
Verbose output
-v
Very verbose output
-vv
Most verbose output
-vvv
Default value
Not applicable.
Valid values
Not applicable.

Examples

Note: The following example uses the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For details, see Setting up installation environment variables.

Install the configuration admission controller in the specified instance of IBM Software Hub
cpd-cli manage install-cpd-config-ac \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}
Install the configuration admission controller in the specified instance of IBM Software Hub when the cluster pulls images from a private container registry
cpd-cli manage install-cpd-config-ac \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--cpd_config_ac_image=${PRIVATE_REGISTRY_LOCATION}/cpopen/cpfs/zen-rsi-adm-controller:${ZEN_VERSION}-amd64