Configuring the params.ini file
The installation process needs a configuration parameters file called params.ini that contains variables essential for a successful deployment. The params.ini file defines the environment-specific settings that the installation script uses to configure your Concert, Concert Workflows, and Concert Data Apps instances. The params.ini file adheres to a standard .ini file format, comprising key-value pairs that store essential configuration settings.
The $INSTALL_DIR/etc/sample-params/ directory contains a set of sample files, each corresponding to a specific installation type. The all-params.ini file lists all the possible parameters that can be used for installation on VM and Kubernetes environments.
Sample params.ini files
params.ini files that apply to your installation type (VM or Kubernetes).
| Installation type | params.ini file name for VM | params.ini file name for Kubernetes |
|---|---|---|
|
Concert, Concert Workflows, and Concert Data Apps |
concert-dataapps-workflows-vm-quickstart-params.ini | concert-dataapps-workflows-k8s-params.ini |
|
Concert and Concert Workflows |
concert-workflows-vm-quick-start-params.ini | concert-workflows-k8s-quickstart-params.ini |
|
Concert and Concert Data Apps |
concert-dataapps-vm-quickstart-params.ini | concert-dataapps-k8s-quickstart-params.ini |
| Concert | concert-vm-quick-start-params.ini | concert-k8s-quick-start-params.ini |
| Concert Workflows | workflows-quickstart-vm-params.ini | workflows-quickstart-k8s-params.ini |
| Concert Data Apps | dataapps-vm-quick-start-params.ini | dataapps-k8s-quickstart-params.ini |
Parameters for installing on a VM
| Parameter | Description |
|---|---|
INSTALL_VM |
The specified configuration parameter determines the deployment environment for the application. If set to true, it indicates that the installation is being performed on a VM. Conversely, if this option is not set or is set to false, the deployment will be executed on a Kubernetes cluster. This setting is crucial in distinguishing between the two deployment environments, ensuring that the application is properly configured and installed according to the chosen environment. |
INSTALL_CONCERT |
The |
INSTALL_DATAAPPS |
The |
INSTALL_WORKFLOWS |
The |
INSTALL_SECURECODER |
The |
REG_USER |
This flag is used to specify the user for the registry. By default, this user is set to |
IMAGE_REGISTRY_PREFIX |
Specifies the registry where container images are hosted, serving as a crucial indicator for image storage and retrieval. By default, the value is set to |
SKIP_DISK_SPACE_CHECK |
By default, when you run the installation script on a VM, the installation script checks for sufficient free disk space on a VM to ensure a successful installation. To skip this check, you can set the parameter to |
| HUB parameters | |
HUB_URL |
Optional: The |
HUB_IMAGE_REGISTRY_SUFFIX |
This flag indicates the registry where the Hub images are hosted. The |
HUB_ACCESS_KEY |
Optional: The |
HUB_HTTPS_PORT |
Optional: The |
ENABLE_CROSS_PRODUCT_INTEGRATION |
The
ENABLE_CROSS_PRODUCT_INTEGRATION parameter is a configuration option that controls whether ITOM should be enabled as a part of the deployment process. By default, this parameter is set to false, which means ITOM is disabled. If set to true, ITOM will be installed with the HUB in the same namespace.
Note: ITOM will use the same configuration as Hub (namespace, scale config, storage class, and build tag).
|
HUB_SYSTEMD_ENABLE |
The |
| Concert parameters | |
CONCERT_IMAGE_REGISTRY_SUFFIX |
Indicates the registry where the Concert images are hosted. The |
| Concert Data Apps parameters | |
DATAAPPS_IMAGE_REGISTRY_SUFFIX |
Indicates the registry where the Concert Data Apps images are hosted. The |
| Concert Workflows parameters | |
WORKFLOWS_INSTANCE_ADDRESS |
Indicates the instance address, which is the fully qualified domain name (FQDN) (e.g., To find the FQDN, you can use commands such as |
WORKFLOWS_ENABLE_FAAS |
Optional: The Note: In Concert Workflows installation on a Power (ppc64le) VM and instances where Istio is enabled, the FaaS workflow integration is not supported.
|
WORKFLOWS_FAAS_NS |
Optional: The |
WORKFLOWS_ENABLE_ISTIO |
Optional: The |
WORKFLOWS_NS |
Optional: Specifies the namespace where Concert Workflows will be installed. By default, the Concert Workflows will be installed in the |
WORKFLOWS_OVERRIDE_VALUES |
Optional: Indicates the file path of the |
WORKFLOWS_INSTALL_ALL_INTEGRATIONS |
Optional:
|
WORKFLOWS_FLOW_PAUSE_ENABLED |
By default, this parameter is set to true. It enables a Concert Workflows worker to pause its running workflows and save the workflow state to the database before it is terminated. To force workers to complete their workflows before termination, set this parameter to false. |
WORKFLOWS_TERMINATION_TIMEOUT |
Before a Concert Workflows worker is terminated, it pauses the workflows that it is running. To prevent workflows from being paused indefinitely, a timeout period is applied. If a workflow is still paused when the timeout is reached, the workflow is terminated. Use this parameter to define the termination timeout period in seconds for local workers. The default timeout period is 1800 seconds (30 minutes). |
WORKFLOWS_USER_WORKER_TOKEN_DURATION |
When a worker runs a workflow, it generates a user-scoped token to impersonate the user that triggered the workflow. The worker uses this token to fetch workflow definitions and authentication objects. Use this parameter to define the validity period of the token. The default validity period is 3600 seconds (1 hour). |
| Secure Coder parameters | |
SECURECODER_IMAGE_REGISTRY_SUFFIX |
Indicates the registry where the Securecoder images are hosted. The |
SECURECODER_NS |
Optional: Specifies the namespace where Securecoder will be installed. By default, the Securecoder will be installed in the |
ENABLE_BUDDY |
If you want to enable Concert Buddy to use the Secure Coder browser experience, set this value to |
FILE_STORAGE_CLASS_CONCERT |
If |
SECURECODER_MEND_ENABLED |
Secure Coder offers a workspace scans feature, which utilizes the MendCLI tool to provide Static Application Security Testing (SAST) and Software Composition Analysis (SCA) scans. By default, this parameter is set to false, which means Mend scanning is disabled. If set to true, enables Mend SAST or OSS scanner integration. |
SECURECODER_MEND_ORG_NAME |
If |
SECURECODER_MEND_PRODUCT_NAME |
If |
SECURECODER_MEND_SERVICE_URL |
If |
SECURECODER_MEND_EMAIL_ADDRESS |
If |
SECURECODER_MEND_PROJECT_NAME |
If |
WATSONX_API_URL |
If |
WATSONX_API_PROJECT_ID |
If |
WATSONX_API_MODEL_ID |
Optional: If |
| AI configuration parameters | |
ENABLE_AI |
Set this value to |
LLM_PROVIDER |
The large language model (LLM) provider that you want to use. You can specify one of the following values:
By default, this parameter’s value is set to Note:
|
WATSONX_API_URL |
If
ENABLE_AI is true and your chosen provider is watsonx, set this value to the URL of the on-premises or SaaS watsonx.ai instance, for example:
|
WATSONX_API_PROJECT_ID |
If |
WATSONX_API_USER |
Your Concert license entitles you to use an instance of watsonx.ai via IBM Cloud Pak for Data. If |
WATSONX_API_MODEL_ID |
Optional: If |
WATSONX_API_VERSION |
Optional: If |
WATSONX_API_INSTANCE_ID |
Optional: If |
LLM_MODEL |
If
ENABLE_AI is true and your chosen provider is vLLM, set this value to the name of the vLLM-provided model that you want to use for generating workflows. Only IBM Granite and Mistral AI models are supported, and the following models are recommended:
|
EMBED_MODEL |
If Only IBM Granite Embedding models are supported, and the Granite-Embedding-125m-English model is recommended. To use this model, set this value to |
LLM_BASE_URL |
If |
Parameters for installing on Kubernetes
| Parameter | Description |
|---|---|
INSTALL_EKS |
Set the value to true or false. The flag |
|
|
The |
|
|
The |
|
|
The |
REG_USER |
This flag is used to specify the user for the registry. By default, this user is set to |
IMAGE_REGISTRY_PREFIX |
The flag is used to specify the registry where container images are hosted, serving as a crucial indicator for image storage and retrieval. By default, the value is set to |
| Hub parameters | |
|
|
Optional: The |
|
|
Optional: The |
|
|
Optional: The |
HUB_NS |
Specifies the Kubernetes namespace where Hub will be installed. By default, Hub will be installed in the |
HUB_IMAGE_REGISTRY_SUFFIX |
This flag indicates the registry where the Hub images are hosted. The |
SCALE_CONFIG_HUB |
Optional: This flag is used to set the scaling configuration level for a Hub instance. The default value for this flag is |
STORAGE_CLASS_HUB |
This flag sets the storage class for storing Hub data. Add the storage class name where the data is stored. Specify the storage class name you are using to store Hub data. |
| Concert parameters | |
CONCERT_NS |
Specifies the Kubernetes namespace where Concert will be installed. By default, Concert will be installed in the |
CONCERT_IMAGE_REGISTRY_SUFFIX |
This flag indicates the registry where the Concert images are hosted. The |
SCALE_CONFIG_CONCERT |
Optional: This flag sets the scaling configuration level for Your Concert instance. The default value for this flag is |
STORAGE_CLASS_CONCERT |
This flag sets the storage class for storing Concert data. Give the storage class name you are using to store Concert data. |
| Concert Data Apps parameters | |
DATAAPPS_NS |
Specifies the Kubernetes namespace where Concert Data Apps will be installed. By default, Concert Data Apps will be installed in the |
DATAAPPS_IMAGE_REGISTRY_SUFFIX |
This flag indicate the registry where the Concert Data Apps images are hosted. The |
SCALE_CONFIG_DATAAPPS |
Optional: This flag sets the scaling configuration level for your Concert Data Apps instance. The default value for this flag is |
STORAGE_CLASS_DATAAPPS |
This flag sets the storage class for storing Concert Data Apps data. Give the storage class name you are using to store Concert Data Apps data. |
| Concert Workflows parameters | |
WORKFLOWS_NS |
Specifies the Kubernetes namespace where Concert Workflows will be installed. By default, Concert Workflows will be installed in the |
WORKFLOWS_IMAGE_REGISTRY_SUFFIX |
This flag indicates the registry where the Concert Workflows images are hosted. The |
WORKFLOWS_INSTANCE_ADDRESS |
The flag indicates the Concert Workflows instance address, which is the fully qualified domain name (FQDN) of the cluster where Concert Workflows is hosted. An example of this address would be |
|
|
Optional: The Note: In Concert Workflows instances where Istio is enabled, the FaaS workflow integration is not supported.
|
|
|
Optional: The |
|
|
Optional: The |
WORKFLOWS_OVERRIDE_VALUES |
Optional: This flag indicates the file path of the |
STORAGE_CLASS_WORKFLOWS |
Optional:
STORAGE_CLASS_WORKFLOWS is a global parameter for the Concert Workflows Helm chart that specifies which Kubernetes storage class should be used for all PVCs created by the Concert Workflows components (for example, MySQL, PostgreSQL, MinIO, Redis, RabbitMQ, and InfluxDB).
|
WORKFLOWS_INSTALLATION_TYPE |
Keep this value empty. |
|
|
Optional:
|
WORKFLOWS_FLOW_PAUSE_ENABLED |
By default, this parameter is set to true. It enables a Concert Workflows worker to pause its running workflows and save the workflow state to the database before it is terminated. To force workers to complete their workflows before termination, set this parameter to false. |
WORKFLOWS_TERMINATION_TIMEOUT |
Before a Concert Workflows worker is terminated, it pauses the workflows that it is running. To prevent workflows from being paused indefinitely, a timeout period is applied. If a workflow is still paused when the timeout is reached, the workflow is terminated. Use this parameter to define the termination timeout period in seconds for local workers. The default timeout period is 1800 seconds (30 minutes). |
WORKFLOWS_USER_WORKER_TOKEN_DURATION |
When a worker runs a workflow, it generates a user-scoped token to impersonate the user that triggered the workflow. The worker uses this token to fetch workflow definitions and authentication objects. Use this parameter to define the validity period of the token. The default validity period is 3600 seconds (1 hour). |
| Secure Coder parameters | |
SECURECODER_IMAGE_REGISTRY_SUFFIX |
Indicates the registry where the Securecoder images are hosted. The |
SECURECODER_NS |
Specifies the Kubernetes namespace where Securecoder will be installed. By default, Securecoder will be installed in the |
SECURECODER_MEND_ENABLED |
Secure Coder offers a workspace scans feature, which utilizes the MendCLI tool to provide Static Application Security Testing (SAST) and Software Composition Analysis (SCA) scans. By default, this parameter is set to false, which means Mend scanning is disabled. If set to true, enables Mend SAST or OSS scanner integration. |
SECURECODER_MEND_ORG_NAME |
If |
SECURECODER_MEND_PRODUCT_NAME |
IfSECURECODER_MEND_ENABLED istrue, set this value to the Mend product name. |
SECURECODER_MEND_SERVICE_URL |
If |
SECURECODER_MEND_EMAIL_ADDRESS |
If |
SECURECODER_MEND_PROJECT_NAME |
If |
WATSONX_API_URL |
If |
WATSONX_API_PROJECT_ID |
If |
WATSONX_API_MODEL_ID |
Optional: If |
ENABLE_AI |
Set this value to |
LLM_PROVIDER |
The large language model (LLM) provider that you want to use. You can specify one of the following values:
By default, this parameter’s value is set to Note:
|
WATSONX_API_URL |
If
ENABLE_AI is true and your chosen provider is watsonx, set this value to the URL of the on-premises or SaaS watsonx.ai instance, for example:
|
WATSONX_API_PROJECT_ID |
If |
WATSONX_API_USER |
Your Concert license entitles you to use an instance of watsonx.ai via IBM Cloud Pak for Data. If |
WATSONX_API_MODEL_ID |
Optional: If |
WATSONX_API_VERSION |
Optional: If |
WATSONX_API_INSTANCE_ID |
Optional: If |
LLM_MODEL |
If
ENABLE_AI is true and your chosen provider is vLLM, set this value to the name of the vLLM-provided model that you want to use for generating workflows. Only IBM Granite and Mistral AI models are supported, and the following models are recommended:
|
EMBED_MODEL |
If Only IBM Granite Embedding models are supported, and the Granite-Embedding-125m-English model is recommended. To use this model, set this value to |
LLM_BASE_URL |
If
|