Specifying installation options for services

If you plan to install the services at the same time as the IBM Cloud Pak for Data control plane, create an install-options.yml file to specify the installation options for the services that you plan to install.

Installation phase

Setting up a client workstation

Setting up a cluster

Collecting required information

Preparing to run installs from a private container registry

Preparing the cluster for Cloud Pak for Data

Preparing to install an instance of Cloud Pak for Data

Installing an instance of Cloud Pak for Data

Who needs to complete this task?

Instance administrator An instance administrator can complete this task.

When do you need to complete this task?

Complete this task if you are planning to install services when you install the Cloud Pak for Data control plane.

Repeat as needed Complete this task for each instance of Cloud Pak for Data that you plan to install. You can use different options in each instance.

Which services have additional installation options?

Service	Installation options	Required?
AI Factsheets	No installation options.
Analytics Engine powered by Apache Spark	Yes. See Analytics Engine powered by Apache Spark parameters.	Optional.
Cognos® Analytics	No installation options.
Cognos Dashboards	No installation options.
Data Privacy	No installation options.
Data Refinery	No. Data Refinery cannot be separately installed.
Data Replication	Yes. See Data Replication parameters.	Required.
DataStage®	No installation options.
Db2®	No installation options.
Db2 Big SQL	No installation options.
Db2 Data Gate	No installation options.
Db2 Data Management Console	No installation options.
Db2 Warehouse	No installation options.
Decision Optimization	No installation options.
EDB Postgres	No installation options.
Execution Engine for Apache Hadoop	No installation options.
IBM® Match 360 with Watson™	Yes. See IBM Match 360 with Watson parameters.	Optional.
Informix®	Yes. See Informix parameters.	Optional.
MANTA Automated Data Lineage	No installation options.
OpenPages®	No installation options.
Planning Analytics	No installation options.
Product Master	No installation options.
RStudio® Server Runtimes	No installation options.
SPSS® Modeler	No installation options.
Watson Assistant	Yes. See Watson Assistant parameters.	Optional.
Watson Discovery	Yes. See Watson Discovery parameters.	Optional.
Watson Knowledge Catalog	Yes. See Watson Knowledge Catalog parameters.	Optional.
Watson Knowledge Studio	No installation options.
Watson Machine Learning	No installation options.
Watson Machine Learning Accelerator	No installation options.
Watson OpenScale	No installation options.
Watson Pipelines	No installation options.
Watson Query	No installation options.
Watson Speech services	Yes. See Watson Speech services parameters.	Optional.
Watson Studio	No installation options.
Watson Studio Runtimes	No installation options.
watsonx.data	No installation options.

Installation parameter file

Create a file called install-options.yml in the cpd-cli work directory.
Depending on your settings, the work directory is in one of the following locations:
Default location
- If you made the cpd-cli executable from any directory, the path to the directory is:
  <current-directory>/cpd-cli-workspace/olm-utils-workspace/work
- If you did not make the cpd-cli executable from any directory, the path to the directory is:
  <cli-install-directory>/cpd-cli-workspace/olm-utils-workspace/work
Custom location

If you set the CPD_CLI_MANAGE_WORKSPACE environment variable, path to the directory is:
${CPD_CLI_MANAGE_WORKSPACE}/work
Review the following sections and add parameters to the install-options.yml file based on the services that you plan to install:
You can use the same file to specify install options for multiple services.
Save your changes.

When you run the cpd-cli manage apply-cr command, use the --param-file=/tmp/work/install-options.yml option to use the values from your installation parameter file.

Analytics Engine powered by Apache Spark parameters

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 work directory.

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.

The sample YAML content uses the default values.

################################################################################
# Analytics Engine powered by Apache Spark parameters
################################################################################

# ------------------------------------------------------------------------------
# Analytics Engine powered by Apache Spark service configuration parameters
# ------------------------------------------------------------------------------
#analyticsengine_spark_adv_enabled: true
#analyticsengine_job_auto_delete_enabled: true
#analyticsengine_kernel_cull_time: 30
#analyticsengine_image_pull_parallelism: "40"
#analyticsengine_image_pull_completions: "20"
#analyticsengine_kernel_cleanup_schedule: "*/30 * * * *"
#analyticsengine_job_cleanup_schedule: "*/30 * * * *"
#analyticsengine_skip_selinux_relabeling: false
#analyticsengine_mount_customizations_from_cchome: false

# ------------------------------------------------------------------------------
# Spark runtime configuration parameters
# ------------------------------------------------------------------------------
#analyticsengine_max_driver_cpu_cores: 5          # The number of CPUs to allocate to the Spark jobs driver. The default is 5.  
#analyticsengine_max_executor_cpu_cores: 5        # The number of CPUs to allocate to the Spark jobs executor. The default is 5.
#analyticsengine_max_driver_memory: "50g"         # The amount of memory, in gigabytes to allocate to the driver. The default is 50g.
#analyticsengine_max_executor_memory: "50g"       # The amount of memory, in gigabytes to allocate to the executor. The default is 50g. 
#analyticsengine_max_num_workers: 50              # The number of workers (also called executors) to allocate to spark jobs. The default is 50.
#analyticsengine_local_dir_scale_factor: 10       # The number that is used to calculate the temporary disk size on Spark nodes. The formula is temp_disk_size = number_of_cpu * local_dir_scale_factor. The default is 10.

Analytics Engine powered by Apache Spark service configuration parameters

The service configuration parameters determine how the Analytics Engine powered by Apache Spark service behaves.

