IBM Business Automation Studio parameters

 New in 19.0.2  Provide the details that are relevant to your IBM Business Automation Studio environment and your decisions for the deployment of the container.

The following tables list the configurable parameters and their default values. All properties are required, unless they have a default value or are explicitly optional. Although Business Automation Studio might seem to install correctly when some parameters are omitted, this kind of configuration is not supported.

All the configuration options under application_engine_configuration[*] defined in the App Engine configuration parameters can be used under bastudio_configuration.playback_server in the App Engine playback server; however, the App Engine playback server can only be one instance. For example, application_engine_configuration[*].hostname maps to bastudio_configuration.playback_server.hostname.

Table 1.  New in 19.0.3  Business Automation Studio parameters
Parameter Description Default Value
bastudio_configuration.admin_secret_name Business Automation Studio administrative secret for sensitive configuration data  
bastudio_configuration.hostname Business Automation Studio external hostname  
bastudio_configuration.port Business Automation Studio port  
bastudio_configuration.ums_disable_cn_check Whether to disable the check for the User Management Service (UMS) Certificate Common Name false
bastudio_configuration.external_tls_secret The secret that contains the Transport Layer Security (TLS) key and certificate for external https visits. You can enter the secret name here. If you don't want to use the customized external TLS certificate, leave it empty.  
bastudio_configuration.external_tls_ca_secret Certificate authority (CA) used to sign the external TLS secret. It is stored in the secret with the TLS key and certificate. You can enter the secret name here. If you don't want to use the customized CA to sign the external TLS certificate, leave it empty.  
bastudio_configuration.tls.tls_trust_list Existing TLS trust secret []
bastudio_configuration.database.host Business Automation Studio database host  
bastudio_configuration.database.port Business Automation Studio database port  
bastudio_configuration.database.name Business Automation Studio database name. The database that is provided must be created by the BAStudio SQL script template.  
bastudio_configuration.database.alternative_host Business Automation Studio database alternative host for database automatic client reroute (ACR) with high availability disaster recovery (HADR). If you want to enable the database ACR and HADR, configure both alternative_host and alternative_port.  
bastudio_configuration.database.alternative_port Business Automation Studio database alternative port for database ACR with HADR. If you want to enable the database ACR and HADR, configure both alternative_host and alternative_port.  
bastudio_configuration.database.type Business Automation Studio database type db2
bastudio_configuration.database.ssl_enabled Whether to enable Secure Sockets Layer (SSL) support for the database connection false
bastudio_configuration.database.certificate_secret_name Existing TLS secret that contains tls.crt with SSL certificate when SSL support for the database connection is enabled  
bastudio_configuration.database.user_custom_jdbc_drivers Whether to use a custom JDBC driver instead of the embedded one. If you don't want to use a custom driver, keep the default. false
bastudio_configuration.database.custom_jdbc_pvc Persistent volume claim (PVC) for storing the custom JDBC driver files when a custom JDBC driver is enabled  
bastudio_configuration.database.jdbc_driver_files File names for the custom JDBC driver when a custom JDBC driver is enabled db2jcc4.jar db2jcc_license_cisuz.jar db2jcc_license_cu.jar
bastudio_configuration.images.bastudio.repository Repository and name of the Business Automation Studio image bastudio
bastudio_configuration.images.bastudio.tag Tag name of the Business Automation Studio image 19.0.3
bastudio_configuration.images.pull_policy Pull policy applied for Business Automation Studio deployment  
bastudio_configuration.custom_xml Liberty custom settings for Business Automation Studio server in XML format  
bastudio_configuration.custom_secret_name Sensitive liberty custom settings for Business Automation Studio server. Enter the name of the secret where they are stored.  
bastudio_configuration.bastudio_custom_xml Business Automation Studio custom settings in XML format  
bastudio_configuration.content_security_policy Business Automation Studio content security policy default-src 'self' 'unsafe-inline' 'unsafe-eval'; frame-ancestors 'self'; font-src 'self' fonts.gstatic.com; frame-src *; img-src 'self' data:;
bastudio_configuration.csrf_referrer.whitelist Custom whitelist for Cross-Site Request Forgery (CSRF) protection. This variable is a string and multiple values can be provided by separating them with a comma. For example, whitelist:“editor1.hostname, editor2.hostname”  
bastudio_configuration.logs.console_format Format for printing logs on the console json
bastudio_configuration.logs.console_log_level Log level for printing logs on the console INFO
bastudio_configuration.logs.console_source Source of the logs for printing on the console message,trace,accessLog,ffdc,audit
bastudio_configuration.logs.trace_format Format for printing trace logs ENHANCED
bastudio_configuration.logs.trace_specification Specification for printing trace logs *=info
bastudio_configuration.replica_size Number of Business Automation Studio nodes in the cluster 1
bastudio_configuration.autoscaling.enabled Whether to enable the Horizontal Pod Autoscaler for Business Automation Studio false
bastudio_configuration.autoscaling.minReplicas Minimum number of pods for Business Automation Studio when autoscaling is enabled 1
bastudio_configuration.autoscaling.maxReplicas Maximum number of pods for Business Automation Studio when autoscaling is enabled 3
bastudio_configuration.autoscaling.targetAverageUtilization Target average utilization rate for Business Automation Studio when autoscaling is enabled 80
bastudio_configuration.resources.bastudio.limits.cpu CPU limit for Business Automation Studio configuration 4
bastudio_configuration.resources.bastudio.limits.memory Memory limit for Business Automation Studio configuration 3Gi
bastudio_configuration.resources.bastudio.requests.cpu Requested amount of CPU for Business Automation Studio configuration 2
bastudio_configuration.resources.bastudio.requests.memory Requested amount of memory for Business Automation Studio configuration 2Gi
bastudio_configuration.resources.init_process.limits.cpu CPU limit for Business Automation Studio init process 500m
bastudio_configuration.resources.init_process.limits.memory Memory limit for Business Automation Studio init process 512Mi
bastudio_configuration.resources.init_process.requests.cpu Requested amount of CPU for Business Automation Studio init process 200m
bastudio_configuration.resources.init_process.requests.memory Requested amount of memory for Business Automation Studio init process" 256Mi
bastudio_configuration.liveness_probe.initial_delay_seconds Number of seconds after the container starts before the liveness probe is initiated 300
bastudio_configuration.liveness_probe.period_seconds How often (in seconds) to perform the probe 10
bastudio_configuration.liveness_probe.timeout_seconds Number of seconds after which the probe times out 5
bastudio_configuration.liveness_probe.failure_threshold When a pod starts and the probe fails, Kubernetes tries this number of times before giving up. Minimum value is 1. 3
bastudio_configuration.liveness_probe.success_threshold Minimum consecutive successes for the probe to be considered successful after failing. Minimum value is 1. 1
bastudio_configuration.readiness_probe.initial_delay_seconds Number of seconds after the container starts before the readiness probe is initiated 240
bastudio_configuration.readiness_probe.period_seconds How often (in seconds) to perform the probe 5
bastudio_configuration.readiness_probe.timeout_seconds Number of seconds after which the probe times out 5
bastudio_configuration.readiness_probe.failure_threshold When a pod starts and the probe fails, Kubernetes tries this number of times before giving up. Minimum value is 1. 6
bastudio_configuration.readiness_probe.success_threshold Minimum consecutive successes for the probe to be considered successful after failing. Minimum value is 1. 1
bastudio_configuration.jms_server.image.repository Image name for Java Message Service (JMS) server container jms
bastudio_configuration.jms_server.image.tag Image tag for JMS server container 19.0.3
bastudio_configuration.jms_server.image.pull_policy Pull policy for JMS server container IfNotPresent
bastudio_configuration.jms_server.resources.limits.cpu CPU limit for JMS configuration 1000m
bastudio_configuration.jms_server.resources.limits.memory Memory limit for JMS configuration 1Gi
bastudio_configuration.jms_server.resources.requests.cpu Requested CPU for JMS configuration 500m
bastudio_configuration.jms_server.resources.requests.memory Requested memory for JMS configuration 512Mi
bastudio_configuration.jms_server.storage.persistent Whether to enable JMS persistent storage false
bastudio_configuration.jms_server.storage.use_dynamic_provisioning Whether to enable dynamic provisioning for JMS persistent storage false
bastudio_configuration.jms_server.storage.storage_class Storage class name for JMS persistent storage  
bastudio_configuration.jms_server.storage.access_modes Access modes for JMS persistent storage ReadWriteOnce
bastudio_configuration.jms_server.storage.selector Selector for JMS persistent storage  
bastudio_configuration.jms_server.storage.size Size for JMS persistent storage 3Gi
Table 2.  New in 19.0.3  Resource Registry parameters
Parameter Description Default Value
resource_registry_configuration.admin_secret_name Existing Resource Registry administrative secret for sensitive configuration data resource-registry-admin-secret
resource_registry_configuration.hostname Resource Registry external hostname  
resource_registry_configuration.port Resource Registry port for using the NodePort service 443
resource_registry_configuration.replica_size Number of etcd nodes in the cluster 3
resource_registry_configuration.images.resource_registry.repository Repository and name of the Resource Registry image dba-etcd
resource_registry_configuration.images.resource_registry.tag Tag name of the Resource Registry image 19.0.3
resource_registry_configuration.tls.tls_secret Existing TLS secret that contains tls.key and tls.crt  
resource_registry_configuration.probe.liveness.initial_delay_seconds Number of seconds after the container starts before the liveness probe is initiated 60
resource_registry_configuration.probe.liveness.period_seconds How often (in seconds) to perform the probe 10
resource_registry_configuration.probe.liveness.timeout_seconds Number of seconds after which the probe times out 5
resource_registry_configuration.probe.liveness.success_threshold Minimum consecutive successes for the probe to be considered successful after failing. Minimum value is 1. 1
resource_registry_configuration.probe.liveness.failure_threshold When a pod starts and the probe fails, Kubernetes tries this number of times before giving up. Minimum value is 1. 3
resource_registry_configuration.probe.readiness.initial_delay_seconds Number of seconds after the container starts before the readiness probe is initiated 10
resource_registry_configuration.probe.readiness.period_seconds How often (in seconds) to perform the probe 10
resource_registry_configuration.probe.readiness.timeout_seconds Number of seconds after which the probe times out 5
resource_registry_configuration.probe.readiness.success_threshold Minimum consecutive successes for the probe to be considered successful after failing. Minimum value is 1. 1
resource_registry_configuration.probe.readiness.failure_threshold When a pod starts and the probe fails, Kubernetes tries this number of times before giving up. Minimum value is 1. 3
resource_registry_configuration.resources.limits.cpu CPU limit for Resource Registry configuration 500m
resource_registry_configuration.resources.limits.memory Memory limit for Resource Registry configuration 512Mi
resource_registry_configuration.resources.requests.cpu Requested CPU for Resource Registry configuration 200m
resource_registry_configuration.resources.requests.memory Requested memory for Resource Registry configuration 256Mi
resource_registry_configuration.auto_backup.enable Whether to enable automatic backup for Resource Registry. If you enable automatic backup, you must create a persistent volume (PV). See Optional: Implementing storage. false
resource_registry_configuration.auto_backup.minimal_time_interval Minimal time interval for automatic backup 1800
resource_registry_configuration.auto_backup.pvc_name The name of the persistent volume claim (PVC) for automatic backup  
Table 3.  For 19.0.2  Business Automation Studio configuration parameters
Parameter Description Default Value
global.existingClaimName Existing persistent volume claim name for JDBC and ODBC library  
global.nonProductionMode Production mode. This value must be false. false
global.imagePullSecrets Existing Docker image secret image-pull-secret  
global.caSecretName Existing CA secret ca-tls-secret
global.dnsBaseName Kubernetes Domain Name Server (DNS) base name svc.cluster.local
global.contributorToolkitsPVC Persistent volume for contributor toolkits storage  
global.image.keytoolInitcontainer Image name for TLS init container dba-keytool-initcontainer:19.0.2
global.ums.serviceType UMS service type: NodePort, ClusterIP, or Ingress  
global.ums.hostname UMS external hostname  
global.ums.port UMS port (only effective with a NodePort service)  
global.ums.adminSecretName Existing UMS administrative secret for sensitive configuration data  
global.baStudio.serviceType Business Automation Studio service type: NodePort, ClusterIP, or Ingress  
global.baStudio.hostname Business Automation Studio external hostname  
global.baStudio.port Business Automation Studio port (only effective with a NodePort service)  
global.baStudio.adminSecretName Business Automation Studio Secret for administration  
global.baStudio.jmsPersistencePVC Business Automation Studio JMS persistent volume claim  
global.resourceRegistry.hostname Resource Registry external hostname  
global.resourceRegistry.port Resource Registry port for using NodePort Service  
global.resourceRegistry.adminSecretName Existing Resource Registry administrative secret for sensitive configuration  
global.appEngine.serviceType App Engine service type: NodePort, ClusterIP, or Ingress  
global.appEngine.hostname App Engine external hostname  
global.appEngine.port App Engine port (only effective with a NodePort service)  
baStudio.install Switch for installing Business Automation Studio true
baStudio.replicaCount Number of deployment replicas 1
baStudio.images.baStudio Image name for Business Automation Studio container 20190624-064834.0.linux:19.0.0.1
baStudio.images.tlsInitContainer Image name for TLS init container dba-keytool-initcontainer:19.0.2
baStudio.images.ltpaInitContainer Image name for job container dba-keytool-jobcontainer:19.0.2
baStudio.images.umsInitRegistration Image name for UMS container dba-umsregistration-initjob:19.0.2
baStudio.images.jmsContainer Image name for JMS container baw-jms-server:19.0.2
baStudio.images.pullPolicy Pull policy for all containers IfNotPresent
baStudio.tls.tlsSecretName Existing TLS secret that contains tls.key and tls.crt  
baStudio.tls.tlsTrustList List of secret names used to store the trusted TLS certificates. []
baStudio.database.name Business Automation Studio database name  
baStudio.database.host Business Automation Studio database host  
baStudio.database.port Business Automation Studio database port  
baStudio.database.type Business Automation Studio database type: db2  
baStudio.autoscaling.enabled Whether to enable the Horizontal Pod Autoscaler for Business Automation Studio false
baStudio.autoscaling.minReplicas Minimum limit for the number of pods for Business Automation Studio when autoscaling is enabled 2
baStudio.autoscaling.maxReplicas Maximum limit for the number of pods for Business Automation Studio when autoscaling is enabled 5
baStudio.autoscaling.targetAverageUtilization Target average CPU utilization over all the pods for Business Automation Studio when autoscaling is enabled 80
baStudio.contentSecurityPolicy ContentSecurityPolicy for Business Automation Studio upgrade-insecure-requests
baStudio.resources.bastudio.limits.cpu Maximum amount of CPU that is required for Business Automation Studio 4
baStudio.resources.bastudio.limits.memory Maximum amount of memory that is required for Business Automation Studio 3Gi
baStudio.resources.bastudio.requests.cpu Minimum amount of CPU that is required for Business Automation Studio 2
baStudio.resources.bastudio.requests.memory Minimum amount of memory that is required for Business Automation Studio 2Gi
baStudio.resources.initProcess.limits.cpu Maximum amount of CPU that is required for Business Automation Studio init processes 500m
baStudio.resources.initProcess.limits.memory Maximum amount of memory that is required for Business Automation Studio init processes 512Mi
baStudio.resources.initProcess.requests.cpu Minimum amount of CPU that is required for Business Automation Studio init processes 200m
baStudio.resources.initProcess.requests.memory Minimum amount of memory that is required for Business Automation Studio init processes 256Mi
baStudio.resources.jms.limits.cpu Maximum amount of CPU that is required for Business Automation Studio Jms Server 1
baStudio.resources.jms.limits.memory Maximum amount of memory that is required for Business Automation Studio Jms Server 1Gi
baStudio.resources.jms.requests.cpu Minimum amount of CPU that is required for Business Automation Studio Jms Server 500m
baStudio.resources.jms.requests.memory Minimum amount of memory that is required for Business Automation Studio Jms Server 512Mi
appEngine.install Switch for installing App Engine true
appEngine.replicaCount Number of App Engine deployment replicas 1
appEngine.probes.initialDelaySeconds Number of seconds after the App Engine container is started before liveness or readiness probes are initiated 5
appEngine.probes.periodSeconds How often (in seconds) to run the probe. The default is 10 seconds. Minimum value is 1. 10
appEngine.probes.timeoutSeconds Number of seconds after which the probe times out. The default is 1 second. Minimum value is 1. 5
appEngine.probes.successThreshold Minimum consecutive successes for the probe to be considered successful after it fails. Minimum value is 1. 5
appEngine.probes.failureThreshold When a pod starts and the probe fails, Kubernetes tries this number of times before it gives up. Minimum value is 1. 3
appEngine.images.appEngine Image name for App Engine container solution-server:19.0.2
appEngine.images.tlsInitContainer Image name for TLS init container dba-keytool-initcontainer:19.0.2
appEngine.images.dbJob Image name for App Engine database job container solution-server-helmjob-db:19.0.2
appEngine.images.oidcJob Image name for OpenID Connect (OIDC) registration job container dba-umsregistration-initjob:19.0.2
appEngine.images.dbcompatibilityInitContainer Image name for database compatibility init container dba-dbcompatibility-initcontainer:19.0.2
appEngine.images.pullPolicy Pull policy for all App Engine containers IfNotPresent
appEngine.tls.tlsSecretName Existing TLS secret that contains tls.key and tls.crt  
appEngine.tls.tlsTrustList Existing TLS trust secret []
appEngine.database.name App Engine database name  
appEngine.database.host App Engine database host  
appEngine.database.port App Engine database port  
appEngine.database.type App Engine database type: db2  
appEngine.database.currentSchema App Engine database schema  
appEngine.database.initialPoolSize Initial pool size of the App Engine database 1
appEngine.database.maxPoolSize Maximum pool size of the App Engine database 10
appEngine.database.uvThreadPoolSize UV thread pool size of the App Engine database 4
appEngine.database.maxLRUCacheSize Maximum Least Recently Used (LRU) cache size of the App Engine database 1000
appEngine.database.maxLRUCacheAge Maximum LRU cache age of the App Engine database 600000
appEngine.useCustomJDBCDrivers Toggle for custom JDBC drivers false
appEngine.adminSecretName Existing App Engine administrative secret for sensitive configuration data  
appEngine.logLevel.node Log level for output from the App Engine server trace
appEngine.logLevel.browser Log level for output from the web browser 2
appEngine.contentSecurityPolicy.enable Enables the content security policy for the App Engine false
appEngine.contentSecurityPolicy.whitelist Configuration of the App Engine content security policy whitelist  
appEngine.session.duration Duration of the session 1800000
appEngine.session.resave Enables session resaves false
appEngine.session.rolling Send cookie every time true
appEngine.session.saveUninitialized Uninitialized sessions are saved if checked false
appEngine.session.useExternalStore Use an external store for storing sessions false
appEngine.redis.host Hostname of the Redis database that is used by the App Engine  
appEngine.redis.port Port number of the Redis database that is used by the App Engine  
appEngine.redis.ttl Time to live for the Redis database connection that is used by the App Engine  
appEngine.maxAge.staticAsset Maximum age of a static asset 2592000
appEngine.maxAge.csrfCookie Maximum age of a Cross-Site Request Forgery (CSRF) cookie 3600000
appEngine.maxAge.authCookie Maximum age of an authentication cookie 900000
appEngine.env.serverEnvType App Engine server environment type development
appEngine.env.maxSizeLRUCacheRR Maximum size of the LRU cache for the Resource Registry 1000
appEngine.resources.ae.limits.cpu Maximum amount of CPU that is required for the App Engine container 1
appEngine.resources.ae.limits.memory Maximum amount of memory that is required for the App Engine container 1024Mi
appEngine.resources.ae.requests.cpu Minimum amount of CPU that is required for the App Engine container 500m
appEngine.resources.ae.requests.memory Minimum amount of memory that is required for the App Engine container 512Mi
appEngine.resources.initContainer.limits.cpu Maximum amount of CPU that is required for the App Engine init container 500m
appEngine.resources.initContainer.limits.memory Maximum amount of memory that is required for the App Engine init container 256Mi
appEngine.resources.initContainer.requests.cpu Minimum amount of CPU that is required for the App Engine init container 200m
appEngine.resources.initContainer.requests.memory Minimum amount of memory that is required for the App Engine init container 128Mi
appEngine.autoscaling.enabled Enable the Horizontal Pod Autoscaler for App Engine init container false
appEngine.autoscaling.minReplicas Minimum limit for the number of pods for the App Engine 2
appEngine.autoscaling.maxReplicas Maximum limit for the number of pods for the App Engine 5
appEngine.autoscaling.targetAverageUtilization Target average CPU utilization over all the pods for the App Engine init container 80
resourceRegistry.install Switch for installing Resource Registry true
resourceRegistry.images.resourceRegistry Image name for Resource Registry container dba-etcd:19.0.2
resourceRegistry.images.pullPolicy Pull policy for all containers IfNotPresent
resourceRegistry.tls.tlsSecretName Existing TLS secret that contains tls.key and tls.crt  
resourceRegistry.replicaCount Number of etcd nodes in cluster 3
resourceRegistry.resources.limits.cpu CPU limit for Resource Registry configuration 500m
resourceRegistry.resources.limits.memory Memory limit for Resource Registry configuration 512Mi
resourceRegistry.resources.requests.cpu Requested CPU for Resource Registry configuration 200m
resourceRegistry.resources.requests.memory Requested memory for Resource Registry configuration 256Mi
resourceRegistry.persistence.enabled Enables this deployment to use persistent volumes false
resourceRegistry.persistence.useDynamicProvisioning Enables dynamic binding of persistent volumes to created persistent volume claims true
resourceRegistry.persistence.storageClassName Storage class name  
resourceRegistry.persistence.accessMode Access mode as ReadWriteMany ReadWriteOnce  
resourceRegistry.persistence.size Storage size  
resourceRegistry.livenessProbe.enabled Liveness probe configuration enabled true
resourceRegistry.livenessProbe.initialDelaySeconds Number of seconds after the container is started before liveness is initiated 120
resourceRegistry.livenessProbe.periodSeconds How often (in seconds) to run the probe 10
resourceRegistry.livenessProbe.timeoutSeconds Number of seconds after which the probe times out 5
resourceRegistry.livenessProbe.successThreshold Minimum consecutive successes for the probe to be considered successful after it fails. Minimum value is 1. 1
resourceRegistry.livenessProbe.failureThreshold When a pod starts and the probe fails, Kubernetes tries this number of times before it gives up. Minimum value is 1. 3
resourceRegistry.readinessProbe.enabled Readiness probe configuration enabled true
resourceRegistry.readinessProbe.initialDelaySeconds Number of seconds after the container is started before readiness is initiated 15
resourceRegistry.readinessProbe.periodSeconds How often (in seconds) to run the probe 10
resourceRegistry.readinessProbe.timeoutSeconds Number of seconds after which the probe times out 5
resourceRegistry.readinessProbe.successThreshold Minimum consecutive successes for the probe to be considered successful after it fails. Minimum value is 1. 1
resourceRegistry.readinessProbe.failureThreshold When a pod starts and the probe fails, Kubernetes tries this number of times before it gives up. Minimum value is 1. 6
resourceRegistry.logLevel Log level of the resource registry server. Available options: debug info warn error panic fatal info