Install PMM Server with Docker¶
Deploy PMM Server as a Docker container for a fast, flexible and isolated setup.
Prerequisites¶
Before installation, ensure you have:
- Docker version 17.03 or higher
- CPU with
x86-64-v2support - Sufficient system resources (recommended: 2+ CPU cores, 4+ GB RAM, 100+ GB disk space)
Installation options¶
Container setup summary¶
Container setup at a glance
- Pull the Docker image:
docker pull percona/pmm-server:3 - Choose storage: Docker volumes (recommended) or host directory
- Run the container: Using the appropriate
docker runcommand - Access the UI: Navigate to
https://SERVER_IP_ADDRESSin your browser - Log in: Default credentials
admin/admin
Install PMM Server¶
You can install PMM Server using one of two methods:
The Easy-install script provides a one-step installation of PMM Server. Run the following command:
curl -fsSL https://www.percona.com/get/pmm | /bin/bash
For a more customizable setup, follow these steps:
- Run PMM Server with Docker based on your preferred data storage method:
Configuration options¶
Storage configuration¶
You can choose either of two storage options offered by PMM Server:
| Option | Suitable for | Docker parameter |
|---|---|---|
| Docker volumes (Recommended) | Production environments | --volume pmm-data:/srv |
| Host directory | Development/testing | --volume /path/on/host:/srv |
Environment variables¶
Configure PMM Server’s behavior using environment variables:
docker run \
--detach \
--restart always \
--publish 443:8443 \
--volume pmm-data:/srv \
-e PMM_DATA_RETENTION=720h \
-e PMM_METRICS_RESOLUTION_HR=10s \
--name pmm-server \
percona/pmm-server:3
If the manual installation already created a pmm-server container, remove that container first and reuse its storage. For the steps, see Run the examples on an existing installation.
Common variables:
| Variable | Default | Description |
|---|---|---|
PMM_DATA_RETENTION |
720h |
How long to keep metrics data, in hours. The default is 30 days. |
PMM_METRICS_RESOLUTION_HR |
5s |
High-resolution metrics interval |
PMM_ENABLE_UPDATES |
true |
Allow version checks |
PMM_ENABLE_TELEMETRY |
true |
Send usage statistics |
Set PMM_DATA_RETENTION in hours, as a multiple of 24h, such as 720h for 30 days. The minimum is 24h. If you use days, such as 30d, PMM Server won’t start.
For a complete list, see the environment variables.
Access PMM Server¶
After installation:
-
Access the PMM interface in your browser:
https://SERVER_IP_ADDRESS(replace with your server’s address) -
Log in with default credentials:
admin/admin. -
Change the default password on first login.
Advanced configuration¶
After basic installation, you may want to customize your PMM Server setup:
Security options¶
- Configure a trusted SSL certificate to remove browser warnings.
-
Disable updates if needed:
- via Docker: add
-e PMM_ENABLE_UPDATES=0to thedocker runcommand (for the life of the container) - via UI: go to Configuration > Settings > Advanced settings and disable Check for Updates (can be turned back on by any admin in the UI)
- via Docker: add
-
Enable HTTP (insecure, NOT recommended): add
--publish 80:8080to thedocker runcommand.
Warning
PMM Client requires a secure (TLS-encrypted) connection and will only communicate with PMM Server over HTTPS.