Configuring an integration node by modifying the node.conf.yaml file
You can configure an integration node by setting properties in the node.conf.yaml configuration file for the integration node.
Before you begin
About this task
When you create an integration node, a default node.conf.yaml configuration file is created automatically for the integration node and stored in the working directory for the integration node; for example: C:\ProgramData\IBM\MQSI\components\acev11node\node.conf.yaml. You can then configure the operation of the integration node and associated resources, by modifying properties in the node.conf.yaml file. For example, you can set a REST administration port and an HTTPS port, you can enable administration security, and you can configure the trace level, activity logging, JVM, and the reporting of statistics and accounting data.
When you create an integration node, an overrides subdirectory is also created under the integration node's working directory. This overrides directory contains an additional node.conf.yaml configuration file, which contains property values that are set by IBM App Connect Enterprise commands, including the mqsicreatebroker command. These values override any values that are set for the same properties in the integration node's base node.conf.yaml file.
commands are run that modify settings for the integration node, those
modified settings are saved in a node.conf.yaml file
in the overrides directory (for example,
a property has been set in the integration node's base node.conf.yaml file,
and also in the overrides directory (
the property value that has been set in the overrides directory is
used. Therefore, if an integration node does not appear to be using
the settings that you would expect, check the node.conf.yaml file
in the overrides directory to see if your expected property value
has been overridden by a command. If you want to manually override
the settings that have resulted from a command, you can either edit
the property in the node.conf.yaml file in the
overrides directory, or you can remove the entry from the overrides
directory and modify the base node.conf.yaml file
When you create integration servers that are owned by the integration node, a default server.conf.yaml configuration file is created for each of the integration servers, and they are stored in the file system in subdirectories below the integration node directory. Any properties that you set for the integration node, in the node.conf.yaml file, are inherited by the integration servers that it owns. However, you can change any of the integration server properties by modifying them in the appropriate server.conf.yaml file. For more information about configuring integration servers that are managed by an integration node, see Configuring an integration server by modifying the server.conf.yaml file.
Change the properties of an integration node, by following these steps:
- Use a YAML editor to open the node.conf.yaml file
for the integration node that you want to modify.
If you do not have access to a YAML editor, you can edit the file by using a plain text editor; however, you must ensure that you do not include any tab characters, which are not accepted in YAML and will cause your integration node configuration to fail. If you choose to use a plain text editor, ensure that you use a YAML validation tool to validate the content of your file.
For more information about working with YAML, see http://www.yaml.org/start.html.
- Modify the properties that you want to change:
- Set the administration REST API port for the App Connect Enterprise web user interface and the App Connect Enterprise Toolkit, by setting a value
for the port property. You can leave this property
set to the default value of
- Specify a value for the host property.
- Enable authentication for the integration node, by setting
the basicAuth property to
- Enable administration security and specify an authorization
mode, by setting the adminSecurity and authMode properties.
adminSecurity: active authMode: file
- You can also modify properties to enable the integration node listener, to configure the MQTT server, and to specify a default queue manager.
- Set the administration REST API port for the App Connect Enterprise web user interface and the App Connect Enterprise Toolkit, by setting a value for the port property. You can leave this property set to the default value of
- Specify the security credentials to be used by the integration node when connecting to a secured resource (such as a database) by using the mqsisetdbparms command. When you run this command, the user ID and password are stored securely in the IBM App Connect Enterprise credentials store. For more information about using this command, see mqsisetdbparms command.
- Restart the integration node. The properties that you set in the node.conf.yaml file take effect when the integration node is started. If you modify these properties again, you must start the integration node again for the latest changes to take effect. For more information, see Starting and stopping an integration node.