Property	Description
`analyticsengine_spark_adv_enabled`	Specify whether to display the job UI. Default value `true` Valid values `false` Do not display the job UI. `true` Display the job UI.
`analyticsengine_job_auto_delete_enabled`	Specify whether to automatically delete jobs after they reach a terminal state, such as `FINISHED` or `FAILED`. The default is true. Default value `true` Valid values `true` Delete jobs after they reach a terminal state. `false` Retain jobs after they reach a terminal state.
`analyticsengine_kernel_cull_time`	The amount of time, in minutes, idle kernels are kept. Default value `30` Valid values An integer greater than 0.
`analyticsengine_image_pull_parallelism`	The number of pods that are scheduled to pull the Spark image in parallel. For example, if you have 100 nodes in the cluster, set: `analyticsengine_image_pull_completions: "100"` `analyticsengine_image_pull_parallelism: "150"` In this example, at least 100 nodes will pull the image successfully with 150 pods pulling the image in parallel. Default value `"40"` Valid values An integer greater than or equal to 1. Increase this value only if you have a very large cluster and you have sufficient network bandwidth and disk I/O to support more pulls in parallel.
`analyticsengine_image_pull_completions`	The number of pods that should be completed in order for the image pull job to be completed. For example, if you have 100 nodes in the cluster, set: `analyticsengine_image_pull_completions: "100"` `analyticsengine_image_pull_parallelism: "150"` In this example, at least 100 nodes will pull the image successfully with 150 pods pulling the image in parallel. Default value `"20"` Valid values An integer greater than or equal to 1. Increase this value only if you have a very large cluster and you have sufficient network bandwidth and disk I/O to support more pulls in parallel.
`analyticsengine_kernel_cleanup_schedule`	Override the `analyticsengine_kernel_cull_time` setting for the kernel cleanup `CronJob`. By default, the kernel cleanup `CronJob` runs every 30 minutes. Default value `"/30 * * *"` Valid values A string that uses the `CronJob` schedule syntax.
`analyticsengine_job_cleanup_schedule`	Override the `analyticsengine_kernel_cull_time` setting for the job cleanup `CronJob`. By default, the job cleanup `CronJob` runs every 30 minutes. Default value `"/30 * * *"` Valid values A string that uses the `CronJob` schedule syntax.
`analyticsengine_skip_selinux_relabeling`	Specify whether to skip the SELinux relabeling. To use this feature, you must create the required `MachineConfig` and `RuntimeClass` definitions. For more information, see Enabling `MachineConfig` and `RuntimeClass` definitions for certain properties. Default value `false` Valid values `false` Do not skip the SELinux relabeling. `true` Skip the SELinux relabeling.
`analyticsengine_mount_customizations_from_cchome`	Specify whether to you want to enable custom drivers. These drivers need to be mounted from the cc-home-pvc directory. Common core services This feature is available only when the Cloud Pak for Data common core services are installed. Default value `false` Valid values `false` You do not want to use custom drivers. `true` You want to enable custom drivers.

Spark runtime configuration parameters

The runtime configuration parameters determine how the Spark runtimes generated by the Analytics Engine powered by Apache Spark service behave.

Property	Description
`analyticsengine_max_driver_cpu_cores`	The number of CPUs to allocate to the Spark jobs driver. Default value `5` Valid values An integer greater than or equal to 1.
`analyticsengine_max_executor_cpu_cores`	The number of CPUs to allocate to the Spark jobs executor. Default value `5` Valid values An integer greater than or equal to 1.
`analyticsengine_max_driver_memory`	The amount of memory, in gigabytes to allocate to the driver. Default value `"50g"` Valid values An integer greater than or equal to 1.
`analyticsengine_max_executor_memory`	The amount of memory, in gigabytes to allocate to the executor. Default value `"50g"` Valid values An integer greater than or equal to 1.
`analyticsengine_max_num_worker`	The number of workers (also called executors) to allocate to Spark jobs. Default value `50` Valid values An integer greater than or equal to 1.
`analyticsengine_local_dir_scale_factor`	The number that is used to calculate the temporary disk size on Spark nodes. The formula is: `temp_disk_size = number_of_cpu * local_dir_scale_factor` Default value `10` Valid values An integer greater than or equal to 1.

Data Replication parameters

If you plan to install Data Replication, you must specify the following installation option in a file named install-options.yml in the work directory.

The parameter is required.

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

################################################################################
# Data Replication parameters
################################################################################
replication_license_type: <license>

Parameter Description

Parameter	Description
`replication_license_type`	Specify the license that you purchased. Valid values: `IDRC` Specify this option if you purchased the IBM Data Replication Cartridge for IBM Cloud Pak for Data (L-MVQH-PRYPMJ). `IIDRC` Specify this option if you purchased the IBM InfoSphere Data Replication Cartridge for IBM Cloud Pak for Data (L-ABEV-TSNPF4). `IDRM` Specify this option if you purchased IBM Data Replication Modernization (L-LCRM-JMHEEA). `IIDRM` Specify this option if you purchased IBM InfoSphere Data Replication Modernization (L-QYFR-MBJXAV).

replication_license_type

Specify the license that you purchased.

Valid values:

IDRC: Specify this option if you purchased the IBM Data Replication Cartridge for IBM Cloud Pak for Data (L-MVQH-PRYPMJ).
IIDRC: Specify this option if you purchased the IBM InfoSphere Data Replication Cartridge for IBM Cloud Pak for Data (L-ABEV-TSNPF4).
IDRM: Specify this option if you purchased IBM Data Replication Modernization (L-LCRM-JMHEEA).
IIDRM: Specify this option if you purchased IBM InfoSphere Data Replication Modernization (L-QYFR-MBJXAV).

