UMS data source parameters

Provide appropriate values for the User Management Service (UMS) data source configuration parameters. These are specified in the section dc_ums_datasource.

Most UMS data source configuration parameters are optional, the following parameters are required:

datasource_configuration.dc_ums_datasource.dc_ums_oauth_type
If the OAuth database type is db2 or oracle then the following parameters are also required:
- datasource_configuration.dc_ums_datasource.dc_ums_oauth_host
- datasource_configuration.dc_ums_datasource.dc_ums_oauth_port
- datasource_configuration.dc_ums_datasource.dc_ums_oauth_name
datasource_configuration.dc_ums_datasource.dc_ums_teamserver_type
If the teams database type is db2 then the following parameters are also required:
- datasource_configuration.dc_ums_datasource.dc_ums_teamserver_host
- datasource_configuration.dc_ums_datasource.dc_ums_teamserver_port
- datasource_configuration.dc_ums_datasource.dc_ums_teamserver_name

Table 1. UMS data source configuration parameters for the `datasource_configuration.dc_ums_datasource` section
Parameter	Description	Default/Example values	Required
`dc_ums_oauth_type`	The type of OAuth database. Important: Derby can only be used for test scenarios. It will not work in scenarios with more than one UMS pod. All data is lost when the pod is restarted.	`derby` `db2` `oracle` `sqlserver` `postgresql`	Yes
`dc_ums_oauth_host`	The host name of the OAuth database. It must be an accessible address, such as an IP, hostname, or Kubernetes service name.		If the OAuth database is `db2` or `oracle`.
`dc_ums_oauth_port`	The OAuth database port number.	`50000`	If the OAuth database is `db2` or `oracle`.
`dc_ums_oauth_name`	The name of the OAuth database.	`UMSDB`
`dc_ums_oauth_schema`	For Oracle databases, the schema name must be the user name of the database.		Can be specified if a schema was created.
`dc_ums_oauth_oracle_service_name`	If you connect to an Oracle Real Application Clusters (RAC) environment using Single Client Access Name (SCAN), configure the database service name in addition to the name of the Oauth database.		If you connect to an Oracle Real Application Clusters (RAC) environment using Single Client Access Name (SCAN).
`dc_ums_oauth_ssl`	Specify `true` if SSL will be used to secure the OAuth database connection.	The default value is `false`	If SSL will be used to secure the OAuth database connection.
`dc_ums_oauth_ssl_secret_name`	The name of the SSL secret.	`ibm-dba-ums-db2-cacert`	If SSL will be used to secure the OAuth database connection.
`dc_ums_oauth_driverfiles`	If you are using a database of type other than Db2® or derby, copy the driver files to the connected persistent volume (PV). Use the property `spec.ums_configuration.existing_claim_name` to point to the PV claim. During the deployment Operator picks up the driver files and configures the connection to the database	`db2jcc4.jar db2jcc_license_cu.jar`. Note: Db2 driver files are loaded automatically, only provide Oracle driver files if you are using Oracle.	If you are using a database of type other than Db2 or derby.
`dc_ums_oauth_alternate_hosts`	Only specify alternate OAuth database hosts if the OAuth database type is set to `db2HADR`.		If the OAuth database type is set to `db2HADR`.
`dc_ums_oauth_alternate_ports`	Only specify alternate OAuth database ports if the OAuth database type is set to `db2HADR`.		If the OAuth database type is set to `db2HADR`.
`dc_ums_teamserver_type`	The type of UMS Teams database. Important: Derby can only be used for test scenarios. It will not work in scenarios with more than one UMS pod. All data is lost when the pod is restarted.	`derby` `db2` `oracle` `sqlserver` `postgresql`	Yes
`dc_ums_teamserver_host`	The host name of the UMS Teams `db2` database.		If the UMS Teams database is `db2`.
`dc_ums_teamserver_port`	The UMS Teams `db2` database port.	`50000`	If the UMS Teams database is `db2`.
`dc_ums_teamserver_name`	The name of the UMS Teams database.	`UMSTEAMSDB`	If the UMS Teams database is `db2`.
`dc_ums_teamserver_schema`	Can be specified if a schema was created. For Oracle databases, the schema name must be the user name of the database.		Can be specified if a schema was created.
`dc_ums_teamserver_oracle_service_name`	If you connect to an Oracle Real Application Clusters (RAC) environment using Single Client Access Name (SCAN), configure the database service name in addition to the name of the UMS Teams database.		If you connect to an Oracle Real Application Clusters (RAC) environment using Single Client Access Name (SCAN).
`dc_ums_teamserver_ssl`	Specify `true` if SSL is be used to secure the UMS Teams database connection.	The default value is `false.`	If SSL is used to secure the UMS Teams database connection.
`dc_ums_teamserver_ssl_secret_name`	If SSL is used to secure the UMS Teams database connection, specify the name of the SSL secret.	`ibm-dba-ums-db2-cacert`	If SSL is used to secure the UMS Teams database connection.
`dc_ums_teamserver_driverfiles`	During the deployment Operator picks up the driver files and configures the connection to the UMS Teams database	`db2jcc4.jar db2jcc_license_cu.jar`.	No
`dc_ums_teamserver_alternate_hosts`	Only specify alternate UMS Teams database hosts if the UMS Teams database type is set to `db2HADR`.		If the UMS Teams database type is set to `db2HADR`
`dc_ums_teamserver_alternate_ports`	Only specify alternate UMS Teams database ports if the UMS Teams database type is set to `db2HADR`.		If the UMS Teams database type is set to `db2HADR`