PMM-14887 Provide a Docker Compose file for community

.env.example

@@ -1,6 +1,78 @@
-# Percona PMM dev container
-#PMM_CONTAINER=perconalab/pmm-server:3-dev-container
+# This is a sample file with environment variables for PMM Server. 
+# You can copy it to .env and modify the values as needed: `cp .env.example .env`.
+# Uncomment and set the environment variables below to configure PMM Server.
 
-CH_IMAGE=clickhouse/clickhouse-server:22.6.9.11-alpine
-CH_PORT=9000
-CH_HOSTNAME=ch
+# The latest PMM Server image is alsways published as percona/pmm-server:3.
+# A specific version can be used by changing the tag, e.g., percona/pmm-server:3.7.0.
+PMM_SERVER_IMAGE=percona/pmm-server:3
+# Label-based access control for PMM Server. Set to 1 to enable.
+PMM_ENABLE_ACCESS_CONTROL=1
+# Good for development, but not recommended for production environments.
+PMM_ENABLE_INTERNAL_PG_QAN=1
+# Enable Nomad integration for PMM Server.
+PMM_ENABLE_NOMAD=0
+# Controls the log verbosity of PMM Server. Set to 1 to enable debug logging, which can be helpful for troubleshooting.
+PMM_DEBUG=0
+# Https port for PMM Server API and UI.
+PMM_PORT_HTTPS=443
+# Set the admin username for PMM Server.
+GF_SECURITY_ADMIN_USER=admin
+# Set a strong admin password for PMM Server in production environments.
+GF_SECURITY_ADMIN_PASSWORD=admin
+# Public address for PMM Server, required by Nomad integration.
+PMM_PUBLIC_ADDRESS=localhost
+# Https port for PMM Server API and UI. Web UI: https://localhost:443
+PMM_PORT_HTTPS=443
+
+# Use an external ClickHouse database
+# PMM_CLICKHOUSE_ADDR=127.0.0.1:9000
+# PMM_CLICKHOUSE_DATABASE=pmm
+# PMM_CLICKHOUSE_USER=default
+# PMM_CLICKHOUSE_PASSWORD=<password>
+# PMM_CLICKHOUSE_IS_CLUSTER=1
+# PMM_CLICKHOUSE_CLUSTER_NAME=pmmclickhouse
+# PMM_DISABLE_BUILTIN_CLICKHOUSE=1
+
+# Use an external PostgreSQL database
+# PMM_POSTGRES_ADDR=pg:5432
+# PMM_POSTGRES_DBNAME=pmm-managed
+# PMM_POSTGRES_USERNAME=pmm-managed
+# PMM_POSTGRES_DBPASSWORD=<password>
+# PMM_POSTGRES_SSL_MODE=verify-full
+# PMM_POSTGRES_SSL_CA_PATH=/tmp/certs/root.crt
+# PMM_POSTGRES_SSL_KEY_PATH=/tmp/certs/pmm-managed.key
+# PMM_POSTGRES_SSL_CERT_PATH=/tmp/certs/pmm-managed.crt
+# PMM_DISABLE_BUILTIN_POSTGRES=1
+
+# Use SSL certificates for PMM Server's internal database connection (PostgreSQL)
+# GF_DATABASE_SSL_MODE=verify-full
+# GF_DATABASE_CA_CERT_PATH=/tmp/certs/root.crt
+# GF_DATABASE_CLIENT_KEY_PATH=/tmp/certs/grafana.key
+# GF_DATABASE_CLIENT_CERT_PATH=/tmp/certs/grafana.crt
+
+# Specify a custom file with Advisor checks for development purposes.
+# PMM_DEV_ADVISOR_CHECKS_FILE=/srv/checks/local-checks.yml
+
+# Configure SMTP settings for Grafana to enable email notifications.
+# --profile=mail-server must be enabled in docker-compose.dev.yml for these settings to take effect.
+# GF_EMAILS_WELCOME_EMAIL_ON_SIGN_UP=1
+# GF_SMTP_ENABLED=1
+# GF_SMTP_HOST=mail-server:1025
+# GF_SMTP_FROM_NAME=Percona
+# GF_SMTP_FROM_ADDRESS=admin@percona.com
+
+# Watchtower configuration for automatic updates of PMM Server and its components.
+# --profile=watchtower must be enabled in docker-compose.dev.yml for these settings to take effect.
+# WATCHTOWER_IMAGE=perconalab/watchtower
+# PMM_WATCHTOWER_HOST=http://watchtower:8080
+# PMM_WATCHTOWER_TOKEN=INSECURE_TOKEN
+# PMM_DEV_UPDATE_DOCKER_IMAGE=percona/pmm-server:3
+# WATCHTOWER_HTTP_LISTEN_PORT=8080
+# WATCHTOWER_HTTP_API_UPDATE=1
+# WATCHTOWER_NO_RESTART=0
+# WATCHTOWER_DOCKER_PATH=/var/run/docker.sock
+
+# Grafana Image Renderer configuration for rendering Grafana panels as images.
+# --profile=renderer must be enabled in docker-compose.dev.yml for these settings to take effect
+# GF_RENDERING_SERVER_URL=http://renderer:8081/render
+# GF_RENDERING_CALLBACK_URL=https://pmm-server:8443/graph/