IBM Match 360 with Watson parameters

If you plan to install IBM Match 360 with Watson, you can specify the following installation options in a file named install-options.yml in the work directory.

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.

The sample YAML content uses the default values.

################################################################################
# IBM Match 360 with Watson parameters
################################################################################
#match360_scale_config: small
#match360_onboard_timeout: 300
#match360_ccs_http_timeout: 2000

Parameter Description

Parameter	Description
`match360_scale_config`	Specify the size of the service. Default value `small` Valid values `x-small` Restriction: This size is valid only for proof of concept and demonstration installations. `small` `medium` `large` For detailed information about each size, refer to the component scaling guidance PDF.
`match360_onboard_timeout`	The length of time, in seconds, before the onboarding process times out. If your cluster is slow, increase this setting. Default value `300` Valid values An integer greater than or equal to 1.
`match360_ccs_http_timeout`	The length of time, in seconds, before the connection to the Cloud Pak for Data common core services services times out. If your cluster is slow, increase this setting. Default value `2000` Valid values An integer greater than or equal to 1.

match360_scale_config

Specify the size of the service.

Default value

small

Valid values

x-small
Restriction: This size is valid only for proof of concept and demonstration installations.
small
medium
large

For detailed information about each size, refer to the component scaling guidance PDF.

match360_onboard_timeout

The length of time, in seconds, before the onboarding process times out.

If your cluster is slow, increase this setting.

Default value: 300
Valid values: An integer greater than or equal to 1.

match360_ccs_http_timeout

The length of time, in seconds, before the connection to the Cloud Pak for Data common core services services times out.

If your cluster is slow, increase this setting.

Default value: 2000
Valid values: An integer greater than or equal to 1.

Informix parameters

If you plan to install Informix, you can specify the following installation option in a file named install-options.yml in the work directory.

The parameter is optional. If you do not set this installation parameter, the default value is used. To override the default value, uncomment the parameter and update the value appropriately.

The sample YAML content uses the default values.

################################################################################
# Informix parameters
################################################################################
#informix_cp4d_edition: EE

Parameter	Description
`informix_cp4d_edition`	Specify the license that you purchased. Default value `EE` Valid values: `AEE` Specify this option if you purchased Advanced Enterprise Edition. `EE` Specify this option if you purchased Enterprise Edition. `WE` Specify this option if you purchased Workgroup Edition.

Voice Gateway parameters

If you plan to install Voice Gateway, you can specify the following installation options in a file named install-options.yml in the work directory.

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.

The sample YAML content uses the default values.

################################################################################
# Voice Gateway parameters
################################################################################
voice_gateway_spec:
#
# ------------------------------------------------------------------------------
# Node selector parameters
# ------------------------------------------------------------------------------
#  nodeSelector:
#    key1: value
#    key2: value
# ------------------------------------------------------------------------------
# Toleration parameters
# ------------------------------------------------------------------------------
#  tolerations:
#  - key: "key-name" 
#    operator: "operator" 
#    value: "value" 
#    effect: "effect" 
# ------------------------------------------------------------------------------
# SSL configuration parameters
# ------------------------------------------------------------------------------
#  sslConfig:
#    disableSslCertValidation: false
#    mediaRelay:
#      enableSsl: false
#      sslClientCACertSecret: client-ca-cert-secret
#      enableMutualAuth: false
#      sslClientPkcs12FileSecret: ssl-client-pkcs12-file-secret
#      sslClientPassphraseSecret: ssl-client-passphrase-secret
#    sipOrchestrator:
#      enableSslorMutualAuth: false
#      sslKeyTrustStoreSecret: trust-store-file-secret
#      sslFileType: "JKS"
#      sslPassphraseSecret: ssl-passphrase-secret
# ------------------------------------------------------------------------------
# Port parameters
# ------------------------------------------------------------------------------
#  ports:
#    sipSignalingPortUdp: 5060
#    sipSignalingPortTcp: 5060
#    sipSignalingPortTls: 5061
#    sipOrchestratorHttpPort: 9086
#    sipOrchestratorHttpsPort: 9446
#    mediaRelayWsPort: 8080
#    rtpUdpPortRange: "16384-16394"
# ------------------------------------------------------------------------------
# Environment variable parameters
# ------------------------------------------------------------------------------
#  env:
#    sipOrchestrator:
#      - name: variable-name
#        value: "value"
#    mediaRelay:
#      - name: variable-name
#        value: "value"
# ------------------------------------------------------------------------------
# Storage parameters
# ------------------------------------------------------------------------------
#  storage:
#    recordings:
#      enablePersistentRecordings: false
#      storageClassName: ""
#      size: 15Gi
#    logs:
#      enablePersistentLogs: false
#      storageClassName: ""
#      size: 10Gi
# ------------------------------------------------------------------------------
# Container resource parameters
# ------------------------------------------------------------------------------
#  resources:
#    sipOrchestrator:
#      requests:
#        cpu: "1.0"
#        memory: 1Gi
#      limits:
#        cpu: "2.0"
#        memory: 2Gi
#    mediaRelay:
#      requests:
#        cpu: "1"
#        memory: 1Gi
#      limits:
#        cpu: "4"
#        memory: 4Gi
#    g729Codec:
#      requests:
#        cpu: "0.5"
#        memory: 0.5Gi
#      limits:
#        cpu: "1"
#        memory: 1Gi
# ------------------------------------------------------------------------------
# G729 Codec Service parameters
# ------------------------------------------------------------------------------
#  g729Codec:
#    enabled: false
#    logLevel: "INFO"
#    webSocketServerPort: 9001
# ------------------------------------------------------------------------------
# Media Resource Control Protocol parameters
# ------------------------------------------------------------------------------
#  mrcp:
#    enableMrcp: false
#    unimrcpConfigSecretName: unimrcp-config-secret
#    mrcpv2SipPort: 5555

