21.1. Installation Process #

To use PPEM in containerized environments:

  1. Create a container image with the manager.

  2. Create new DBMS container images or modify the existing ones to integrate the agent into the images, so that the DBMS can be monitored and managed by PPEM.

    A service manager must be used as the default executable for the image, as the agent and the DBMS server will be simultaneously running inside the container.

  3. Configure container networking for the agents to be reachable by the manager, and vice versa:

    1. If containers with agent and manager services are planned to be placed in the different networks or on the different hosts, then ensure that the containers are not behind NAT and reachable via their IP addresses.

      For example, with Docker, the overlay or macvlan network drivers can be used.

    2. Adjust network traffic policies, if any, to allow PPEM traffic.

      For more information about the PPEM networking requirements, refer to the Security section.

  4. Get an API key to configure agents:

    1. Start a container with the manager service.

    2. Log in to the web application.

    3. In the navigation panel, go to Summary.

    4. If the agent installation instruction is displayed on the page, then copy the key from the instruction.

    5. If no instruction is displayed, then complete the following steps:

      1. In the navigation panel, go to InfrastructureAgents.

      2. In the Authentication key column for any agent, click either Copy the key to copy the key or Reveal to view the key.

  5. Create the ppem-agent.yml agent configuration file:

    1. Specify the parameters for connecting the agent to the containerized DBMS.

    2. Specify the previously obtained API key and the URL for connecting the agent to the manager.

  6. Run DBMS containers, passing the previously created agent configuration file into the containers.