.github/workflows/api-tests.yml

@@ -13,7 +13,7 @@ on:
     inputs:
       PMM_SERVER_IMAGE:
         description: "PMM Server image version"
-        default: "perconalab/pmm-server:3-dev-latest"
+        default: "ghcr.io/percona/pmm:3-dev-container"
         required: true
         type: string
 
@@ -26,7 +26,7 @@ on:
         type: string      
       PMM_SERVER_IMAGE:
         description: "PMM Server image version"
-        default: "perconalab/pmm-server:3-dev-latest"
+        default: "ghcr.io/percona/pmm:3-dev-container"
         required: true
         type: string
 
@@ -40,7 +40,7 @@ jobs:
     env:
       PMM_URL: https://admin:admin@127.0.0.1
       BRANCH: ${{ github.event.inputs.BRANCH || 'v3' }}
-      PMM_SERVER_IMAGE: ${{ github.event.inputs.PMM_SERVER_IMAGE || 'perconalab/pmm-server:3-dev-latest' }}
+      PMM_SERVER_IMAGE: ${{ github.event.inputs.PMM_SERVER_IMAGE }}
 
     steps:
       - name: Check out code
@@ -98,7 +98,8 @@ jobs:
       - name: Run API tests
         shell: bash
         run: |
-          docker run -e PMM_SERVER_URL=${{env.PMM_URL}} \
+          docker run \
+            -e PMM_SERVER_URL=${{env.PMM_URL}} \
             -e PMM_RUN_UPDATE_TEST=0 \
             -e PMM_RUN_ADVISOR_TESTS=0 \
             -e PMM_SERVER_INSECURE_TLS=1 \

.github/workflows/main.yml

@@ -131,21 +131,8 @@ jobs:
           go env | sort
           git status
 
-
-  spell-check:
-    name: Spell check
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out code
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-
-      - name: Check spelling of md files
-        uses: crate-ci/typos@02ea592e44b3a53c302f697cddca7641cd051c3d # v1.45.0
-        with:
-          files: "**/*.md ./documentation/**/*.md"
-
   merge-gatekeeper:
-    needs: [ check, spell-check ]
+    needs: [ check ]
     name: Merge Gatekeeper
     if: ${{ always() }}
     runs-on: ubuntu-22.04

.github/workflows/managed.yml

@@ -28,16 +28,14 @@ permissions: read-all
 
 jobs:
   test:
-    name: Managed tests
+    name: Unit tests
     runs-on: ubuntu-22.04
     timeout-minutes: 30
 
     env:
       PMM_SERVER_IMAGE: perconalab/pmm-server:3-dev-latest
       AWS_ACCESS_KEY: ${{ secrets.AWS_ACCESS_KEY }}
       AWS_SECRET_KEY: ${{ secrets.AWS_SECRET_KEY }}
-      PMM_DEV_OAUTH_CLIENT_ID: ${{ secrets.OAUTH_PMM_CLIENT_ID }}
-      PMM_DEV_OAUTH_CLIENT_SECRET: ${{ secrets.OAUTH_PMM_CLIENT_SECRET }}
       PMM_CONTAINER: ghcr.io/percona/pmm:3-dev-container
 
     steps:
@@ -66,7 +64,7 @@ jobs:
             -e PMM_RELEASE_PATH=/root/go/bin \
             -e PMM_ENABLE_ACCESS_CONTROL=1 \
             -e PMM_ENABLE_TELEMETRY=0 \
-            -e PMM_RELEASE_VERSION=3.0.0 \
+            -e PMM_RELEASE_VERSION=3.7.0 \
             -e GOMODCACHE=/home/pmm/.cache/go/mod \
             -e GOCACHE=/home/pmm/.cache/go-build \
             -w /root/go/src/github.com/percona/pmm \