Node selector parameters

Parameter Description

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>`

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

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>"`

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 Watson Assistant SSL connections to Watson 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

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>"`

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

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`

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>`

Watson Assistant parameters

If you plan to install Watson Assistant, you can specify the following installation options in a file named install-options.yml in the work directory.

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.

The sample YAML content uses the default values.

################################################################################
# Watson Assistant parameters
################################################################################
#watson_assistant_size: Production
#watson_assistant_bigpv: false
#watson_assistant_analytics_enabled: true

Property Description

Property	Description
`watson_assistant_size`	The deployment size for Watson Assistant. The deployment size determines the number of resources allocated to Watson Assistant. Default value `Production` Valid values `Production` A production deployment has at least two replicas of each pod to support production-scale workloads. `Starter` A starter deployment has fewer resources and less computing power than a production deployment.
`watson_assistant_bigpv`	Specify whether to create larger physical volumes to improve IOPS performance. Create larger physical volumes if your storage class IOPS performance depends on the size of the physical volume. You do not need to create larger physical volumes if you use the following storage: Red Hat OpenShift Data Foundation IBM Storage Fusion Data Foundation IBM Storage Fusion Global Data Platform IBM Storage Scale Container Native Portworx IBM Cloud Block Storage Default value `false` Valid values `false` Create physical volumes with the default size. `true` Create larger physical volumes to improve IOPS performance.
`watson_assistant_analytics_enabled`	Specify whether to store chat logs and analytics. Default value `true` Valid values `false` Do not store chat logs and analytics. `true` Store chat logs and analytics.

watson_assistant_size

The deployment size for Watson Assistant.

The deployment size determines the number of resources allocated to Watson Assistant.

Default value

Production

Valid values

Production: A production deployment has at least two replicas of each pod to support production-scale workloads.
Starter: A starter deployment has fewer resources and less computing power than a production deployment.

watson_assistant_bigpv

Specify whether to create larger physical volumes to improve IOPS performance.

Create larger physical volumes if your storage class IOPS performance depends on the size of the physical volume.

You do not need to create larger physical volumes if you use the following storage:

Red Hat OpenShift Data Foundation
IBM Storage Fusion Data Foundation
IBM Storage Fusion Global Data Platform
IBM Storage Scale Container Native
Portworx
IBM Cloud Block Storage

Default value

false

Valid values

false: Create physical volumes with the default size.
true: Create larger physical volumes to improve IOPS performance.

watson_assistant_analytics_enabled

Specify whether to store chat logs and analytics.

Default value

true

Valid values

false: Do not store chat logs and analytics.
true: Store chat logs and analytics.

Watson Discovery parameters

If you plan to install Watson Discovery, you can specify the following installation option in a file named install-options.yml in the work directory.

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

The sample YAML content uses the default value.

################################################################################
# Watson Discovery parameters
################################################################################
#discovery_deployment_type: Production

Property Description

Property	Description
`discovery_deployment_type`	The deployment type for Watson Discovery. The deployment type determines the number of resources allocated to Watson Discovery. Default value `Production` Valid values `Production` A production deployment has at least two replicas of each pod to support production-scale workloads. `Starter` A starter deployment has fewer resources and less computing power than a production deployment. In previous releases, this deployment type was called the `development` deployment type.

discovery_deployment_type

The deployment type for Watson Discovery.

The deployment type determines the number of resources allocated to Watson Discovery.

Default value

Production

Valid values

Production: A production deployment has at least two replicas of each pod to support production-scale workloads.
Starter: A starter deployment has fewer resources and less computing power than a production deployment.
In previous releases, this deployment type was called the development deployment type.

Watson Knowledge Catalog parameters

If you plan to install Watson Knowledge Catalog, you can specify the following installation options in a file named install-options.yml in the work directory.

Restriction: If you purchased the Data Governance Express® license, you cannot specify these installation options.

These installation options are available only with IBM Cloud Pak for Data Enterprise Edition of IBM Cloud Pak for Data Standard Edition.

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.

The sample YAML content uses the default values.

################################################################################
# Watson Knowledge Catalog parameters
################################################################################
custom_spec:
  wkc:
#    enableKnowledgeGraph: False
#    enableDataQuality: False       
#    enableMANTA: False

Property	Description
`enableKnowledgeGraph`	Specify whether to enable the knowledge graph feature, which provides lineage and semantic search capabilities. Default value `False` Valid values `False` Do not enable the knowledge graph feature. `True` Enable the knowledge graph feature.
`enableDataQuality`	Specify whether to enable data quality features in projects. Default value `False` Valid values `False` Do not enable the data quality feature. `True` Enable the data quality feature. Important: If you enable this feature, DataStage, specifically DataStage Enterprise is automatically installed.
`enableMANTA`	Specify whether to enable advanced metadata import through MANTA Automated Data Lineage. Important: Starting in Cloud Pak for Data Version 4.7.3, MANTA Automated Data Lineage is a separately installed service. For more information, see MANTA Automated Data Lineage. Default value `False` Valid values `False` Do not enable advanced metadata import. `True` Enable advanced metadata import.

Watson Speech services parameters

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 work directory.

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.

The sample YAML content uses the default values.

################################################################################
# Watson Speech services parameters
################################################################################

