Specifying installation options for services

If you plan to install Analytics Engine powered by Apache Spark, you can specify the following installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the analyticsengine: entry.

The sample YAML content uses the default values.

If you plan to install Data Replication, you must specify the following installation option in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameter is required.

Add the parameter to the override_components_meta: section of the install-options.yml file under the replication: entry.

Replace <license> with the appropriate value for your environment.

If you plan to install IBM Knowledge Catalog, IBM Knowledge Catalog Premium, or IBM Knowledge Catalog Standard, you can specify installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used.

The applicable parameters and default values depend on which service you install:

IBM Knowledge Catalog

The sample YAML content uses the default values.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the wkc: entry.

# ............................................................................
# IBM Knowledge Catalog parameters
# ............................................................................
  wkc:
    enableDataQuality: False
    enableKnowledgeGraph: False
    useFDB: False

IBM Knowledge Catalog Premium

The sample YAML content uses the default values.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the ikcPremium: entry.

# ............................................................................
# IBM Knowledge Catalog Premium parameters
# ............................................................................
  ikcPremium:
    enableDataQuality: False
    enableKnowledgeGraph: False
    useFDB: False
    enableAISearch: False
    enableSemanticAutomation: False
    enableSemanticEnrichment: True
    enableSemanticEmbedding: False
    enableTextToSql: False
    enableModelsOn: 'cpu'
    customModelTextToSQL: granite-3-3-8b-instruct

IBM Knowledge Catalog Standard

The sample YAML content uses the default values.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the ikcStandard: entry.

# ............................................................................
# IBM Knowledge Catalog Standard parameters
# ............................................................................
  ikcStandard:
    enableKnowledgeGraph: False
    useFDB: False
    enableAISearch: False
    enableSemanticAutomation: False
    enableSemanticEnrichment: True
    enableSemanticEmbedding: False
    enableTextToSql: False
    enableModelsOn: 'cpu'
    customModelTextToSQL: granite-3-3-8b-instruct

If you plan to install IBM Master Data Management, you can specify the following installation options in a YAML file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

Include the optional parameters in the installation by using the --param-file argument in the cpd-cli manage install-components command.

The parameters are optional. If you do not set these installation parameters, the default values are used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the match360: entry.

The sample YAML content uses the default values.

If you plan to install Informix, you can specify the following installation option in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameter is optional. If you do not set this installation parameter, the default value is used.

If you want to override the default values, add the parameters to the non_olm: section of the install-options.yml file under the ibmInformixCp4dOperator: entry.

The sample YAML content uses the default values.

The parameter is optional. If you do not set this installation parameter, the default value is used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the wsPipelines: entry.

The sample YAML content uses the default values.

The parameters are optional. If you do not set these installation parameters, the default values are used.

If you want to override one or more of the default values, add the parameters to the override_components_meta: section of the install-options.yml file under the voice_gateway: entry.

The sample YAML content uses the default values.

Replicas

Parameter	Description
replicas	Specify the number of replicas to deploy. You can increase the number of replicas to support additional concurrent calls. Default value 1 Valid values An integer greater than 0.

Node selector parameters

Parameter

Description

nodeSelector

If you want Voice Gateway pods to run on specific nodes, you can add one or more node selectors to the nodeSelector block. To use this feature, the nodes on your cluster must be labeled. For more information on node labels, see the Red Hat OpenShift® Container Platform documentation. Default value No default value. Node selectors are optional and are user-defined. Valid values Specify one or more node labels using key-value pairs with the format key: value. Enter each key-value pair on a new line. The sample YAML file includes a formatting example. Including this parameter Ensure that you uncomment the nodeSelector line and any key-value pairs that you want to include. For example: nodeSelector: <key-name1>: <value1> <key-name2>: <value2>

Taint toleration parameters

Parameter

Description

tolerations

If you use taints to prevent pods from being scheduled on specific nodes, you can add one or more taint tolerations to the tolerations block. To use this feature, the nodes on your cluster must be tainted. For more information on taints and taint tolerations, see the Red Hat OpenShift Container Platform documentation. Default value No default value. Taint tolerations are optional and are user-defined. Valid values Specify one ore more taint tolerations in list format. The sample YAML file includes a formatting example. Enter each taint toleration as a new list item. A toleration typically includes a key, an operator, a value, and an effect. The sample YAML file includes a formatting example. Including this parameter Ensure that you uncomment the tolerations line and any list items that you want to include. For example: tolerations: - key: "<key-name>" operator: "<operator>" value: "<value>" effect: "<effect>"

