Customizing the IBM App Connect server.conf.yaml configuration

Configure and customize the server.conf.yaml file for IBM® App Connect integration runtime instances by using ConfigMaps

About this task

The server.conf.yaml file defines runtime configuration for IBM App Connect integration servers. It is deployed to the IBM App Connect server containers by using a server.conf.yaml configuration instance. For more information, see server.conf.yaml type

Note:

During deployment, all IBM App Connect runtime instances use the default configuration defined in the server.conf.yaml file.

After deployment, you can customize the configuration in the following ways:
  • Edit the existing server.conf.yaml in the default ConfigMap (<ftm-instance-name>-ace-server-config).
  • Create a new ConfigMap with a custom server.conf.yaml and apply it to the required IBM App Connect runtime instance in the FTM Custom Resource (CR).
Customizing the default server.conf.yaml configuration
  • To update the default server.conf.yaml file for all IBM App Connect runtime instances, edit the default ConfigMap: <ftm-instance-name>-ace-server-config
    Note: The default FTM server.conf.yaml is shared across all IBM App Connect runtime instances. Any changes made impact all deployed instances after restart.

Procedure

  1. Create a configMap with a custom server.conf.yaml file. The custom configMap must have the file content in key-server.conf.yaml 
    
kind: ConfigMap
apiVersion: v1
metadata:
  name: <custom-configmap-name>
  namespace: <namespace-name>
data:
  server.conf.yaml: |
    additionalSharedClassesDirectories: '/home/aceuser/ace-server/shared-classes'
    remoteDefaultQueueManager: '{defaultPolicies}:MQEndpoint'

    Credentials:
      userRetrievableCredentialTypes: 'ALL'

    Defaults:
      policyProject: 'defaultPolicies'

    BrokerRegistry:
      mqKeyRepository: /home/aceuser/keystores/keystore
      mqCCDT: '/home/aceuser/ace-server/mqccdt/mqccdt.json'

    StartupScripts:
      SetFTMudn:
        command: '/home/aceuser/generic/ftm_udn.sh'
      SetFTMssl:
        command: '/home/aceuser/generic/ftm_ssl.sh'
  2. Update the FTM Custom Resource (CR) to modify the default IBM App Connect integration runtime instances with custom server.conf.yaml 
    
spec:
  config:
    ace:
      integrationRuntimes:
        - name: ace-cbprplus-epw
          serverConfigMapName: ace-server-custom-config
  3. Apply a global configuration with exceptions for specific runtime instances. 
    
spec:
  config:
    ace:
      integrationRuntimes:
        - name: ace-cbprplus-epw
          serverConfigMapName: ace-server-custom-config
        - name: default
          serverConfigMapName: ace-server-custom-config-global
    In this example:
    • ace-server-custom-config-global is applied to all runtime instances
    • ace-cbprplus-epw is an exception and uses: ace-server-custom-config

Results

After completing this task:

  • The specified integration runtime instances are configured using the custom server.conf.yaml.
  • Global configuration is applied to specific runtime instances.

What to do next

  • Restart the integration runtime instances to apply the configuration changes.
  • Verify that the updated configuration is correctly applied by checking runtime logs and behavior.