# ------------------------------------------------------------------------------
# Watson Speech to Text parameters
# ------------------------------------------------------------------------------
#watson_speech_enable_stt_async: false
#watson_speech_enable_stt_customization: false
#watson_speech_enable_stt_runtime: true
#watson_speech_stt_scale_config: xsmall

# ------------------------------------------------------------------------------
# Watson Text to Speech parameters
# ------------------------------------------------------------------------------
#watson_speech_enable_tts_customization: false
#watson_speech_enable_tts_runtime: true
#watson_speech_tts_scale_config: xsmall

# ------------------------------------------------------------------------------
# Watson Speech to Text models
# ------------------------------------------------------------------------------
#watson_speech_models: ["enUsBroadbandModel","enUsNarrowbandModel","enUsShortFormNarrowbandModel","enUsTelephony","enUsMultimedia"]

# ------------------------------------------------------------------------------
# Watson Text to Speech enhanced neural voices
# ------------------------------------------------------------------------------
#watson_speech_voices: ["enUSAllisonV3Voice","enUSLisaV3Voice","enUSMichaelV3Voice"]

Watson Speech to Text parameters

The following options apply only if you install the Watson Speech to Text service.

Property	Description
`watson_speech_enable_stt_async`	Specify whether to enable asynchronous HTTP requests. For example, enable this feature if you have large requests that you want to process asynchronously. Default value `false` Valid values `false` Do not enable asynchronous HTTP requests. `true` Enable asynchronous HTTP requests. When you set this property to `true`, it enables the `/v1/recognitions` interface.
`watson_speech_enable_stt_customization`	Specify whether to enable Watson Speech to Text customizations: Language model customization, which enables the service to more accurately recognize domain-specific terms. Acoustic model customization, which enables the service to adapt to environmental noise, audio quality, and the accent or cadence of the speakers. Default value `false` Valid values `false` Do not enable Watson Speech to Text customizations. `true` Enable Watson Speech to Text customizations. When you set this property to `true`, it enables the following interfaces: `/v1/customizations` for language model customization. `/v1/acoustic_customizations` for acoustic model customization.
`watson_speech_enable_stt_runtime`	Specify whether to enable the microservice for speech recognition. You must enable this microservice if you install the Watson Speech to Text service. Default value `true` Valid values `false` Do not enable the microservice for speech recognition. Important: This microservice is automatically enabled if you set either of the following properties to `true`: `watson_speech_enable_stt_customization` `watson_speech_enable_stt_async` `true` Enable the microservice for speech recognition. When you set this property to `true`, it enables the `/v1/recognize` interface.
`watson_speech_stt_scale_config`	Specify the size of the service. Default value `xsmall` Valid values `xsmall` `small` `medium` `large` `custom` For detailed information about each size, refer to the component scaling guidance PDF.

Watson Text to Speech parameters

The following options apply only if you install the Watson Text to Speech service.

Property Description

Property	Description
`watson_speech_enable_tts_customization`	Specify whether to enable Watson Text to Speech customizations, which enables the service to create a dictionary of words and their translations for a specific language. Default value `false` Valid values `false` Do not enable Watson Text to Speech customizations. `true` Enable Watson Text to Speech customizations. When you set this property to `true`, it enables the `/v1/customizations` interface for customization.
`watson_speech_enable_tts_runtime`	Specify whether to enable the microservice for speech synthesis. You must enable this microservice if you install the Watson Text to Speech service. Default value `true` Valid values `false` Do not enable the microservice for speech synthesis. Important: This microservice is automatically enabled if you set `watson_speech_enable_tts_customization` to `true`. `true` Enable the microservice for speech synthesis. When you set this property to `true`, it enables the `/v1/synthesize` interface.
`watson_speech_tts_scale_config`	Specify the size of the service. Default value `xsmall` Valid values `xsmall` `small` `medium` `large` `custom` For detailed information about each size, refer to the component scaling guidance PDF.

watson_speech_enable_tts_customization

Specify whether to enable Watson Text to Speech customizations, which enables the service to create a dictionary of words and their translations for a specific language.

Default value

false

Valid values

false: Do not enable Watson Text to Speech customizations.
true: Enable Watson Text to Speech customizations.
When you set this property to true, it enables the /v1/customizations interface for customization.

watson_speech_enable_tts_runtime

Specify whether to enable the microservice for speech synthesis. You must enable this microservice if you install the Watson Text to Speech service.

Default value: true

Valid values

false: Do not enable the microservice for speech synthesis.
Important: This microservice is automatically enabled if you set watson_speech_enable_tts_customization to true.
true: Enable the microservice for speech synthesis.
When you set this property to true, it enables the /v1/synthesize interface.

watson_speech_tts_scale_config

Specify the size of the service.

Default value

xsmall

Valid values

xsmall
small
medium
large
custom

For detailed information about each size, refer to the component scaling guidance PDF.

Watson Speech to Text models

The following options apply only if you install the Watson Speech to Text service.

Property Description

