Customizing Business Automation Workflow Runtime properties

You can make Liberty and 100Custom configuration changes to Business Automation Workflow deployment, including configuring proxy changes.

About this task

This task provides the generic methods for modifying Liberty and 100Custom configuration settings for Business Automation Workflow deployment. The usage is generally paired with other documentation pages, which might describe a specific Liberty or 100Custom configuration setting that needs to be modified.

In a production deployment of Workflow Runtime, you can customize the following properties:

baw_configuration[x].liberty_custom_xml to customize the Business Automation Workflow Runtime Liberty server. If the customization does not contain sensitive information, you can use this property to put the customization directly into the custom resource. Alternatively, use the jvm_customize_options parameter to configure proxy settings, this setting accepts Java™ Virtual Machine options as space-separated values. For example:
```
jvm_customize_options: |-
      -Dhttp.proxyHost=10.242.64.4
      -Dhttp.proxyPort=3128
      -Dhttp.nonProxyHosts=localhost|127.0.0.1|*.svc
      -Djava.net.useSystemProxies=true
```
For more information, see Business Automation Workflow on containers runtime parameters .
baw_configuration[x].custom_xml_secret_name to customize Business Automation Workflow Runtime Liberty server if the customization contains sensitive information
baw_configuration[x].lombardi_custom_xml_secret_name to customize the Workflow Server Runtime 100Custom.xml

Important:

To modify settings, use the method for Business Automation Workflow Liberty configuration settings either in baw_configuration[x].liberty_custom_xml or in baw_configuration[x].custom_xml_secret_name. Don't use both methods to specify configuration values.

Procedure

To customize Business Automation Workflow Runtime Liberty properties, create a valid XML snippet with the Liberty configuration customization that you want, starting with the <server> element.
Note:
- baw_configuration[x] is an array and you should ensure changes are applied to the correct instance if you have multiple Business Automation Workflow instances. In the examples, the changes are applied to the instance with the name bawins1.
- If a password has a special character, you must encode it using XML special character encoding. See Special Characters in XML Documents .
- Customization that conflicts with the product setup and requirements isn't supported.
- To use a plain XML snippet, add it in the liberty_custom_xml property. The settings will be merged into the Liberty settings for the component.
```
    baw_configuration:
    - name: bawins1
      liberty_custom_xml: |+
        <server>
          
        </server>
```
- To use a secret, do the following steps.
  1. Create a file, such as custom.xml, with the XML snippet you want.
  2. Create a secret with the file, such as custom-liberty-xml-secret, using the following command:
```
kubectl create secret generic custom-liberty-xml-secret --from-file=sensitiveCustomConfig=./custom.xml
```
  3. In the CR, set the baw_configuration[x].custom_xml_secret_name property, as shown in this example snippet.
```
    baw_configuration:
    - name: bawins1
      custom_xml_secret_name: custom-liberty-xml-secret
```
You can also modify Business Automation Workflow Runtime configuration properties in a 100Custom.xml file.
1. Create a 100Custom.xml file with the snippet you want.
  For more information, see Creating a 100Custom.xml configuration file.
2. Create a secret with the file, such as lombardi-custom-xml-secret, using the following command.
```
kubectl create secret generic lombardi-custom-xml-secret --from-file=sensitiveCustomConfig=./100Custom.xml
```
3. In the CR, set the lombardi.custom_xml_secret_name property, as shown in this example snippet.
```
    baw_configuration:
    - name: bawins1
      lombardi_custom_xml_secret_name: lombardi-custom-xml-secret
```
After you modify the CR file, you must update your deployment to have it take effect. Follow the instructions in Updating script-installed deployments .
When you are making a Liberty customization, check that the Workflow server pod picks up the changes after it restarts. After the reconciliation takes effect (which usually takes 30 minutes to an hour, but can take longer), the XML file can be found at this location inside the pod.
```
cd /opt/ibm/wlp/usr/shared/resources/sensitive-custom/
```
To verify the 100Custom.xml settings, check for the files on the server pods. For more information, see Location of 100Custom configuration files.