Setting Up a Docker Container for PMM Server¶

Pulling the PMM Server Image¶

To pull the latest version from Docker Hub:

$ docker pull percona/pmm-server:latest

This step is not required if you are running PMM Server for the first time. However, it ensures that if there is an older version of the image tagged with latest available locally, it will be replaced by the actual latest version.

$ docker pull perconalab/pmm-server:dev-latest

Creating the pmm-data Container¶

To create a container for persistent PMM data, run the following command:

$ docker create \
   -v /opt/prometheus/data \
   -v /opt/consul-data \
   -v /var/lib/mysql \
   -v /var/lib/grafana \
   --name pmm-data \
   percona/pmm-server:latest /bin/true

The previous command does the following:

• The docker create command instructs the Docker daemon to create a container from an image.
• The -v options initialize data volumes for the container.
• The --name option assigns a custom name for the container that you can use to reference the container within a Docker network. In this case: pmm-data.
• percona/pmm-server:latest is the name and version tag of the image to derive the container from.
• /bin/true is the command that the container runs.

Creating and Launching the PMM Server Container¶

To create and launch PMM Server in one command, use docker run:

$ docker run -d \
   -p 80:80 \
   --volumes-from pmm-data \
   --name pmm-server \
   --restart always \
   percona/pmm-server:latest

This command does the following:

• The docker run command runs a new container based on the percona/pmm-server:latest image.
• The -d option starts the container in the background (detached mode).
• The -p option maps the port for accessing the PMM Server web UI. For example, if port 80 is not available, you can map the landing page to port 8080 using -p 8080:80.
• The -v option mounts volumes from the pmm-data container (see Creating the pmm-data Container).
• The --name option assigns a custom name to the container that you can use to reference the container within the Docker network. In this case: pmm-server.
• The --restart option defines the container’s restart policy. Setting it to always ensures that the Docker daemon will start the container on startup and restart it if the container exits.
• percona/pmm-server:latest is the name and version tag of the image to derive the container from.

Additional options¶

When running the PMM Server, you may pass additional parameters to the docker run subcommand. All options that appear after the -e option are the additional parameters that modify the way how PMM Server operates.

The section PMM Server Additional Options lists all supported additional options.