Property	Description
`watson_speech_models`	Specify which Watson Speech to Text models are installed. Specify the models as a comma-separated array. For example: `["enUsBroadbandModel","enUsNarrowbandModel","enUsShortFormNarrowbandModel",...]` Default value By default, the following models are installed: `enUsBroadbandModel` (US English (en-US) Broadband model) `enUsNarrowbandModel`(US English (en-US) Narrowband model) `enUsShortFormNarrowbandModel` (US English (en-US) Short-Form Narrowband model) `enUsMultimedia` (US English (en-US) Multimedia model) `enUsTelephony` (US English (en-US) Telephony model ) Valid Values Previous- generation models `enUsBroadbandModel` (US English (en-US) Broadband model) `enUsNarrowbandModel`(US English (en-US) Narrowband model) `enUsShortFormNarrowbandModel` (US English (en-US) Short-Form Narrowband model) `arMsBroadbandModel` (Modern Standard Arabic (ar-MS) Broadband model) `deDeBroadbandModel` (German (de-DE) Broadband model) `deDeNarrowbandModel` (German (de-DE) Narrowband model) `enAuBroadbandModel` (Australian English (en-AU) Broadband model) `enAuNarrowbandModel` (Australian English (en-AU) Narrowband model) `enGbBroadbandModel` (UK English (en-GB) Broadband model) `enGbNarrowbandModel` (UK English (en-GB) Narrowband model) `esEsBroadbandModel` (Castilian Spanish (es-ES, es-AR, es-CL, es-CO, es-MX, and es-PE) Broadband models) `esEsNarrowbandModel` (Castilian Spanish (es-ES, es-AR, es-CL, es-CO, es-MX, and es-PE) Narrowband models) `frCaBroadbandModel` (Canadian French (fr-CA) Broadband model) `frCaNarrowbandModel` (Canadian French (fr-CA) Narrowband model) `frFrBroadbandModel` (French (fr-FR) Broadband model) `frFrNarrowbandModel` (French (fr-FR) Narrowband model) `itItBroadbandModel` (Italian (it-IT) Broadband model) `itItNarrowbandModel` (Italian (it-IT) Narrowband model) `jaJpBroadbandModel` (Japanese (ja-JP) Broadband model) `jaJpNarrowbandModel` (Japanese (ja-JP) Narrowband model) `koKrBroadbandModel` (Korean (ko-KR) Broadband model) `koKrNarrowbandModel` (Korean (ko-KR) Narrowband model) `nlNlBroadbandModel` (Dutch (nl-NL) Broadband model) `nlNlNarrowbandModel` (Dutch (nl-NL) Narrowband model) `ptBrBroadbandModel` (Brazilian Portuguese (pt-BR) Broadband model) `ptBrNarrowbandModel` (Brazilian Portuguese (pt-BR) Narrowband model) `zhCnBroadbandModel` (Mandarin Chinese (zh-CN) Broadband model) `zhCnNarrowbandModel` (Mandarin Chinese (zh-CN) Narrowband model) Next-generation models `enUsMultimedia` (US English (en-US) Multimedia model) `enUsTelephony` (US English (en-US) Telephony model ) `arMsTelephony` (Modern Standard Arabic (ar-MS) Telephony model) `csCZTelephony` (Czech (cs-CZ) Telephony model) `deDeMultimedia` (German (de-DE) Multimedia model) `deDeTelephony` (German (de-DE) Telephony model) `enAuMultimedia` (Australian English (en-AU) Multimedia model) `enAuTelephony` (Australian English (en-AU) Telephony model) `enGbMultimedia` (UK English (en-GB) Multimedia model) `enGbTelephony` (UK English (en-GB) Telephony model) `enInTelephony` (Indian English (en-IN) Telephony model) `enWwMedicalTelephony` (English (all supported dialects) Medical Telephony model) `esEsMultimedia` (Castilian Spanish (es-ES) Multimedia model) `esEsTelephony` (Castilian Spanish (es-ES) Telephony model) `esLaTelephony` (Latin American Spanish (es-LA) Telephony model) `frCaMultimedia` (Canadian French (fr-CA) Multimedia model) `frCaTelephony` (Canadian French (fr-CA) Telephony model) `frFrMultimedia` (French (fr-FR) Multimedia model) `frFrTelephony` (French (fr-FR) Telephony model) `hiInTelephony` (Indian Hindi (hi-IN) Telephony model) `itItMultimedia` (Italian (it-IT) Multimedia model) `itItTelephony` (Italian (it-IT) Telephony model) `jaJpMultimedia` (Japanese (ja-JP) Multimedia model) `jaJpTelephony` (Japanese (ja-JP) Telephony model) `koKrMultimedia` (Korean (ko-KR) Multimedia model) `koKrTelephony` (Korean (ko-KR) Telephony model) `nlBeTelephony` (Belgian Dutch (nl-BE) Telephony model) `nlNlMultimedia` (Netherlands Dutch (nl-NL) Multimedia model) `nlNlTelephony` (Netherlands Dutch (nl-NL) Telephony model) `ptBrMultimedia` (Brazilian Portuguese (pt-BR) Multimedia model) `ptBrTelephony` (Brazilian Portuguese (pt-BR) Telephony model) `svSeTelephony` (Swedish (sv-SE) Telephony model) `zhCnTelephony` (Mandarin Chinese (zh-CN) Telephony model)

watson_speech_models

Specify which Watson Speech to Text models are installed.

Specify the models as a comma-separated array. For example:

["enUsBroadbandModel","enUsNarrowbandModel","enUsShortFormNarrowbandModel",...]

Default value

By default, the following models are installed:

enUsBroadbandModel (US English (en-US) Broadband model)
enUsNarrowbandModel(US English (en-US) Narrowband model)
enUsShortFormNarrowbandModel (US English (en-US) Short-Form Narrowband model)
enUsMultimedia (US English (en-US) Multimedia model)
enUsTelephony (US English (en-US) Telephony model )

Valid Values

Previous- generation models

