Environment Variables for Docker
This section lists the environment variables that can be used for TIBCO BusinessWorks Container Edition application deployment on Docker and Docker-based platforms.
Environment Variable | Default Values | Description | ||||||
---|---|---|---|---|---|---|---|---|
APPLICATION_NAME | n/a | This environment variable is used to provide custom application name to fetch application properties from config management. | ||||||
APP_CONFIG_PROFILE | n/a | The name of the application profile that is to be used from a configuration management system such as ZUUL or Spring Cloud Config. | ||||||
AWS_ACCESS_KEY | n/a | It is the access key used to access the AWS account from where the parameters are fetched.
Note: This must be set if you want to use AWS Systems Manager Parameter Store or AWS secret manager for application configuration and secrets management.
|
||||||
AWS_EXTERNAL_ID | n/a | Optional. A unique identifier required when you assume a role in another account. It is used to address the confused deputy problem. | ||||||
AWS_EXPIRATION_DURATION (ms) | n/a | Optional. Parameter to specify the duration in minutes for which the temporary security credentials remain valid using AssumeRole. | ||||||
AWS_PARAMETER_STORE | True | This environment variable is optional while running applications on TIBCO Business Studio for BusinessWorks or Docker platforms. It is mandatory while deploying applications on ECS services. | ||||||
AWS_REGION | n/a | It is the region of your AWS account.
Note: This must be set if you want to use AWS Systems Manager Parameter Store or AWS secret manager for application configuration and secrets management.
|
||||||
AWS_ROLE_ARN | n/a | This is required to use assumeRole for authentication. The Amazon Resource Name (ARN) of the role to assume. | ||||||
AWS_ROLE_SESSION_NAME | n/a | This environment variable is required to use assumeRole for authentication. An identifier for the assumed role session is used to identify uniquely a session when the same role is assumed by different principals or for different reasons. Please refer to the AWS documentation for further details on RoleSessionName. | ||||||
AWS_SECRET_KEY | n/a | It is the secret key used to access the AWS account from where the parameters are fetched.
Note: This must be set if you want to use AWS Systems Manager Parameter Store or AWS secret manager for application configuration and secrets management.
|
||||||
AWS_SECRET_MANAGER | True | Set to use the AWS secret manager as the credential management system. | ||||||
AZURE_CLIENT_ID | n/a | It is the Client ID of the service principle. | ||||||
AZURE_CLIENT_SECRET | n/a | It is the Secret of the service principle. | ||||||
AZURE_TENANT_ID | n/a | It is the Tenant ID of the Azure account. | ||||||
AZURE_VAULT | True | This environment variable is set to true to enable credential management using the Azure Vault. | ||||||
AWS_SESSION_TOKEN | n/a | AWS uses the session token to validate the temporary security credentials. When a call is made using temporary credentials, the call includes a session token, which returns along with the temporary credentials | ||||||
AWS_ACCESS_KEY_ID | n/a | It is the access key used to access the AWS account. This is in case of temporary security credentials. | ||||||
AWS_SECRET_ACCESS_KEY | n/a | It is the secret key used to access the AWS account. This is in case of temporary security credentials. | ||||||
BW_LOG_FORMAT | n/a |
|
||||||
BW_LOGLEVEL | ERROR | Used to set a log level for the TIBCO BusinessWorks Container Edition application. The default value is ERROR. Supported values are:
|
||||||
BW_ENGINE_THREADCOUNT | 8 | Used to set engine thread count for the TIBCO BusinessWorks Container Edition application. | ||||||
BW_ENGINE_STEPCOUNT | -1 | Used to set engine step count for the TIBCO BusinessWorks Container Edition application. | ||||||
BW_APPLICATION_JOB_FLOWLIMIT | n/a | Used to set Flow limit for TIBCO BusinessWorks Container Edition application. | ||||||
BW_PROFILE | n/a | Used to set the name of the BusinessWorks profile from the application. | ||||||
BW_JAVA_OPTS | n/a | Used to set Java properties that are used at run time. The properties are specified using name-value pairs and are separated by spaces.
For example, BW_JAVA_OPTS="-Dname=value -Dname=value"
Note: BW_JAVA_OPTS environment variable can also be used to hardcore the heap parameters.
|
||||||
BW_JMX_CONFIG | n/a | Used to set JMX configuration (RMI host and JMX port) for monitoring TIBCO BusinessWorks Container Edition application. The value should be provided in RMI_HOST:JMX_PORT format.
For example,
|
||||||
BW_JAVA_GC_OPTS | -XX:+UseG1GC | Used to set JAVA GC configuration. The value should be one of the standard Java GC VM Options.
For example:
|
||||||
BREAK_CIRCUIT_ON_404_ERROR | True | Used to change the behavior of the Circuit Breaker functionality. By default, the circuit breaks for the 404 (Not Found) error code.
It does not break the circuit for 404 error code on specifying the value of the variable as
|
||||||
BW_COMPONENT_JOB_FLOWLIMIT | n/a | Used to set Flow limit at component level for TIBCO BusinessWorks Container Edition application.
For example,
|
||||||
BW_OSGI_SSH_PORT | n/a | This is the BWAppNode OSGi Console SSH port. It is used for OSGI remote access. Without passing this environment variable, the OSGI Port the default value configured is 1122. | ||||||
BW_REST_DOCAPI_PORT | n/a | This is the Swagger framework port. This environment variable configures the port on which the Swagger framework serves the API documentation endpoint. The default value configured for this port is 7777. | ||||||
BW_OSGI_SERVICE_PORT | n/a | This environment variable configures the OSGI Service Port. Without passing this environment variable, the default value configured for this port is 8090. | ||||||
BW_OTEL_ENABLED | n/a |
This environment variable sets the value to enable or disable opentelemetry traces and metrics by setting the following properties:
Note: The BW_OTEL_ENABLED, BW_OTEL_AUTOCONFIGURED_ENABLED, and BW_OTEL_AUTOCONFIGURED_ENABLED environment variables are used only for runtime.
|
||||||
BW_OTEL_AUTOCONFIGURED_ENABLED | n/a | This environment variable sets the value to enable or disable opentelemetry autoconfiguration by setting the following property, bw.opentelemetry.autoConfigured |
||||||
BW_OTEL_TRACES_ENABLED | n/a | This environment variable sets the value to enable or disable opentelemetry traces by setting the following property, bw.engine.opentelemetry.trace.enable |
||||||
CONJUR_ACCOUNT | n/a | The account specified during setting up the Conjur. | ||||||
CONJUR_APPLIANCE_URL | n/a | It is the Conjur HTTPS endpoint (OSS/DAP). | ||||||
CONJUR_AUTHN_LOGIN | n/a | It is the user or host identity. | ||||||
CONJUR_AUTHN_API_KEY | n/a | It is the user or host API Key. | ||||||
CONSUL_SERVER_URL | n/a | Used to set Consul server configuration.
For example, CONSUL_SERVER_URL=http://127.0.0.1:8085 This must be set if you intend to use Consul for application configuration or for service registration and discovery. |
||||||
CONSUL_CUSTOM_FOLDER | n/a | This must be set if you only intend to use properties from the Consul Server stored in custom folders.
If properties are stored or exported to <CONSUL_SERVER_URL>/ui/dc1/kv/FOLDER1/FOLDER2 location, then the value for CONSUL_CUSTOM_FOLDER = FOLDER1/FOLDER2 |
||||||
CUSTOM_ENCRYPTION_KEY | n/a | The custom encryption key used in BWObfuscator. | ||||||
CUSTOM_LOG_BACK | False | Used for customizing logs. | ||||||
CYBERARK | True | Set to use Cyberark as the credential management system. | ||||||
CYBERARK_KEYSTORE_PATH | n/a | The location of the JKS file. | ||||||
CYBERARK_KEYSTORE_PASSWORD | n/a | The password of the JKS file. | ||||||
DISABLE_BWCE_EAR_VALIDATION | False | Used to deploy the ActiveMatrix BusinessWorks 6.x application
EAR file on
TIBCO BusinessWorks Container Edition without converting the project to TIBCO BusinessWorks Container Edition and rebuilding the EAR file from
TIBCO Business Studio for BusinessWorks. Note: Ensure that the ActiveMatrix BusinessWorks 6.x EAR file is exported. ActiveMatrix BusinessWorks 6.x EAR file should only have
TIBCO BusinessWorks Container Edition supported activities and features.
|
||||||
EUREKA_SERVER_URL | Used to set Eureka server configuration.
For example, EUREKA_SERVER_URL=http://127.1.0.1:8080/eureka This must be set if you intend to use Eureka for service registration and discovery. |
|||||||
GOOGLE_PROJECT_ID | n/a | The project ID of the Google project being used. | ||||||
GOOGLE_SECRET_MANAGER | n/a | Set this value to true to enable Google Secret Manager. | ||||||
GOOGLE_SECRET_TOKEN | n/a | The Google token for authentication. | ||||||
GOOGLE_CREDENTIALS | n/a | The path of the service account json file credentials for authentication. | ||||||
HASHICORP_VAULT_ADDR | n/a | URL of the vault server | ||||||
HASHICORP_VAULT_AUTH | n/a | Provide the authentication value as Token or Userpass or Approle depending on the authentication method used. | ||||||
HASHICORP_VAULT_NAMESPACE | n/a | The name of the namespace to be used in the application to retrieve secrets from the vault.
Optional. This environment variable must be used only if namespaces is used. |
||||||
HASHICORP_AUTH_PATH | The default path for Userpass is userpass/
The default path for Approle is approle/ |
Optional. Path where the authentication option is enabled in the vault. | ||||||
HASHICORP_VAULT_KV_VERSION | 2 |
A version of the key value engine to be used. The default value is 2 if this environment variable is not used. The only other valid value for this field is 1. |
||||||
HASHICORP_VAULT_TOKEN | n/a | Provide the token value when the authentication method is token. | ||||||
HASHICORP_VAULT_ROLE_ID | n/a | Provide the role-id if the authentication method is Approle. | ||||||
HASHICORP_VAULT_SECRET_ID | n/a | Provide the secret-id if the authentication method is Approle. | ||||||
HASHICORP_VAULT_USERNAME | n/a | Provide the username if the authentication method is Userpass. | ||||||
HASHICORP_VAULT_PASSWORD | n/a | Provide the password if the authentication method is Userpass. | ||||||
HASHICORP_CACERT | n/a | Provide the path of the CA certificate used. | ||||||
MASHERY_SERVICE_CONFIG | n/a |
Applications can pass TIBCO Mashery configuration information using the
The value of the environment variable is a JSON string with the required TIBCO Mashery configuration. For more information, see Integrating with TIBCO Mashery. |
||||||
SPRING_CLOUD_CONFIG_SERVER_URL | n/a | Used to set URL for Spring Cloud Config Server.
For example:
Note: This must be set, if you want to use the Spring Cloud Config Server for application configuration management.
|
||||||
SPRING_CLOUD_CONFIG_ACCESS_TOKEN_URI | n/a | Used to set OAuth access token URL for Spring Cloud Config Server, if OAuth is enabled. | ||||||
SPRING_CLOUD_CONFIG_CLIENT_ID | n/a | Used to set OAuth client ID for Spring Cloud Config Server, if OAuth is enabled. | ||||||
SPRING_CLOUD_CONFIG_CLIENT_SECRET | n/a | Used to set OAuth client secret for Spring Cloud Config Server, if OAuth is enabled. | ||||||
X_CONSUL_TOKEN | n/a | Used to authenticate the request made to the Consul server.
This environment variable should be used when the Consul server is enabled for authentication. Note: This should be set if authentication is enabled on the Consul server and you want to authenticate the requests made to the Consul server.
|
||||||
VAULT_AUTH_PATH | n/a | Path of the Authentication mounted. |