SSL configuration parameters

Parameter	Description
disableSslCertValidation	Specify whether Voice Gateway should disable SSL certificate validation. Default value false Valid values false Do not disable SSL certificate validation. The service will validate SSL certificates. Set disableSslCertValidation: false if you plan to replace the default, self-signed TLS certificate that is shipped with Cloud Pak for Data with a certificate that is signed by a certificate authority. true Disable SSL certificate validation. The service will not validate SSL certificates. Set disableSslCertValidation: true if you plan to use a self-signed TLS certificate. Including this parameter Ensure that you uncomment the following lines: sslConfig: disableSslCertValidation: true
enableSsl (Media Relay)	Specify whether you want the Media Relay microservice to establish SSL connections to, Watson Speech to Text and Watson Text to Speech. Default value false Valid values false Do not enable SSL connections to the servers. true Enable SSL connections to the servers. If you want to use this option, you must create the following secrets in the PROJECT_CPD_INST_OPERANDS project: A secret that contains the CA certificate file. Specify the name of the secret in the sslClientCACertSecret parameter. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the sslClientCACertSecret parameter: sslConfig: mediaRelay: enableSsl: true sslClientCACertSecret: <my-secret-name>
sslClientCACertSecret (Media Relay)	Specify the name of the secret that contains the CA certificate file that is used when enableSsl is set to true. To create the secret that contains the CA certificate file, run the following commands: Set the RELAY_CA_FILE environment variable to the name of the CA certificate PEM file: RELAY_CA_FILE=<fully-qualified-pem-file-name> Create the secret. The following command uses the recommended name, client-ca-cert-secret. You can change the name if it will conflict with another secret in your environment. oc create secret generic client-ca-cert-secret \ --from-file=clientCaCertFile=${RELAY_CA_FILE} \ --namespace=${PROJECT_CPD_INST_OPERANDS} Default value client-ca-cert-secret If you don't specify the sslClientCACertSecret parameter, the default secret name is used. Valid values The name of the secret that contains the CA certificate file. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the sslClientCACertSecret parameter: sslConfig: mediaRelay: enableSsl: true sslClientCACertSecret: <my-secret-name>
enableMutualAuth (Media Relay)	Specify whether to enable mutual authentication between the client server and the Media Relay microservice. Default value false Valid values false Do not enable mutual authentication. true Enable mutual authentication. If you want to use this option, you must create the following secrets in the PROJECT_CPD_INST_OPERANDS project: A secret that contains the SSL keystore. Specify the name of the secret in the sslClientPkcs12FileSecret parameter. A secret that contains the SSL passphrase. Specify the name of the secret in the sslClientPassphraseSecret parameter. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: sslConfig: mediaRelay: enableMutualAuth: true sslClientPkcs12FileSecret: <my-secret-name> sslClientPassphraseSecret: <my-secret-name>
sslClientPkcs12FileSecret (Media Relay)	Specify the name of the secret that contains the SSL keystore for mutual authentication. The keystore can be a PKCS12 file, a JKS file, or a JCEKS file. To create the secret that contains the SSL keystore file, run the following commands: Set the RELAY_KEYSTORE_FILE environment variable to the name of the SSL keystore file: RELAY_KEYSTORE_FILE=<fully-qualified-file-name> Create the secret. The following command uses the recommended name, ssl-client-pkcs12-file-secret. You can change the name if it will conflict with another secret in your environment. oc create secret generic ssl-client-pkcs12-file-secret \ --from-file=clientPkcs12File=${RELAY_KEYSTORE_FILE} \ --namespace=${PROJECT_CPD_INST_OPERANDS} Default value ssl-client-pkcs12-file-secret If you don't specify the sslClientPkcs12FileSecret parameter, the default secret name is used. Valid values The name of the secret that contains the SSL keystore file. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: sslConfig: mediaRelay: enableMutualAuth: true sslClientPkcs12FileSecret: <my-secret-name> sslClientPassphraseSecret: <my-secret-name>
sslClientPassphraseSecret (Media Relay)	Specify the name of the secret that contains the SSL passphrase for mutual authentication. To create the secret that contains the SSL passphrase, run the following commands: Set the RELAY_SSL_PASSPHRASE environment variable to the SSL passphrase RELAY_SSL_PASSPHRASE=<passphrase> Create the secret. The following command uses the recommended name, ssl-client-passphrase-secret. You can change the name if it will conflict with another secret in your environment. oc create secret generic ssl-client-passphrase-secret \ --from-literal=sslClientPassphrase=${REPLAY_SSL_PASSPHRASE} \ --namespace=${PROJECT_CPD_INST_OPERANDS} Default value ssl-client-passphrase-secret If you don't specify the sslClientPassphraseSecret parameter, the default secret name is used. Valid values The name of the secret that contains the SSL passphrase. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: sslConfig: mediaRelay: enableMutualAuth: true sslClientPkcs12FileSecret: <my-secret-name> sslClientPassphraseSecret: <my-secret-name>
enableSslorMutualAuth (SIP Orchestrator)	Specify whether to enable SSL for the SIP Orchestrator microservice. Depending on the certificate that you provide, this enables either: SSL connections to watsonx Assistant SSL connections to watsonx Assistant and mutual authentication between the client server and the SIP Orchestrator microservice Default value false Valid values false Do not enable SSL. true Enable SSL. If you want to use this option, you must create the following secrets in the PROJECT_CPD_INST_OPERANDS project: A secret that contains the SSL keystore. Specify the name of the secret in the sslKeyTrustStoreSecret parameter. A secret that contains the SSL passphrase. Specify the name of the secret in the sslPassphraseSecret parameter. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: sslConfig: sipOrchestrator: enableSslorMutualAuth: true sslKeyTrustStoreSecret: <my-secret-name> sslFileType: "<file-type>" sslPassphraseSecret: <my-secret-name>
sslKeyTrustStoreSecret (SIP Orchestrator)	Specify the name of the secret that contains the SSL keystore. The keystore can be a PKCS12 file, a JKS file, or a JCEKS file. To create the secret that contains the SSL keystore file, run the following commands: Set the SIP_KEYSTORE_FILE environment variable to the name of the SSL keystore file: SIP_KEYSTORE_FILE=<fully-qualified-file-name> Create the secret. The following command uses the recommended name, trust-store-file-secret. You can change the name if it will conflict with another secret in your environment. oc create secret generic trust-store-file-secret \ --from-file==trustStoreFile=${SIP_KEYSTORE_FILE} \ --namespace=${PROJECT_CPD_INST_OPERANDS} Default value trust-store-file-secret If you don't specify the sslKeyTrustStoreSecret parameter, the default secret name is used. Valid values The name of the secret that contains the SSL keystore file. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: sslConfig: sipOrchestrator: enableSslorMutualAuth: true sslKeyTrustStoreSecret: <my-secret-name> sslFileType: "<file-type>" sslPassphraseSecret: <my-secret-name>
sslFileType (SIP Orchestrator)	Specify the format of the SSL keystore file. The keystore can be a file, a file, or a file. Default value JKS If you don't specify the sslFileType parameter, the default file type is used. Valid values JCEKS JKS PKCS12 Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: sslConfig: sipOrchestrator: enableSslorMutualAuth: true sslKeyTrustStoreSecret: <my-secret-name> sslFileType: "<file-type>" sslPassphraseSecret: <my-secret-name>
sslPassphraseSecret (SIP Orchestrator)	Specify the name of the secret that contains the SSL passphrase. To create the secret that contains the SSL passphrase, run the following commands: Set the SIP_SSL_PASSPHRASE environment variable to the SSL passphrase SIP_SSL_PASSPHRASE=<passphrase> Create the secret. The following command uses the recommended name, ssl-passphrase-secret. You can change the name if it will conflict with another secret in your environment. oc create secret generic ssl-passphrase-secret \ --from-literal=sslPassphrase=${SIP_SSL_PASSPHRASE} \ --namespace=${PROJECT_CPD_INST_OPERANDS} Default value ssl-passphrase-secret If you don't specify the sslPassphraseSecret parameter, the default secret name is used. Valid values The name of the secret that contains the SSL passphrase. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: sslConfig: sipOrchestrator: enableSslorMutualAuth: true sslKeyTrustStoreSecret: <my-secret-name> sslFileType: "<file-type>" sslPassphraseSecret: <my-secret-name>

