Buy Percona ServicesBuy Now!

Running PMM Server Using Docker

Docker images of PMM Server are at the percona/pmm-server public repository. If you intend to run PMM Server from a Docker image, the host must be able to run Docker 1.12.6 or later, and have network access.

For more information about using Docker, see the Docker Docs.

Note

Make sure that the firewall and routing rules of the host do not constrain the Docker container. For more information, see How to troubleshoot communication issues between PMM Client and PMM Server?.

Step 1. Pull the PMM Server Image

To pull the latest version from Docker Hub:

$ docker pull percona/pmm-server:latest

This 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.

Step 2. Create a 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

Note

This container does not run, it simply exists to make sure you retain all PMM data when you upgrade to a newer PMM Server image. Do not remove or re-create this container, unless you intend to wipe out all PMM data and start over.

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.

Important

Make sure that the data volumes that you initialize with the -v option match those given in the example. PMM Server expects that those directories are bind mounted exactly as demonstrated.

Step 3. Create and Run the PMM Server Container

To run PMM Server, use the following command:

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

The previous 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 detached mode (that is, in the background).
  • 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 || option mounts volumes from the pmm-data container (see Step 2. Create a 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 parameters

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.

To enable Orchestrator

By default, Orchestrator is disabled. To enable it, set the ORCHESTRATOR_ENABLED option to true.

$ docker run ... -e ORCHESTRATOR_ENABLED=true ... percona/pmm-server:latest

To disable telemetry

With telemetry enabled, your PMM Server sends some statistics to v.percona.com every 24 hours. This statistics includes the following details:

  • PMM Server unique ID
  • PMM version
  • The name and version of the operating system
  • MySQL version
  • Perl version

If you do not want your PMM Server to send this information, disable telemetry when running your Docker container:

$ docker run ... -e DISABLE_TELEMETRY=true ... percona/pmm-server:latest

To disable updates

To update your PMM from web interface you only need to click the Update on the home page. The DISABLE_UPDATES option is useful if updating is not desirable. Set it to true when running PMM in the Docker container.

$ docker run ... -e DISABLE_UPDATES=true ... percona/pmm-server:latest

See also

Default ports
Ports in Terminology Reference
Updating PMM
Updating PMM
Visit Percona Store


General Inquiries

For general inquiries, please send us your question and someone will contact you.