Docker Configuration Properties

Introduction

Zetaly provides a global configuration file called zetalyinstall.cnf which contains all the necessary properties to perform a default installation under Docker. Before executing the run.sh script, you must define the values for the properties in the zetalyinstall.cnf file according to this article.
In some cases you may need to customize your installation to support your installation environment. Examples include, but are not limited to the following:

• needing to change the default port of one or more Zetaly modules to avoid port clashes with other services that are already using the same port,
• changing the default log level of the Zetaly modules,
• installing the different Zetaly modules on different Docker containers,

To customize your installation under Docker you must add additional properties at the end of the zetalyinstall.cnf file before executing the run.sh script.

Custom Configuration Properties

The table below summarizes the properties that you can add into the zetalyinstall.cnf file to customize your installation.
Each line you add for a property in the zetalyinstall.cnf file overrides the zetalyinstall.sh script's default value with the value that you specify. Each line you add must take the following format, where the custom.property and custom value you define are seperated by an equals symbol (=).

custom.property   =   custom value

Some properties can be customized individually, while other groups of properties must be customized together (as they have interdependencies). For examples of when groups of properties must be customized together, see Customization Examples.
You can also add comments using the hash symbol (#) to describe your custom installation properties.

############################################
#       Custom Installation Properties     #
############################################
custom.property.1  =   custom value 1
custom.property.2  =   custom value 2
custom.property.3  =   custom value 3

Customization Examples

This section describes some examples of adding additional properties at the end of the zetalyinstall.cnf file for different customization scenarios.

Resolving Port Clashes With Zetaly Modules

The table below summarizes the default port numbers and their associated properties for each of the Zetaly modules.

In our example, the server that will have Zetaly installed has services already using ports 11010 and 11060.
By default the ZSA module also uses port 11010. To avoid a port clash between the ZSA module and the other service using port 11010, you must change the ZSA module to another unused port (for example 11015).
By default the ZHB module also uses port 11060. To avoid a port clash between the ZHB module and the other service using port 11060, you must change the ZHB module to another unused port (for example 11065).
In this case you would create the following section at the end of the zetalyinstall.cnf file.

#################################################################
#     Custom ports for Zetaly modules to avoid port clashes     #
#################################################################
Backend.ZSA.Port              =       11015
Backend.ZHB.Port              =       11060  

Changing the Default Log Level of the Zetaly Modules

The table below summarizes the default log levels, possible log levels and their associated properties for each of the Zetaly modules.

In our example we want to change the default log levels of the ZHB, ZUP and ZQM modules from INFO to Warning.
In this case you would create the following section at the end of the zetalyinstall.cnf file.

############################################################
#                     Custom Log Levels                    #
############################################################
Backend.ZHB.LogLevel              =      WARN
Backend.ZUP.LogLevel              =      WARN
Backend.ZQM.LogLevel              =      WARN

Configuring Zetaly Module Addresses for the FrontalWeb Component in a Distributed Deployment

By default all the Zetaly modules (except the ZAC module) are installed on the same Docker container. As a result, the address used by the FrontalWeb component to internally access the each of the Zetaly modules is set as summarized in the table below.

If you want to install the Zetaly modules on different servers, you must update these properties to match the IP addresses of the Docker containers on which they are installed, and have each of the Docker containers use the same proxy.
In our example, the Zetaly modules are installed on three different Docker containers as summarized in the table below.

In this case you would create the following section at the end of the zetalyinstall.cnf file.

############################################################
#                Distributed Module Addresses              #
############################################################
Backend.ZCC.Host              =      10.0.0.1
Backend.ZRP.Host              =      10.0.0.2
Backend.MYZ.Host              =      10.0.0.1
Backend.ZDE.Host              =      10.0.0.1
Backend.ZSA.Host              =      10.0.0.3
Backend.ZSAC.Host             =      10.0.0.1
Backend.ZHB.Host              =      10.0.0.1
Backend.ZUP.Host              =      10.0.0.1
Backend.ZQM.Host              =      10.0.0.1
Backend.ZCO.Host              =      10.0.0.1
Backend.ZDC.Host              =      10.0.0.1

You would also need to configure the three Docker containers to use the same proxy by defining the proxy in the ~/.docker/config.json Docker file. For more information, see this Docker article.

Editing the run.sh Script

The run.sh script contains properties to determine which of the Zetaly modules are installed, and whether the OrientDB database is installed and used. It is pre-configured according to your installation package. Typically you do not need to edit this file unless you run into installation problems.
If you run into installation problems, you can edit the run.sh script accordingly to match your installation package's requirements.

The example below shows a run.sh script for an installation which has the following modules installed:

• Frontal (always required as it provides access to the Zetaly Portal).
• MYZ (required because ZCC is going to be installed, which needs the MyInfrastructure functionality of MYZ)
• ZRP
• ZCC
• ZSA (always required as it provides the Streaming Agent which is used to collect data from the mainframe).
• ZHB (always required as it provides the user management functionality within the Zetaly Portal).

#!/bin/bash
# 0 = false, 1 = true. Adapt the flags to your needs
cnf_file=$(pwd)/zetalyinstall.cnf
install_frontal=1
install_myz=1
install_zrp=1
install_zde=0
install_zcc=1
install_zsa=1
install_zhb=1
install_zup=0
install_zco=0
install_orientdb=0
install_zqm=0
install_zdc=0
# Use to set the front permissions when only zsi is deployed
zsi_only=1
bash ./zetalyinstall.sh \
    $cnf_file \
    $install_myz \
    $install_zrp \
    $install_zde \
    $install_frontal \
    $install_zsa \
    $install_zcc \
    $install_zhb \
    $install_zup \
    $install_zco \
    $install_orientdb \
    $install_zqm \
    $install_zdc \
    $zsi_only