Port parameters

Parameter	Description
sipSignalingPortUdp	Override the default UDP port for the SIP signaling protocol if the default port number will conflict with an existing port. Default value 5060 Valid values An available port on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the <port-number>: ports: sipSignalingPortUdp: <port-number>
sipSignalingPortTcp	Override the default TCP port for the SIP signaling protocol if the default port number will conflict with an existing port. Default value 5060 Valid values An available port on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the <port-number>: ports: sipSignalingPortTcp: <port-number>
sipSignalingPortTls	Override the default TLS port for the SIP signaling protocol if the default port number will conflict with an existing port. Default value 5061 Valid values An available port on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the <port-number>: ports: sipSignalingPortTls: <port-number>
sipOrchestratorHttpPort	Override the default HTTP port for the SIP Orchestrator microservice if the default port number will conflict with an existing port. Default value 9446 Valid values An available port on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the <port-number>: ports: sipOrchestratorHttpPort: <port-number>
sipOrchestratorHttpsPort	Override the default HTTPS port for the SIP Orchestrator microservice if the default port number will conflict with an existing port. Default value 5060 Valid values An available port on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the <port-number>: ports: sipOrchestratorHttpsPort: <port-number>
mediaRelayWsPort	Override the default web socket port for the Media Relay microservice if the default port number will conflict with an existing port. Default value 8080 Valid values An available port on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the <port-number>: ports: mediaRelayWsPort: <port-number>
rtpUdpPortRange	Adjust the number of RTP ports based on the number of concurrent calls that you want to support. Default value "16384-16394" By default, Voice Gateway supports 10 concurrent calls. Valid values A range of available ports on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for each instance of <port-number>: ports: rtpUdpPortRange: "<port-number>-<port-number>"

