server.conf.yaml type

Use the server.conf.yaml type to create configurations that use the server.conf.yaml file to configure the operation of the integration runtime and its associated resources.


Summary of key details for the configuration type

File name or type Contains secrets Path extracted/imported to Maximum allowed per integration runtime
server.conf.yaml No /home/aceuser/ace-server/overrides/server.conf.yaml 1

About the server.conf.yaml file

The server.conf.yaml type requires a server.conf.yaml file that the integration runtime can use.

The file is placed in the overrides directory for the running runtime, so any default values that are set for the integration runtime container are overridden by the values that are set in this file. The server.conf.yaml file contents are identical to the contents of the file that is used in IBM® App Connect Enterprise software and no enforced limit exists on what properties can be set.

Restriction:

In the server.conf.yaml file, you can use the Log section to configure logging for BIP messages. For an independent integration server in App Connect Enterprise, the eventLog property, which controls outputting BIP messages to event log files, uses a default location of $workdir/log, where $workdir is the integration server work directory. In the server.conf.yaml file, this default location is depicted as [iib.system-work-dir]/log, as shown in the following example.

Log:
  eventLog: '[iib.system-work-dir]/log/[iib.system-node-label].[iib.system-server-label].events.txt'     # Control writing 
  BIP messages to file. Set to '' to disable, default is as shown.

In App Connect Enterprise, you can set the eventLog property to any log directory of your choice. However, if you are using a server.conf.yaml file to create a configuration object in your containerized environment, and you want to use the eventLog property to set a log directory, only the following substitutions can be specified as the starting location:

  • [iib.system-work-dir] (default starting location that resolves to /home/aceuser/ace-server in the container file system)
  • [iib.system-node-label]
  • [iib.system-server-label]
  • [iib.system-common-log-dir]

Only one server.conf.yaml file can be specified per integration runtime.

You can obtain a copy of the server.conf.yaml configuration file from the /home/aceuser/ace-server directory in the pod, or from the local directory installDir/server/sample/configuration where IBM App Connect Enterprise Toolkit is installed. For example, on Windows, the path is C:\Program Files\IBM\ACE\12.0.7.0\server\sample\configuration. A sample file is provided in the attached .zip archive for reference (server.conf.zip).

For more information about how to modify the server.conf.yaml file, see Configuring an integration server by modifying the server.conf.yaml file.

Note: In App Connect Dashboard instances at version 13.0.6.1-r1 or later, you can also build a configuration from scratch by using the built-in server configuration builder to specify your server.conf.yaml properties.

Creating a configuration for the server.conf.yaml type by using the configuration panel in version 13.0.6.1-r1 or later Dashboard instances

When you create a server.conf.yaml-type configuration from the configuration panel in the App Connect Dashboard, you can either upload an existing server configuration YAML file (server.conf.yaml) or build a configuration from scratch by using the server configuration builder. The ability to build a configuration from scratch is available only in App Connect Dashboard instances at version 13.0.6.1-r1 or later.

You can create a server.conf.yaml-type configuration when you create an integration runtime, or independently, as follows.

  1. Open the Configuration page by clicking the Configuration icon Configuration icon in the navigation pane, or go to the Configuration view of an integration runtime that you are creating. Then, click Create configuration. For more information, see Managing configuration objects from the Configuration page.
  2. From the Create configuration panel, select server.conf.yaml from the Type list.
  3. In the Name field, specify a name for this configuration.
  4. In the Description field, specify text that will help you identify the integration runtime that will use the server.conf.yaml file or the defined properties.
    Create configuration panel

    From the Add or build server configurations section, you can choose whether to upload an existing server configuration YAML file (server.conf.yaml) or to build a configuration from scratch.

  5. To upload an existing server configuration YAML file and then create the configuration object, complete either of the following steps:
    1. Import an existing server.conf.yaml file by clicking within the boxed area to select the .yaml file from a file browser, or by dragging-and-dropping the file. The file name is listed.
      Imported YAML file
    2. To review the server configuration settings that are uploaded from the file, click Edit configuration to display these settings in the server configuration builder.

      The fields are shown in the Form view by default, but you can switch to YAML view if preferred. Field descriptions and tooltips provide guidance in the Form view. To switch between views, use the Form view or YAML view button Form view and YAML view buttons. You can also optionally update the configuration settings. Then, click Save to save any changes or click Cancel to close without saving.

      Server configuration settings for an imported YAML file in the server configuration builder

      You return to the Create configuration panel.

    3. Click Create. The configuration is added to the configurations table and can be selected for use with an integration runtime.
  6. To build a server configuration file from scratch in the server configuration builder and then create the configuration object, complete the following steps:
    1. Click Build from scratch to create a server configuration.
      "Build from scratch" button in the "Add or build server configurations" section

      The server configuration builder opens within the Build server configuration panel with the configuration fields on display in Form view. Field descriptions and tooltips provide guidance in the Form view. You can use the Form view and YAML view buttons Form view and YAML view buttons to switch from one view to another.

      "Build server configuration" panel with the server configuration fields
    2. Complete the fields with your preferred values and click Save to return to the Create configuration panel.
      Tip: If you decide to further update your server configuration before you create the configuration object, you can click the Edit configuration button to return to the server configuration builder to make those changes.
    3. Click Create. The configuration is added to the configurations table and can be selected for use with an integration runtime.

Creating a configuration for the server.conf.yaml type by using the configuration panel in version 13.0.6.0-r1 or earlier Dashboard instances

You can create a server.conf.yaml-type configuration when you create an integration runtime, or independently, as follows.

  1. Open the Configuration page by clicking the Configuration icon Configuration icon in the navigation pane, or go to the Configuration view of an integration runtime that you are creating. Then, click Create configuration. For more information, see Managing configuration objects from the Configuration page.
  2. From the Create configuration panel, select server.conf.yaml from the Type list.
  3. In the Name field, specify a name for this configuration.
  4. In the Description field, specify text that will help you identify the integration runtime that will use this server.conf.yaml file.
    Create configuration panel
  5. Complete the server.conf.yaml section by completing either of the following steps:
    • Copy the contents of your modified server.conf.yaml file and then paste it into the server.conf.yaml text editor.
      server.conf.yaml text editor with pasted contents
    • Import your modified server.conf.yaml file from your file system:
      1. Click the Import serverconf file icon Import icon.
      2. Click within the boxed area to select the file from a file browser, or drag-and-drop the file.
        Import server.conf.yaml view

        The content of the server.conf.yaml file is displayed.

        server.conf.yaml text editor with imported contents
  6. Click Create. The configuration is added to the configurations table and can be selected for use with an integration runtime.

Updating or deleting a configuration

If you need to update the content or settings in a configuration, or delete a configuration that's no longer needed, see Managing configuration objects from the Configuration page.

In App Connect Dashboard instances at version 13.0.6.1-r1 or later, you can also update a server.conf.yaml configuration as follows:

  1. From the Configuration page, open the options menu for that configuration object and click Update to open the Update configuration panel.
    "Update configuration" panel
  2. Click the Edit configuration button to use the server configuration builder to update the fields in the Build server configuration panel.
  3. Click Save to save your updates.
  4. From the Update configuration panel, click Update to save the configuration object.