AGENTS.md

@@ -230,7 +230,8 @@ All long-running daemons expose on `127.0.0.1`:
 ## Key Files to Reference
 
 - `Makefile`, `Makefile.include` — build and development targets
-- `docker-compose.yml` — development environment (PMM Server, renderer, watchtower)
+- `docker-compose.dev.yml` — development environment (PMM Server, renderer, watchtower)
+- `docker-compose.yml` — community/quickstart compose (stable image, minimal config)
 - `go.mod` — Go module definition
 - `.golangci.yml` — linter configuration
 - `.mockery.yaml` — mock generation configuration

README.md

@@ -29,7 +29,6 @@ See the [PMM Documentation](https://docs.percona.com/percona-monitoring-and-mana
 * Spot critical performance issues faster, understand the root cause of incidents better and troubleshoot them more efficiently.
 * Zoom-in, drill-down database performance from node to single query levels. Perform in-depth troubleshooting and performance optimization.
 * Built-in Advisors run regular checks of the databases connected to PMM. The checks identify and alert you of potential security threats, performance degradation, data loss and data corruption.
-* Backup and restore databases up to a specific moment with Point-in-Time-Recovery.
 
 ## Architecture
 
@@ -41,7 +40,7 @@ See the [PMM Documentation](https://docs.percona.com/percona-monitoring-and-mana
 
 ## Installation
 
-There are numbers of installation methods, please check our [About PMM installation](https://docs.percona.com/percona-monitoring-and-management/3/install-pmm/index.html) documentation page.
+There are different installation methods, please check our [About PMM installation](https://docs.percona.com/percona-monitoring-and-management/3/install-pmm/index.html) documentation page.
 
 But in a nutshell:
 
@@ -61,7 +60,7 @@ $ docker run --detach --restart always \
   --name pmm-server \
   percona/pmm-server:3
 ```
-4. Start a web browser and in the address bar enter the server name or IP address of the PMM server host.
+4. Start a web browser and type the server name or IP address of the PMM server host (defaults to https://localhost).
 
 <img src="./documentation/docs/images/PMM_Login.png" width="280" alt="PMM Login Page" />
 

agent/cmd/pmm-agent-entrypoint/main.go

@@ -40,9 +40,9 @@ It is configured entirely by environment variables. Arguments or flags are not u
 
 The following environment variables are recognized by the Docker entrypoint:
 * PMM_AGENT_SETUP            - if true, 'pmm-agent setup' is called before 'pmm-agent run'.
-* PMM_AGENT_PRERUN_FILE      - if non-empty, runs given file with 'pmm-agent run' running in the background.
-* PMM_AGENT_PRERUN_SCRIPT    - if non-empty, runs given shell script content with 'pmm-agent run' running in the background.
-* PMM_AGENT_SIDECAR          - if true, 'pmm-agent' will be restarted in case of it's failed.
+* PMM_AGENT_PRERUN_FILE      - if non-empty, runs given file while 'pmm-agent run' is running in the background.
+* PMM_AGENT_PRERUN_SCRIPT    - if non-empty, runs given shell script content while 'pmm-agent run' is running in the background.
+* PMM_AGENT_SIDECAR          - if true, 'pmm-agent' will be restarted in case it fails.
 * PMM_AGENT_SIDECAR_SLEEP    - time to wait before restarting pmm-agent if PMM_AGENT_SIDECAR is true. 1 second by default.
 
 Additionally, the many environment variables are recognized by pmm-agent itself.

agent/docker-compose.yml

@@ -11,7 +11,6 @@ services:
       - PMM_DEV_ADVISOR_CHECKS_FILE=/srv/checks/custom-checks.yml
       # for check-dev
       # - PMM_DEV_PERCONA_PLATFORM_ADDRESS=check-dev.percona.com:443
-      # - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX
     volumes:
       - ./testdata/checks:/srv/checks
 
@@ -45,7 +44,7 @@ services:
       - ./testdata/mysql:/mysql
 
   mongo:
-    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:5.0}
+    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:6.0}
     container_name: pmm-agent_mongo
     command:
       - --profile=2
@@ -60,7 +59,7 @@ services:
       - ./testdata/mongo/var/log/mongodb:/var/log/mongodb
 
   mongo_with_tls:
-    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:5.0}
+    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:6.0}
     container_name: pmm-agent_mongo_with_tls
     command:
       - --profile=2
@@ -78,17 +77,17 @@ services:
       - ./testdata/mongo/var/log/mongodb:/var/log/mongodb
 
   mongonoauth:
-    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:5.0}
+    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:6.0}
     container_name: pmm-agent_mongonoauth
     command: --profile=2 -bind_ip=0.0.0.0 --noauth
     ports:
       - "127.0.0.1:27019:27017"
 
   mongo_repl:
-    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:5.0}
+    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:6.0}
     container_name: pmm-agent_mongorepl
     environment:
-      - MONGO_IMAGE=${MONGO_IMAGE:-percona/percona-server-mongodb:5.0}
+      - MONGO_IMAGE=${MONGO_IMAGE:-percona/percona-server-mongodb:6.0}
     volumes:
       - ./testscripts/:/scripts
     command: /scripts/mongo_repl.sh
@@ -97,11 +96,11 @@ services:
       - "127.0.0.1:27021:27021"
 
   mongo_repl_with_tls:
-    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:5.0}
+    image: ${MONGO_IMAGE:-percona/percona-server-mongodb:6.0}
     container_name: pmm-agent_mongorepl_with_tls
     command: /scripts/mongo_repl_with_tls.sh
     environment:
-      - MONGO_IMAGE=${MONGO_IMAGE:-percona/percona-server-mongodb:5.0}
+      - MONGO_IMAGE=${MONGO_IMAGE:-percona/percona-server-mongodb:6.0}
     ports:
       - "127.0.0.1:27022:27022"
       - "127.0.0.1:27023:27023"
@@ -110,7 +109,7 @@ services:
       - ${PWD}/utils/tests/testdata/mongodb:/etc/tls/certificates
 
   postgres:
-    image: ${POSTGRES_IMAGE:-postgres:11}
+    image: ${POSTGRES_IMAGE:-postgres:14}
     container_name: pmm-agent_postgres
     command: >
       -c shared_preload_libraries='${PG_PRELOADED_LIBS:-pg_stat_statements}'

api-tests/docker-compose.yml

@@ -11,7 +11,6 @@ services:
       # - PMM_DEV_ADVISOR_CHECKS_FILE=/srv/checks/custom-checks.yml
       # for check-dev
       - PMM_DEV_PERCONA_PLATFORM_ADDRESS=check-dev.percona.com
-      - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX
     volumes:
       - ./testdata/checks:/srv/checks
 

dashboards/pmm-app/docker-compose.yaml

@@ -8,9 +8,7 @@ services:
       - './dist:/srv/grafana/plugins/pmm-app/dist'
     environment:
       - PMM_DEBUG=1
-      - PMM_DEV_PORTAL_URL=https://portal-dev.percona.com
       - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check-dev.percona.com:443
-      - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=RWTkF7Snv08FCboTne4djQfN5qbrLfAjb8SY3/wwEP+X5nUrkxCEvUDJ
     ports:
       - 80:8080
       - 443:8443

dev/init-pg.sql

@@ -0,0 +1 @@
+CREATE EXTENSION IF NOT EXISTS pg_stat_statements;

dev/my.cnf

@@ -0,0 +1,7 @@
+[mysqld]
+slow_query_log = ON
+slow_query_log_file = /var/log/mysql/mysql-slow.log
+slow_query_log_always_write_time = 0
+long_query_time = 0
+log_slow_admin_statements = ON
+log_slow_extra = ON

dev/mysql.logrotate

@@ -0,0 +1,14 @@
+/var/log/mysql/mysql-slow.log {
+    daily
+    missingok
+    rotate 7
+    compress
+    delaycompress
+    notifempty
+    sharedscripts
+    postrotate
+        if [ -f /var/run/mysqld/mysqld.pid ]; then
+            kill -HUP $(cat /var/run/mysqld/mysqld.pid)
+        fi
+    endscript
+}

dev/sysbench-ps.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+set -o xtrace
+
+sysbench \
+    --db-driver=mysql \
+    --mysql-host=ps \
+    --mysql-port=3306 \
+    --mysql-user=root \
+    --mysql-password=secret \
+    --mysql-db=sbtest \
+    --table-size=1000000 \
+    oltp_read_write \
+    prepare
+
+sysbench \
+    --rate=200 \
+    --threads=64 \
+    --report-interval=10 \
+    --time=0 \
+    --events=0 \
+    --rand-type=pareto \
+    --db-driver=mysql \
+    --mysql-host=ps \
+    --mysql-port=3306 \
+    --mysql-user=root \
+    --mysql-password=secret \
+    --mysql-db=sbtest \
+    --table-size=1000000 \
+    oltp_read_only \
+    run