Environment variable parameters

Parameter	Description
sipOrchestrator environment variables	Specify any SIP Orchestrator environment variables that you want to use to configure the SIP Orchestrator microservice. Default value No default. Environment variables are optional. Valid values Specify one ore more SIP Orchestrator environment variables in list format. The sample YAML file includes a formatting example. Enter each environment variable as a new list item. An environment variable includes the variable name and the value to use. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: env: sipOrchestrator: - name: <variable-name> value: "<value>"
mediaRelay environment variables	Specify any Media Relay environment variables that you want to use to configure the Media Relay microservice. Default value No default. Environment variables are optional. Valid values Specify one ore more Media Relay environment variables in list format. The sample YAML file includes a formatting example. Enter each environment variable as a new list item. An environment variable includes the variable name and the value to use. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: env: mediaRelay: - name: <variable-name> value: "<value>"

Storage parameters

Parameter	Description
enablePersistentRecordings (Recordings)	Specify whether to save recordings to persistent storage. Default value false Valid values false Do not store recordings. true Save recordings to persistent storage. If you want to use this option, you must specify the name of the file storage class to use in the storageClassName parameter. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: storage: recordings: enablePersistentRecordings: true storageClassName: "<storage-class-name>"
storageClassName (Recordings)	Specify the name of the storage class that points to file storage. Default value No default. The name depends on the storage classes that are defined on your cluster. Valid values The name of a file storage class on your cluster. If you sourced the installation environment variables script, run the following command to determine the file storage class that is used by other Cloud Pak for Data services: echo $STG_CLASS_FILE Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the storageClassName parameter: storage: recordings: enablePersistentRecordings: true storageClassName: "<storage-class-name>"
size (Recordings)	Specify the size of the persistent volume. Default value 15Gi Assuming 1000 calls per day, you'd need 1.92 Gi worth of disk space to store recordings for that day. If you want to keep recordings for a week you'd need at least 15 Gi of disk space since recordings are not automatically cleaned up. Valid values Specify the amount of storage, in gibibyte (Gi) to allocate to the volume. Ensure that there is sufficient space on your storage device. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: storage: recordings: enablePersistentRecordings: true storageClassName: "<storage-class-name>" size: <integer>Gi
enablePersistentLogs (Logs)	Specify whether to save logs to persistent storage. Default value false Valid values false Do not store logs. true Save logs to persistent storage. If you want to use this option, you must specify the name of the file storage class to use in the storageClassName parameter. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: storage: recordings: enablePersistentLogs: true storageClassName: "<storage-class-name>"
storageClassName (Logs)	Specify the name of the storage class that points to file storage. Default value No default. The name depends on the storage classes that are defined on your cluster. Valid values The name of a file storage class on your cluster. If you sourced the installation environment variables script, run the following command to determine the file storage class that is used by other Cloud Pak for Data services: echo $STG_CLASS_FILE Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the storageClassName parameter: storage: recordings: enablePersistentLogs: true storageClassName: "<storage-class-name>"
size (Logs)	Specify the size of the persistent volume. Default value 10Gi Assuming 1000 calls per day. Valid values Specify the amount of storage, in gibibyte (Gi) to allocate to the volume. Ensure that there is sufficient space on your storage device. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the parameters: storage: recordings: enablePersistentLogs: true storageClassName: "<storage-class-name>" size: <integer>Gi