enUsBroadbandModel (US English (en-US) Broadband model)
enUsNarrowbandModel(US English (en-US) Narrowband model)
enUsShortFormNarrowbandModel (US English (en-US) Short-Form Narrowband model)
arMsBroadbandModel (Modern Standard Arabic (ar-MS) Broadband model)
deDeBroadbandModel (German (de-DE) Broadband model)
deDeNarrowbandModel (German (de-DE) Narrowband model)
enAuBroadbandModel (Australian English (en-AU) Broadband model)
enAuNarrowbandModel (Australian English (en-AU) Narrowband model)
enGbBroadbandModel (UK English (en-GB) Broadband model)
enGbNarrowbandModel (UK English (en-GB) Narrowband model)
esEsBroadbandModel (Castilian Spanish (es-ES, es-AR, es-CL, es-CO, es-MX, and es-PE) Broadband models)
esEsNarrowbandModel (Castilian Spanish (es-ES, es-AR, es-CL, es-CO, es-MX, and es-PE) Narrowband models)
frCaBroadbandModel (Canadian French (fr-CA) Broadband model)
frCaNarrowbandModel (Canadian French (fr-CA) Narrowband model)
frFrBroadbandModel (French (fr-FR) Broadband model)
frFrNarrowbandModel (French (fr-FR) Narrowband model)
itItBroadbandModel (Italian (it-IT) Broadband model)
itItNarrowbandModel (Italian (it-IT) Narrowband model)
jaJpBroadbandModel (Japanese (ja-JP) Broadband model)
jaJpNarrowbandModel (Japanese (ja-JP) Narrowband model)
koKrBroadbandModel (Korean (ko-KR) Broadband model)
koKrNarrowbandModel (Korean (ko-KR) Narrowband model)
nlNlBroadbandModel (Dutch (nl-NL) Broadband model)
nlNlNarrowbandModel (Dutch (nl-NL) Narrowband model)
ptBrBroadbandModel (Brazilian Portuguese (pt-BR) Broadband model)
ptBrNarrowbandModel (Brazilian Portuguese (pt-BR) Narrowband model)
zhCnBroadbandModel (Mandarin Chinese (zh-CN) Broadband model)
zhCnNarrowbandModel (Mandarin Chinese (zh-CN) Narrowband model)

Next-generation models

enUsMultimedia (US English (en-US) Multimedia model)
enUsTelephony (US English (en-US) Telephony model )
arMsTelephony (Modern Standard Arabic (ar-MS) Telephony model)
csCZTelephony (Czech (cs-CZ) Telephony model)
deDeMultimedia (German (de-DE) Multimedia model)
deDeTelephony (German (de-DE) Telephony model)
enAuMultimedia (Australian English (en-AU) Multimedia model)
enAuTelephony (Australian English (en-AU) Telephony model)
enGbMultimedia (UK English (en-GB) Multimedia model)
enGbTelephony (UK English (en-GB) Telephony model)
enInTelephony (Indian English (en-IN) Telephony model)
enWwMedicalTelephony (English (all supported dialects) Medical Telephony model)
esEsMultimedia (Castilian Spanish (es-ES) Multimedia model)
esEsTelephony (Castilian Spanish (es-ES) Telephony model)
esLaTelephony (Latin American Spanish (es-LA) Telephony model)
frCaMultimedia (Canadian French (fr-CA) Multimedia model)
frCaTelephony (Canadian French (fr-CA) Telephony model)
frFrMultimedia (French (fr-FR) Multimedia model)
frFrTelephony (French (fr-FR) Telephony model)
hiInTelephony (Indian Hindi (hi-IN) Telephony model)
itItMultimedia (Italian (it-IT) Multimedia model)
itItTelephony (Italian (it-IT) Telephony model)
jaJpMultimedia (Japanese (ja-JP) Multimedia model)
jaJpTelephony (Japanese (ja-JP) Telephony model)
koKrMultimedia (Korean (ko-KR) Multimedia model)
koKrTelephony (Korean (ko-KR) Telephony model)
nlBeTelephony (Belgian Dutch (nl-BE) Telephony model)
nlNlMultimedia (Netherlands Dutch (nl-NL) Multimedia model)
nlNlTelephony (Netherlands Dutch (nl-NL) Telephony model)
ptBrMultimedia (Brazilian Portuguese (pt-BR) Multimedia model)
ptBrTelephony (Brazilian Portuguese (pt-BR) Telephony model)
svSeTelephony (Swedish (sv-SE) Telephony model)
zhCnTelephony (Mandarin Chinese (zh-CN) Telephony model)

Watson Text to Speech voices

The following options apply only if you install the Watson Text to Speech service.

Property Description

