Installing and configuring the software containers

The software containers include 1) the Resource Discovery and Data Service and 2) the common services, which are required by IBM Z® Resource Discovery Data Service but also shared with other IBM Z Airdrops software products. For certain deployment scenarios, additional software container images can be installed using the same procedure. For example, if you plan to deploy ZRDDS for integration with IBM Z Anomaly Analytics, the Z Anomaly Analytics software container images will be installed as part of the same procedure. To install the software containers, you can use either the Docker or Podman container management tool. A separate deployment utility is provided for each of these container management tools.

Before you begin

Review Planning for deployment. Prepare the installation media, as described in Preparing installation media for Z Resource Discovery Data Service and Z Operational Analytics common components.

Procedure

Complete the following steps to install the software containers:

  1. Log in with the zoauser user ID.
  2. In the temporary installation directory, go to the zoacommon subdirectory, as shown in the following example: 
    
cd temp_install_dir/zoacommon
  3. Start the installation process by using one of the following commands, depending on the container management tool that is used:
    Docker
    ./dockerDeployZoa.sh --install
    Podman
    ./podmanDeployZoa.sh --install
  4. From the feature menu, select the features you wish to install.
    Note:
    • If IBM Z Resource Discovery Data Service is a required component of any of the other features available for installation, it will not be listed separately on the feature menu. Instead, it will be automatically installed as part of the dependent feature.
    • In all other scenarios, If IBM Z Resource Discovery Data Service will be listed as a separately selectable feature on the feature menu.
  5. At the installation directory prompt, specify the directory into which you want to install the features.

    This directory will be referred to as <ZOA_HOME> for the remainder of this document.

Results

If the software containers were installed successfully, messages similar to the following are shown. The directory /home/zoauser/ZOA/runtime in the following message blocks will be replaced with the directory that you specified for ZOA_HOME during the installation.
Docker

All Common Services images were loaded successfully.
[...]
All Log-Based Machine Learning images were loaded successfully.
[...]
All Metric-Based Machine Learning images were loaded successfully.
[...]
All Z Resource Discovery services images were loaded successfully.
[...]
Command to start the installed features:
    cd /products/IBM/ZOA
    ./bin/dockerManageZoa.sh up

A copy of this script (dockerDeployZoa.sh) can be found in /products/IBM/ZOA/bin for future use.
Podman

All Common Services images were loaded successfully.
[...]
All Log-Based Machine Learning images were loaded successfully.
[...]
All Metric-Based Machine Learning images were loaded successfully.
[...]
All Z Resource Discovery services images were loaded successfully.
[...]
Command to start the installed features:
    cd /products/IBM/ZOA
    ./bin/podmanManageZoa.sh up

A copy of this script (podmanDeployZoa.sh) can be found in /products/IBM/ZOA/bin for future use.
Important:

During the installation, a copy of the dockerDeployZoa.sh or podmanDeployZoa.sh script is put in the ZOA_HOME/bin directory. You can use this script to remove the IBM Z Resource Discovery Data Service in the future, if necessary.

During the installation process, the following files are copied to the ZOA_HOME directory:
  • zoa_env.config file
  • .zoa_factory.config file
  • Multiple *-docker-compose.yml files
  • bin/dockerManageZoa.sh or bin/podmanManageZoa.sh
  • Helper scripts for bin/dockerDeployZoa.sh and bin/podmanManageZoa.sh are copied into subdirectories of the ZOA_HOME/bin directory.

These files are important for the configuration and operation of the software containers.

Also, the installation process creates directories for the log files of the software container-based services, generates self-signed artifacts that are needed to enable TLS communication with external components, and performs the basic configuration of the product components.

What to do next

See Post-installation configuration of the software containers for information about the configuration parameters that you must verify or update in the ZOA_HOME/zoa_env.config configuration file.