Container resource parameters

Parameter	Description
sipOrchestrator	Specify the amount of vCPU and memory to allocate to the SIP Orchestrator microservice container. It is recommended that you assign 20% of the resources to the SIP Orchestrator microservice container Default value vCPU Requests: 1 vCPU ("1.0") Limits: 2 vCPU ("2.0") Memory Requests: 1 Gi RAM (1Gi) Limits: 2 Gi RAM (2Gi) Valid values Specify the amount of vCPU and memory to allocate to the microservice. Ensure that you have sufficient resources on the worker nodes in the cluster. Including this parameter Ensure that you uncomment the following lines: resources: sipOrchestrator: Then uncomment the resource allocations that you want to override and specify the appropriate values: # requests: # cpu: "1.0" # memory: 2Gi # limits: # cpu: "1.0" # memory: 2Gi
mediaRelay	Specify the amount of vCPU and memory to allocate to the Media Relay microservice container. It is recommended that you assign 80% of the resources to the Media Relay microservice container. Default value vCPU Requests: 1 vCPU ("1") Limits: 4 vCPU ("4") Memory Requests: 1 Gi RAM (1Gi) Limits: 4 Gi RAM (4Gi) Valid values Specify the amount of vCPU and memory to allocate to the microservice. Ensure that you have sufficient resources on the worker nodes in the cluster. Including this parameter Ensure that you uncomment the following lines: resources: mediaRelay: Then uncomment the resource allocations that you want to override and specify the appropriate values: # requests: # cpu: "1" # memory: 1Gi # limits: # cpu: "4" # memory: 4Gi
g729Codec	Specify the amount of vCPU and memory to allocate to the G729 Codec container, if the service is enabled. Default value vCPU Requests: 0.5 vCPU ("0.5") Limits: 1 vCPU ("1") Memory Requests: 0.5 Gi RAM (0.5Gi) Limits: 1 Gi RAM (1Gi) Valid values Specify the amount of vCPU and memory to allocate to the microservice. Ensure that you have sufficient resources on the worker nodes in the cluster. Including this parameter Ensure that you uncomment the following lines: resources: g729Codec: Then uncomment the resource allocations that you want to override and specify the appropriate values: # requests: # cpu: "0.5" # memory: 0.5Gi # limits: # cpu: "1" # memory: 1Gi

G729 Codec Service parameters

Parameter	Description
enabled	Specify whether you want to enable the G729 Codec service. Default value false Valid values false Do not enable the G729 Codec service. true Enable the G729 Codec service Including this parameter Ensure that you uncomment the following lines: g729Codec: enabled: true
logLevel	Specify the level of detail to include in the G729 Codec logs. Default value "INFO" Valid values "DEBUG" "INFO" "WARN" "ERROR" Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the <log-level>: g729Codec: enabled: true logLevel: "<log-level>"
webSocketServerPort	Override the default web socket port for the G729 Codec service if the default port number will conflict with an existing port. Default value 9001 Valid values An available port on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the <port-number>: g729Codec: enabled: true webSocketServerPort: 9001

Media Resource Control Protocol parameters

Parameter	Description
enableMrcp	Specify whether you want to enable Media Resource Control Protocol Version 2 (MRCPv2) connections to enable the service to integrate with third-party speech to text and text to speech services. Default value false Valid values false Do not enable MRCPv2 connections true Enable MRCPv2 connections. If you want to use this option, you must create the following secrets in the PROJECT_CPD_INST_OPERANDS project: A secret that contains the unimrcpclient.xml file. Specify the name of the secret in the unimrcpConfigSecretName parameter. Including this parameter Ensure that you uncomment the following lines: mrcp: enableMrcp: true
unimrcpConfigSecretName	Specify the name of the secret that includes the unimrcpclient.xml file. To create the secret that contains the unimrcpclient.xml file, run the following commands: Set the MRCP_FILE environment variable to the fully qualified name of the unimrcpclient.xml file: MRCP_FILE=<fully-qualified-file-name> Create the secret. The following command uses the recommended name, unimrcp-config-secret. You can change the name if it will conflict with another secret in your environment. oc create secret generic unimrcp-config-secret \ --from-file=unimrcpConfig=${MRCP_FILE} \ --namespace=${PROJECT_CPD_INST_OPERANDS} Default value unimrcp-config-secret If you don't specify the unimrcpConfigSecretName parameter, the default secret name is used. Valid values The name of the secret that contains the unimrcpclient.xml file. Including this parameter Ensure that you uncomment the following lines and specify the appropriate values for the <secret-name>: mrcp: enableMrcp: true unimrcpConfigSecretName: <secret-name>
mrcpv2SipPort	Override the default SIP port for the MRCPv2 connection if the default port number will conflict with an existing port. Default value 5555 Valid values An available port on the server. Including this parameter Ensure that you uncomment the following lines and specify the appropriate value for the <port-number>: mrcp: enableMrcp: true mrcpv2SipPort: <port-number>

