manage setup-mcg

Create the secrets that services with a dependency on Multicloud Object Gateway will use to connect to Multicloud Object Gateway.

Required role
Cluster administrator You must be a cluster administrator to run this command.

Extended description

The setup-mcg command creates the secrets that the following services will use to connect to Multicloud Object Gateway:

  • Watson Discovery
  • Watson Speech services
  • watsonx Assistant
  • watsonx™ Orchestrate
    • Required only if you plan to use agentic_assistant mode.
    • Not required if you plan to use agentic mode.
Important: You must run this command before you install or upgrade any of the preceding services on IBM Cloud Pak for Data Version 4.7.

To run this command, Multicloud Object Gateway must be installed on the cluster. For more information, see Installing Multicloud Object Gateway for IBM Cloud Pak for Data.

Syntax

cpd-cli manage setup-mcg \
--components=<comma-separated-list-of-component-names> \
--cpd_instance_ns=<project-name> \
--noobaa_account_secret=<secret-name> \
--noobaa_cert_secret=<secret-name> \
[--preview=true|false]

Arguments

The setup-mcg command has no arguments.

Options

Table 1: Command options
Option Description
--components The components for which you need to create secrets to connect to Multicloud Object Gateway.
The following services have a dependency on Multicloud Object Gateway:
  • Watson Discovery
  • Watson Speech services
  • watsonx Assistant
  • watsonx Orchestrate
    • Required only if you plan to use agentic_assistant mode.
    • Not required if you plan to use agentic mode.
Status
Required.
Syntax
--components=<comma-separated-list-of-component-names>
Default value
No default.
Valid values
Specify any of the following components:
  • watson_assistant
  • watson_discovery
  • watson_speech
  • orchestrate

To specify multiple components in the same command, separate the component names with a comma.
--cpd_instance_ns The project for the IBM Software Hub control plane and services.
Status
Required.
Syntax
--cpd_instance_ns=<project-name>
Default value
No default. User-defined.
Valid values
The name of an existing project on the Red Hat® OpenShift® Container Platform cluster where IBM Cloud Pak for Data is installed or will be installed.
--noobaa_account_secret The name of the secret that contains the noobaa account credentials for connecting to your Multicloud Object Gateway.
Status
Required.
Syntax
--noobaa_account_secret=<secret-name>
Default value
No default.
Valid values
The name of the secret that contains the noobaa account credentials for connecting to your Multicloud Object Gateway.
Run the following command to get the name of the secret:
oc get secret -n openshift-storage

The default secret name is noobaa-admin.
--noobaa_cert_secret The name of the secret that contains the noobaa account certificate for connecting to your Multicloud Object Gateway.
Status
Required.
Syntax
--noobaa_cert_secret=<secret-name>
Default value
No default.
Valid values
The name of the secret that contains the noobaa account certificate for connecting to your Multicloud Object Gateway.
Run the following command to get the name of the secret:
oc get secret -n openshift-storage

The default secret name is noobaa-s3-serving-cert.

If you created additional backing stores, ensure that you select the certificate for the appropriate backing store.
--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.

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.

Create the secrets that Watson Discovery will use to connect to Multicloud Object Gateway

The Watson Discovery secrets will point to the default Multicloud Object Gateway backing store.

cpd-cli manage setup-mcg \
--components=watson_discovery \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--noobaa_account_secret=noobaa-admin \
--noobaa_cert_secret=noobaa-s3-serving-cert