IBM Business Automation Workflow on containers parameters

Edit online

 Containers: 
Each container image needs a set of values for its configuration parameters to create a Kubernetes deployment.

For IBM Business Automation Workflow on containers parameters, see IBM Business Automation Workflow Runtime and Workstream Services parameters.
Note: Ignore any parameters for Workstream Services, Business Automation Insights, and Machine Learning Server (including Intelligent Task Prioritization and Workforce Insights). These are not included in stand-alone IBM Business Automation Workflow.

Elasticsearch

The following table lists the parameters for configuring Elasticsearch in Process Federation Server. For more information about Elasticsearch, see Deploying Elasticsearch as part of the stand-alone IBM Business Automation Workflow on containers deployment.
Table 1. Elasticsearch configuration parameters (elasticsearch_configuration)
Parameter Description Example values Required
es_image.repository Elasticsearch image. By default, the path points to the URL and location in the IBM Entitled Registry. The default value is <path>/pfs-elasticsearch-prod where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository has a value, the path is that value. <path>/pfs-elasticsearch-prod No
es_image.tag Elasticsearch image tag. If you want to use a specific image version, you can override the default tag or digest. 21.0.3 No
es_image.pull_policy Elasticsearch image pull policy. The default value is IfNotPresent. IfNotPresent, Always No
es_init_image.repository Process Federation Server init image. By default, the path points to the URL and location in the IBM Entitled Registry. The default value is <path>/pfs-init-prod where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository has a value, the path is that value. pfs-init-prod No
es_init_image.tag Process Federation Server init image tag. If you want to use a specific image version, you can override the default tag or digest. 21.0.3 No
es_init_image.pull_policy Process Federation Server init image pull policy. The default value is IfNotPresent. IfNotPresent, Always No
es_nginx_image.repository Elasticsearch ngnix image. By default, the path points to the URL and location in the IBM Entitled Registry. The default value is <path>/pfs-nginx-prod where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository has a value, the path is that value. pfs-nginx-prod No
es_nginx_image.tag Elasticsearch ngnix image tag. If you want to use a specific image version, you can override the default tag or digest. 21.0.3 No
es_nginx_image.pull_policy Elasticsearch ngnix image pull policy. The default value is IfNotPresent. IfNotPresent, Always No
replicas Number of initial Elasticsearch pods. The default value is 1. 1 No
service_type How the HTTPS endpoint service should be published. The default value is ClusterIP. ClusterIP No
external_port Port to which the Elasticsearch server HTTPS endpoint will be exposed externally. This parameter is relevant only if pfs_configuration.elasticsearch.service_type is set to NodePort. No
admin_secret_name The Elasticsearch administrative secret that contains the following keys:
  • .htpasswd: A file listing the users and associated passwords that are allowed to authenticate.
  • username: The name of a user referenced in the .htpasswd file. Process Federation Server pods use this user to connect to Elasticsearch.
  • password: The password of the user provided through the username key. Process Federation Server uses this password to connect to Elasticsearch.
 No
anti_affinity Whether Kubernetes may (soft) or must not (hard) deploy Elasticsearch pods onto the same node. The default value is hard. hard, soft No
service_account Name of a service account to use. If elasticsearch_configuration.privileged is set to true, then this service account must allow running privileged containers. If not provided, CUSTOM_RESOURCE_NAME-ibm-pfs-es-service-account is used. CUSTOM_RESOURCE_NAME-ibm-pfs-es-service-account Yes
privileged When set to true, a privileged container is created to run the appropriate sysctl commands so that the node that is running the pods can disable swapping and increase the limit on the number of open file descriptors. The default value is false. false No
probe_initial_delay Initial delay for liveness and readiness probes of Elasticsearch pods. The default value is 90. 90 No
heap_size JVM heap size to allocate to each Elasticsearch pod. The default value is 1024m. 1024m No
monitor_enabled Specify whether to use the built-in monitoring capability. The default value is false. false No
resources.limits.memory Maximum memory (including JVM heap and file system cache) to allocate to each Elasticsearch pod. The default value is 2Gi. 2Gi No
resources.limits.cpu Maximum amount of CPU to allocate to each Elasticsearch pod. The default value is 1000m. 1000m No
resources.requests.memory Minimum memory required (including JVM heap and file system cache) to start an Elasticsearch pod. The default value is 1Gi. 1Gi No
resources.requests.cpu Minimum amount of CPU required to start an Elasticsearch pod. The default value is 100m. 100m No
storage.persistent Whether to enable persistent Elasticsearch storage for Process Federation Server. Set to false for non-production or trial-only deployment. The default value is true. true No
storage.use_dynamic_provisioning Set to true to use GlusterFS or another dynamic storage provisioner. The default value is true. true No
storage.size Minimum resource quantity. The default value is 10Gi. 10Gi No
storage.storage_class Storage class name for Elasticsearch persistent storage. No
snapshot_storage.enabled Set to true for production deployment. The default value is false. false No
snapshot_storage.use_dynamic_provisioning Set to true to use GlusterFS or another dynamic storage provisioner. The default value is true. true No
snapshot_storage.size Minimum resource quantity. The default value is 30Gi. 30Gi No
snapshot_storage.storage_class_name Storage class name for Elasticsearch persistent storage. The default value is shared_configuration.storage_configuration. sc_fast_file_storage_classname. shared_configuration.storage_configuration. sc_fast_file_storage_classname No
snapshot_storage.existing_claim_name By default, a new PVC is to be created. Specify an existing claim here if one is available.   No

User Management Services configuration parameters

See User Management Services configuration parameters in Installing IBM Business Automation Workflow Version 21.0.3 User Management Services on containers.