If you plan to install Watson Discovery, you can specify the following installation option in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameter is optional. If you do not set this installation parameter, the default value is used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the watsonDiscovery: entry.

The sample YAML content uses the default value.

If you plan to install the Watson Speech services, you can specify the following installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the watsonSpeech: entry.

The sample YAML content uses the default values.

You can specify the following installation options for watsonx.ai in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the watsonxAi: entry.

The sample YAML content uses the default values.

If you plan to install watsonx Assistant, you can specify the following installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the watsonAssistant: entry.

The sample YAML content uses the default values.

If you plan to install watsonx BI, you must specify the following installation option in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameter is required.

Add the parameter to the override_components_meta: section of the install-options.yml file under the watsonx_bi_assistant: entry.

Replace <license> with the appropriate value for your environment..

If you plan to install watsonx.data, you can specify the following installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the watsonxData: entry.

The sample YAML content uses the default values.

# ............................................................................
# watsonx.data parameters
# ............................................................................
  watsonxData:
    enable_lite_milvus: false
    scaleConfig: small

If you plan to install watsonx.data Premium, you must specify installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are required and depend on whether you already installed watsonx.ai on this instance of IBM Software Hub.

If you plan to install watsonx.data integration, you can specify installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used. Uncomment the parameters that you want to override and update the values appropriately.

If you want to override one or more of the default values, add the parameters to the custom_spec: section of the install-options.yml file under the watsonx_dataintegration: entry.

The sample YAML content uses the default values.

If you plan to install watsonx.data intelligence, you can specify installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used.

If you want to override one or more of the default values, add the parameters to the non_olm: section of the install-options.yml file under the watsonxDataintelligence: entry.

The sample YAML content uses the default values.

If you plan to install watsonx.governance, you must specify the following installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are required.

Add the parameters to the non_olm: section of the install-options.yml file under the watsonxGovernance: entry.

The sample YAML content uses the default values, where defaults exist.

If you plan to install watsonx Orchestrate configuration, specify the appropriate installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

Models provided by IBM

Review the following table to determine which model or models provide the features that you need:

Model	Agentic AI Domain agents	Agentic AI Tool and API orchestration	Conversational search Answer generation	Conversational search Query rewrite	Conversational skills Custom actions information gathering
granite-3-8b-instruct	No	No	Yes	No	No
ibm-granite-8b-unified-api-model-v2	No	No	No	Yes	Yes
llama-3-1-70b-instruct	No	Yes	Yes	Yes	Yes
llama-3-2-90b-vision-instruct	Yes	Yes	Yes	Yes	Yes

Important: The llama-3-2-90b-vision-instruct model is recommended over the llama-3-1-70b-instruct model. The llama-3-2-90b-vision-instruct model offers:

• Better performance
• More accurate results

Private container registry users: You must mirror the images for the models that you plan to use to the private container registry. For more information, see Determining which models to mirror to your private container registry.

Choose the appropriate YAML based on where you plan to install the foundation models:

Install foundation models on the same cluster as watsonx Orchestrate

Add the parameters to the non_olm: section of the install-options.yml file under the watsonxOrchestrate: entry.

# ............................................................................
# watsonx Orchestrate parameters
# ............................................................................
  watsonxOrchestrate:
    installMode: "agentic"  
    watsonxAI:
      watsonxaiifm: true
      syomModels: []
      ootbModels: []

Use foundation models on a remote or external cluster by using AI gateway

Add the parameters to the non_olm: section of the install-options.yml file under the watsonxOrchestrate: entry.

# ............................................................................
# watsonx Orchestrate parameters
# ............................................................................
  watsonxOrchestrate:
    installMode: "agentic"  
    watsonxAI:
      watsonxaiifm: false
      syomModels: []
      ootbModels: []