Installing on a distributed Linux® environment with Docker or Podman Compose

Edit online

You can install the Z APM Connect Distributed Gateway (DG) images on a single machine using Docker or Podman Compose. To configure Z APM Connect DG, you must fill the details in the inputs.env file and run the ./standalone.sh script along with command line arguments. The installation is suitable for a sandbox environment or proof of concept. However, it has limited scalability so unable to meet the requirements for a production environment.

Prerequisites

Edit online

  • Docker with Ubuntu or SUSE

  • Podman compose with RHEL

For more information, see Prerequisites and system preparation

Note:

Run the systemctl enable --now podman-restart command to start the podman-restart service that will restart the containers when the machine restarts.

Procedure

Edit online

Perform the following high-level tasks to install, configure, and start Z APM Connect DG.

  1. Download <6.2.0>-ZAPM-FP<version_number>.tar.gz from IBM Fix Central.

  2. Create the installation directory: $HOME/ibm/zapm.

  3. Move the archive file <6.2.0>-ZAPM-FP<version_number>.tar.gz to the installation directory that you create and navigate to it.

  4. Extract the archive file to begin the installation. Following is the directory structure:

    ├── images  
│   ├── kafka+<version_number>.tar  
│   ├── redis+<version_number>.tar  
│   ├── zapm-instana-exporter+<version_number>.tar  
│   └── zapm-transaction-processor+<version_number>.tar  
├── cluster  
│   ├── saveZapmClusterLogs.sh  
│   ├── values.yaml  
│   └── zapm-dg-<version_number>.tgz  
└── standalone  
    ├── inputs.env  
    ├── saveZapmStandaloneLogs.sh  
    ├── standalone.sh  
    └── config  
        ├── docker-compose.yml  
        ├── instana-exporter.yml  
        ├── otel-exporter.yml  
        ├── redis.conf  
        ├── ttg.yml  
        └── security
            ├── tls.yml
            ├── appd-tls.yml
            ├── instana-tls.yml
            └── otel-tls.yml

    Note:

    • <version_number> specifies the supported version of the applications.

    • If the archive file does not consist of all the files listed above, then download the file again.

    • The files in the configuration folder are a requirement for advanced configuration. To make any changes, you must contact the IBM support.

  5. Fill the details in the inputs.env file to configure the Z APM Connect DG. For more information, see Populating inputs.

  6. Run the ./standalone.sh start command to start the Z APM Connect DG. The system loads the Z APM Connect DG images.

  7. Run the ./standalone.sh restart command to safely apply configuration or security changes to Z APM Connect DG and recover from issues, if any.

  8. Run the ./standalone.sh status command to ensure each component is up and functioning before operations or troubleshooting the Z APM Connect DG.

  9. Run the ./standalone.sh stop command to stop the Z APM Connect DG.

Configuration example

Edit online
mkdir $HOME/ibm/zapm
mv ./{ARCHIVE_FILE} $HOME/ibm/zapm
cd $HOME/ibm/zapm
tar xvzf {ARCHIVE_FILE}
vi inputs.env
./standalone.sh start

Logging

Edit online

To capture the logs run the ./saveZapmStandaloneLogs.sh command. The system creates a zapm-logs folder that contains logs from the Z APM containers.

Security

Edit online

To enable Transport Layer Security (TLS) for a standalone DG, it requires the keystore and truststore in the .jks format. For information about the inputs for the TLS section, see Populating inputs.

Requirements:

  • Access to the filepath and password for each keystore and truststore.

  • Access to the relevant certificate to enable TLS on the APM backend.