Post-installation configuration of the software containers

The software containers use the configuration file ZOA_HOME/zoa_env.config. This file is created by the installation process as a read-only file (file permission 400) that is owned by the user ID that was used to run the installation process. After the initial installation, you must verify or update some configuration properties in the ZOA_HOME/zoa_env.config file before you start the software services.

Location of configuration files

The configuration files that are used by the software container-based components are in OCI volume storage. These configuration files are not directly accessible to the system administrator; do not attempt to modify them directly.

The following configuration files, which are required by the Z operational analytics management scripts (dockerManageZoa.sh and podmanManageZoa.sh) and provide external control over the software container-based components are in the host file system:
zoa_env.config
In the zoa_env.config file, the configuration properties are organized in sections according to the functions that the properties support. The file includes comments that describe each property and how to set the appropriate property values. The password values in zoa_env.config must be encoded, and the comments in the file include instructions for encoding the value of each password property.
.zoa_factory.config
Do not update the .zoa_factory.config file, except at the request of IBM® Support.

Some configuration property values to verify

Ensure that the following configuration properties are set appropriately for your environment. If you need to change the values of any of these properties, run one of the following commands after you save and close the configuration file:
Docker:
./bin/dockerManageZoa.sh up
Podman:
./bin/podmanManageZoa.sh down
./bin/podmanManageZoa.sh up
IZOA_GATEWAY_PORT

This property determines the gateway (reverse proxy) service port.

During installation, it is assigned the value 8085, but you can change it to any other available port after the installation completes.

Note that the Linux operating system does not allow processes started under non-root user IDs to bind ports with a value of less than 1024.

ZAIOPS_KAFKA_BOOTSTRAP_SERVER_PORT

This property determines the non-TLS port for the Kafka broker.

During installation, it is assigned the value 9092, but you can change it to any other available port after the installation completes.

ZAIOPS_KAFKA_BOOTSTRAP_SERVER_SSL_PORT

This property determines the TLS port for the Kafka broker.

During installation, it is assigned the value 9093, but you can change it to any other available port after the installation completes.

DISCOVERY_AGENT_COUNT

This property specifies the number of discovery agents that will connect to the gateway service. It controls the number of concurrent connections the gateway service will allow on the ZRDDS route. If the value of this property is set lower than the actual number of discovery agents that attempt to connect at the same time, then some of the discovery agents may have their connection attempts denied.

DISCOVERY_SCENARIO
This property enables you to prevent software containers from running if they are not needed for a specific ZRDDS deployment scenario.

There are two supported scenarios:

  • ALL:

    All ZRDDS-related containers will be allowed to run.

    This is the default configuration. It is required when integrating with the ServiceNow CMDB.

  • NO_SNOW:
    The following ZRDDS-related containers will not be allowed to run:
    • zrdds-kafkaconnect
    • zrdds-kafkabridge

    This configuration is useful when integrating with Z Anomaly Analytics but not with the ServiceNow CMDB, as Z Anomaly Analytics integration does not require the use of these two containers.

Configuration after software container startup

Once all updates to the <ZOA_HOME>/zoa_env.config are completed, perform the following steps to start the software containers and perform a single post-startup configuration action:
  1. Start the software containers:
    Docker
    cd <ZOA_HOME>
./bin/dockerManageZoa.sh up
    Podman
    cd <ZOA_HOME>
./bin/podmanManageZoa.sh up
  2. Perform mandatory post-startup configuration for the ZRDDS core service:
    Docker
    ./bin/dockerManageZoa.sh config-ztopology
    Podman
    ./bin/podmanManageZoa.sh config-ztopology