Simplify Packaging of Z Understand and Refactor Containers

This procedure describes how to extract, configure, start, stop, and uninstall the combined package for Z Understand and Refactor containers.

Obtain and Extract the Package

  1. Download the combined package archive from the artifact repository

    For example, bobz-combined-package.tar.gz

  2. Extract the archive:
    tar -xf <package-name>.tar.gz
  3. Navigate into the extracted directory:
    cd <extracted-folder-name>
    For example, if the folder name is bobz:
    cd bobz

Prepare Configuration (setup.json)

  1. Inside the directory, you will find sample configuration files:

    • setup.sample.db2.json
    • setup.sample.sqlserver.json
  2. Choose the appropriate configuration file based on your database type:

    • For DB2:
      cp setup.sample.db2.json
    • For SQL Server:
      cp setup.sample.sqlserver.json
  3. Create a copy of this file and name it as setup.json.
  4. Open setup.json and update the required values:

    • Database connection details
    • Credentials
    • Environment-specific configurations

Start the Application

  1. Run the startup script:
    ./start.sh -c setup.json
    The script starts:
    1. Understand container
    2. Refactoring Assistant container
    Containers are orchestrated automatically in sequence.
  2. Verify that all containers are running:
    podman ps -a
    Ensure that all Z Understand and Z Refactoring Assistant containers are in the Up state.
  3. You can access the Z Understand UI dashboard.
  4. Configure the certificate in Z Refactoring Assistant:

    • Navigate to Servers and Security
    • Upload and configure the required certificate (root.crt)
  5. Create and build projects in the following directory: /root/understand/.

Note: Certificates are created in /root/bobz/understand/security/ra (and its symlink is created in/root/bobz/security).
Note:

Stop the Application

To stop both running containers:
./stop.sh
  1. The script stops:
    1. Understand container
    2. Refactoring Assistant container

Uninstall the Package

To completely remove deployment, containers, and associated data, run:
./uninstall.sh -fa
-fa ensures full cleanup.