Property	Description
`watson_speech_voices`	Specify which Watson Text to Speech voices are installed. Specify the voices as a comma-separated array. For example: `["enUSAllisonV3Voice","enUSLisaV3Voice","enUSMichaelV3Voice",...]` Default value By default, the following voices are installed: `enUSAllisonV3Voice` (US English (en-US) Allison enhanced neural voice) `enUSLisaV3Voice` (US English (en-US) Lisa enhanced neural voice) `enUSMichaelV3Voice` (US English (en-US) Michael enhanced neural voice) Valid Values Enhanced neural voices `enUSAllisonV3Voice` (US English (en-US) Allison enhanced neural voice) `enUSLisaV3Voice` (US English (en-US) Lisa enhanced neural voice) `enUSMichaelV3Voice` (US English (en-US) Michael enhanced neural voice) `enUSEmilyV3Voice` (US English (en-US) Emily enhanced neural voice) `enUSHenryV3Voice` (US English (en-US) Henry enhanced neural voice) `enUSKevinV3Voice` (US English (en-US) Kevin enhanced neural voice) `enUSOliviaV3Voice` (US English (en-US) Olivia enhanced neural voice) `deDEBirgitV3Voice` (German (de-DE) Birgit enhanced neural voice) `deDEDieterV3Voice` (German (de-DE) Dieter enhanced neural voice) `deDEErikaV3Voice` (German (de-DE) Erika enhanced neural voice) `enGBCharlotteV3Voice` (UK English (en-GB) Charlotte enhanced neural voice) `enGBJamesV3Voice` (UK English (en-GB) James enhanced neural voice) `enGBKateV3Voice` (UK English (en-GB) Kate enhanced neural voice) `esESEnriqueV3Voice` (Castilian Spanish (es-ES) Enrique enhanced neural voice) `esESLauraV3Voice` (Castilian Spanish (es-ES) Laura enhanced neural voice) `esLASofiaV3Voice` (Latin American Spanish (es-LA) Sofia enhanced neural voice) `esUSSofiaV3Voice` (North American Spanish (es-US) Sofia enhanced neural voice) `frCALouiseV3Voice` (French Canadian (fr-CA) Louise enhanced neural voice) `frFRNicolasV3Voice` (French (fr-FR) Nicolas enhanced neural voice) `frFRReneeV3Voice` (French (fr-FR) Renee enhanced neural voice ) `itITFrancescaV3Voice` (Italian (it-IT) Francesca enhanced neural voice) `jaJPEmiV3Voice` (Japanese (ja-JP) Emi enhanced neural voice) `koKRJinV3Voice` (Korean (ko-KR) Jin enhanced neural voice) `nlNLMerelV3Voice` (Netherlands Dutch (nl-NL) Merel enhanced neural voice) `ptBRIsabelaV3Voice` (Brazilian Portuguese (pt-BR) Isabela enhanced neural voice) Expressive neural voices `enAUHeidiExpressive` (Australian English (en-AU) Heidi expressive neural voice) `enAUJackExpressive` (Australian English (en-AU) Jack expressive neural voice) `enUSAllisonExpressive` (US English (en-US) Allison expressive neural voice) `enUSEmmaExpressive` (US English (en-US) Emma expressive neural voice) `enUSLisaExpressive` (US English (en-US) Lisa expressive neural voice) `enUSMichaelExpressive` (US English (en-US) Michael expressive neural voice)

watson_speech_voices

Specify which Watson Text to Speech voices are installed.

Specify the voices as a comma-separated array. For example:

["enUSAllisonV3Voice","enUSLisaV3Voice","enUSMichaelV3Voice",...]

Default value

By default, the following voices are installed:

enUSAllisonV3Voice (US English (en-US) Allison enhanced neural voice)
enUSLisaV3Voice (US English (en-US) Lisa enhanced neural voice)
enUSMichaelV3Voice (US English (en-US) Michael enhanced neural voice)

Valid Values

Enhanced neural voices

enUSAllisonV3Voice (US English (en-US) Allison enhanced neural voice)
enUSLisaV3Voice (US English (en-US) Lisa enhanced neural voice)
enUSMichaelV3Voice (US English (en-US) Michael enhanced neural voice)
enUSEmilyV3Voice (US English (en-US) Emily enhanced neural voice)
enUSHenryV3Voice (US English (en-US) Henry enhanced neural voice)
enUSKevinV3Voice (US English (en-US) Kevin enhanced neural voice)
enUSOliviaV3Voice (US English (en-US) Olivia enhanced neural voice)
deDEBirgitV3Voice (German (de-DE) Birgit enhanced neural voice)
deDEDieterV3Voice (German (de-DE) Dieter enhanced neural voice)
deDEErikaV3Voice (German (de-DE) Erika enhanced neural voice)
enGBCharlotteV3Voice (UK English (en-GB) Charlotte enhanced neural voice)
enGBJamesV3Voice (UK English (en-GB) James enhanced neural voice)
enGBKateV3Voice (UK English (en-GB) Kate enhanced neural voice)
esESEnriqueV3Voice (Castilian Spanish (es-ES) Enrique enhanced neural voice)
esESLauraV3Voice (Castilian Spanish (es-ES) Laura enhanced neural voice)
esLASofiaV3Voice (Latin American Spanish (es-LA) Sofia enhanced neural voice)
esUSSofiaV3Voice (North American Spanish (es-US) Sofia enhanced neural voice)
frCALouiseV3Voice (French Canadian (fr-CA) Louise enhanced neural voice)
frFRNicolasV3Voice (French (fr-FR) Nicolas enhanced neural voice)
frFRReneeV3Voice (French (fr-FR) Renee enhanced neural voice )
itITFrancescaV3Voice (Italian (it-IT) Francesca enhanced neural voice)
jaJPEmiV3Voice (Japanese (ja-JP) Emi enhanced neural voice)
koKRJinV3Voice (Korean (ko-KR) Jin enhanced neural voice)
nlNLMerelV3Voice (Netherlands Dutch (nl-NL) Merel enhanced neural voice)
ptBRIsabelaV3Voice (Brazilian Portuguese (pt-BR) Isabela enhanced neural voice)

Expressive neural voices

enAUHeidiExpressive (Australian English (en-AU) Heidi expressive neural voice)
enAUJackExpressive (Australian English (en-AU) Jack expressive neural voice)
enUSAllisonExpressive (US English (en-US) Allison expressive neural voice)
enUSEmmaExpressive (US English (en-US) Emma expressive neural voice)
enUSLisaExpressive (US English (en-US) Lisa expressive neural voice)
enUSMichaelExpressive (US English (en-US) Michael expressive neural voice)

What to do next

Now that you've specified installation options for services, you're ready to complete Installing IBM Cloud Pak for Data.