Installing dashboard container for graph functionality


This topic describes how to install and run the dashboard container for the optional graph functionality.

For system requirements, see Requirements.

Related topic

To install the dashboard container on zLinux or zCX 

Use the following procedure to install the dashboard container when BMC AMI Ops Insight is already installed:

  1. Rerun the configuration part of the installation.
    For more information about configuration, see Installing BMC AMI Ops Insight.
  2. On the BMC AMI Ops Insight product options panel:
    1. Set Configure docker parameters to Y.
    2. On the next page, enter the Docker properties.
    3. Complete the configuration to generate the configuration jobs. 
  3. Run the generated AMIFTPG job to transfer the dashboard container tar files and run script on zCX or zLinux.

For more information about zCX, see the IBM document Getting started with z/OS Container Extensions and Docker.

Warning

Important

We do not back up data from the Time Series database related to dashboard container.

To install the dashboard container on Linux

Use the following procedure to install the dashboard container when installing BMC AMI Ops Insight.

Warning

Important

Use this procedure only if you are installing the Docker container for the optional graphing feature on Linux.

  1. On the BMC Support Central(EPD) website, select BMC AMI Ops Insight.

  2. Click Docker Container for BMC AMI Ops Insight Version 2.5.00 (Linux on x86) to download the token file.
  3. Select the Docker Container for BMC AMI Ops Insight Version 2.5.00 (Linux on x86) check box and click  Download to download the script.
  4. Move the downloaded token and script files to the target Linux system.
  5. Use the following command to make the script file executable:

    sudo chmod +x container-shell-lpqmb2.5.00.sh

To run a dashboard container

  1. (Optional if using HTTP) Create an SSL certificate to start the dashboard container. For more information, see Enabling TLS authentication between BMC AMI Manager and Docker.
  2. Run the dashboard container, use one of the following commands to start Docker:
    • On zCX

      Action

      Protocol

      Command

      To start a container in non-secure mode

      HTTP

      ./run.sh

      To start a container in secure mode

      HTTPS

      ./run.sh crt=<crtFilePath> key=<keyFilePath>
      For example: ./run.sh crt=certificate.crt key=private.key

      In this command:

        • <crtFilePath> is the path of the certificate file.
        • <keyFilePath> is the path of the key file.
    • On Linux

      Action

      Protocol

      Command

      To start a container in non-secure mode

      HTTP

      ./container-shell-lpqmb2.5.00.sh u=<EPD_Username>

      To start a container in secure mode

      HTTPS

      ./container-shell-lpqmb2.5.00.sh u=<EPD_Username> crt=<crtFilePath> key=<keyFilePath> 
      For example: ./container-shell-lpqmb2.5.00.sh u=somebody crt=certificate.crt key=private.keyIn this command:

        • <EPD_Username> is the username used to login in EPD.
        • <crtFilePath> is the path of the certificate file.
        • <keyFilePath> is the path of the key file.
  3. To connect BMC AMI Manager and the Docker containers, update the amipdt.properties file in the aoidata/aoiinst/conf directory by using the following parameters:  

    Parameters

    Description

    DOCKER_HOST= <docker host name>

    zCx or zLinux host name

    DOCKER_PORT=48949

    Default port number of the BMC AMI Ops Insight time series database

    postgre_host=<docker host name>  

    zCx or zLinux host name

    postgre_port=5433     

    Default port number of the BMC AMI Ops Insight Postgre DB

    DOCKER_PROTOCOL

    HTTP or HTTPS

  4. Restart BMC AMI Manager.

To check logs, status, and file system information in a dashboard container

The following table describes the dashboard container commands:

Action

Command

To list the available images

docker images

To list the running containers

docker ps

To stop a running container

docker stop <container-name>

To remove a running container from memory

docker rm <container-name>

To check container logs if everything started successfully

docker logs <container-name>

To check docker container system information

docker stats
docker system df -v

To run the BMC AMI Ops Insight Docker container on an existing zCX or zLinux installation environment

  1. Use the Installation System configuration panel to generate the FTP job (AMIFTPG) or manually copy the FTPGRAPH member from BMCSAMP or PDRSAMP to UBMCSAMP.
  2. Configure the FTP job as follows:

    Command

    Description

    SET TGTHLQ='#tgthlq' 

    HLQ of the BMCTAR or PDRTAR

    SET AOIHOME='#instpath/aoihome' 

    BMC AMI Ops Insight aoihome path name (used as temporary storage)

    SET DKRHOST='#drdkhost'    

    zCX/zLinux host name

    SET DKRSFTP='#drdksftp' 

    zCx/zLinux SFTP port number

    The default port number is 22.

    SET DKRUSER='#drdkuser'    

    User ID for zCX or zLinux used to transfer the required files via the FTP

    SET DKRPSWD='#drdkpswd'

    User ID password

    SET DKRHOME='#drdkhome' 

    Directory on zCX or zLinux to store BMC AMI Ops Insight Docker containers

    (Optional) SET USRCERT='#drdkcert' 

    User certificate for BMC AMI Ops Insight Docker containers

    (Optional) SET PRIVKEY='#drdkpkey' 

    Private key for BMC AMI Ops Insight Docker containers

    Warning

    Important

    For zLinux, download and install the Docker software from the IBM website.

  3. Run the FTP job to transfer the container tar files and run the script from the BMC AMI Ops Insight BMCTAR or PDRTAR data set to their zCX or zLinux instances.
  4. Run the run.sh script to start the Docker containers.
    For example,

    • ./run.sh (when using HTTP)
    • ./run.sh crt=<crtFilePath> key=<keyFilePath> (when using HTTPS)
  5. To connect BMC AMI Manager and the Docker containers, update the amipdt.properties file in the aoidata/aoiinst/conf directory by using the following parameters:  

    Parameters

    Description

    DOCKER_HOST= <docker host name>

    zCx or zLinux host name

    DOCKER_PORT=48949

    Default port number of the BMC AMI Ops Insight time series database

    postgre_host=<docker host name>  

    zCx or zLinux host name

    postgre_port=5433     

    Default port number of the BMC AMI Ops Insight Postgre DB

    DOCKER_PROTOCOL

    HTTP or HTTPS

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC AMI Ops Insight 2.5