PMM-12619: Make PMM environment variables more consistent

.github/workflows/api-tests.yml

@@ -95,8 +95,8 @@ jobs:
               environment:
                 - PMM_DEBUG=1
                 - PERCONA_TEST_CHECKS_INTERVAL=10s
-                - PMM_PERCONA_TEST_PLATFORM_ADDRESS=https://check-dev.percona.com
-                - PMM_PERCONA_TEST_PLATFORM_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX
+                - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check-dev.percona.com
+                - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX
               ports:
                 - 80:8080
                 - 443:8443

agent/docker-compose.yml

@@ -12,10 +12,10 @@ services:
       - PMM_DEBUG=1
       - PERCONA_TEST_CHECKS_INTERVAL=10s
       # for local development
-      - PMM_ADVISORS_CHECKS_FILE=/srv/checks/custom-checks.yml
+      - PMM_DEV_ADVISOR_CHECKS_FILE=/srv/checks/custom-checks.yml
       # for check-dev
-      # - PMM_TEST_SAAS_HOST=check-dev.percona.com:443
-      # - PMM_TEST_CHECKS_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX
+      # - 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
 

api-tests/docker-compose.yml

@@ -12,10 +12,10 @@ services:
       - PMM_DEBUG=1
       - PERCONA_TEST_CHECKS_INTERVAL=10s
       # for local development
-      # - PMM_ADVISORS_CHECKS_FILE=/srv/checks/custom-checks.yml
+      # - PMM_DEV_ADVISOR_CHECKS_FILE=/srv/checks/custom-checks.yml
       # for check-dev
-      - PMM_TEST_SAAS_HOST=check-dev.percona.com
-      - PMM_TEST_CHECKS_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX
+      - PMM_DEV_PERCONA_PLATFORM_ADDRESS=check-dev.percona.com
+      - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX
     volumes:
       - ./testdata/checks:/srv/checks
 

build/docker/server/README.md

@@ -34,7 +34,7 @@ You can use these environment variables (-e VAR) when running the Docker image.
 | PMM_METRICS_RESOLUTION_LR    | Low metrics resolution in seconds                                                                                           |
 | PMM_DATA_RETENTION           | How long to keep time-series data in ClickHouse. This variable accepts golang style duration format, example: 24h, 30m, 10s |
 | PMM_ENABLE_VM_CACHE          | Enable cache in VM                                                                                                          |
-| PMM_ENABLE_AZUREDISCOVER     | Enable support for discovery of Azure databases                                                                             |
+| PMM_ENABLE_AZURE_DISCOVER     | Enable support for discovery of Azure databases                                                                             |
 | PMM_PUBLIC_ADDRESS           | External IP address or the DNS name on which PMM server is running.                                                         |
 | PMM_DEBUG                    | Enables a more verbose log level                                                                                            |
 | PMM_TRACE                    | Enables a more verbose log level including traceback information                                                            |

docker-compose.yml

@@ -22,19 +22,19 @@ services:
       - PMM_LESS_LOG_NOISE=1
       - PMM_RELEASE_PATH=/root/go/bin
       - PMM_ENABLE_RBAC=${PMM_ENABLE_RBAC:-0}
-      - PMM_TEST_VERSION_SERVICE_URL=${PMM_TEST_VERSION_SERVICE_URL}
-      # - PMM_PERCONA_TEST_PLATFORM_ADDRESS=https://check.localhost
-      # - PMM_PERCONA_TEST_PLATFORM_INSECURE=1
-      # - PMM_PERCONA_TEST_PLATFORM_PUBLIC_KEY=<public key>
-      # - PMM_TEST_TELEMETRY_INTERVAL=10s
-      # - PMM_TEST_TELEMETRY_DISABLE_START_DELAY=1
-      # - PMM_TEST_TELEMETRY_RETRY_BACKOFF=10s
+      - PMM_DEV_VERSION_SERVICE_URL=${PMM_DEV_VERSION_SERVICE_URL}
+      # - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check.localhost
+      # - PMM_DEV_PERCONA_PLATFORM_INSECURE=1
+      # - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=<public key>
+      # - PMM_DEV_TELEMETRY_INTERVAL=10s
+      # - PMM_DEV_TELEMETRY_DISABLE_START_DELAY=1
+      # - PMM_DEV_TELEMETRY_RETRY_BACKOFF=10s
       # - PMM_CLICKHOUSE_ADDR=127.0.0.1:9000
       # - PMM_CLICKHOUSE_DATABASE=pmm
       # - PMM_CLICKHOUSE_BLOCK_SIZE=10000
       # - PMM_CLICKHOUSE_POOL_SIZE=2
       # - PMM_DEBUG=1
-      # - PMM_ADVISORS_CHECKS_FILE=/srv/checks/local-checks.yml
+      # - PMM_DEV_ADVISOR_CHECKS_FILE=/srv/checks/local-checks.yml
       # - PMM_POSTGRES_ADDR=pg
       # - PMM_POSTGRES_DBNAME=pmm-managed
       # - PMM_POSTGRES_USERNAME=pmm-managed
@@ -206,12 +206,12 @@ services:
       - REVIEWDOG_GITHUB_API_TOKEN=${REVIEWDOG_GITHUB_API_TOKEN}
       - AWS_ACCESS_KEY=${AWS_ACCESS_KEY}
       - AWS_SECRET_KEY=${AWS_SECRET_KEY}
-      # - PMM_PERCONA_TEST_PLATFORM_ADDRESS=https://check.localhost
-      # - PMM_PERCONA_TEST_PLATFORM_INSECURE=1
-      # - PMM_PERCONA_TEST_PLATFORM_PUBLIC_KEY=<public key>
-      # - PMM_TEST_TELEMETRY_INTERVAL=10s
-      # - PMM_TEST_TELEMETRY_RETRY_BACKOFF=10s
-      # - PMM_TEST_TELEMETRY_DISABLE_START_DELAY=1
+      # - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check.localhost
+      # - PMM_DEV_PERCONA_PLATFORM_INSECURE=1
+      # - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=<public key>
+      # - PMM_DEV_TELEMETRY_INTERVAL=10s
+      # - PMM_DEV_TELEMETRY_RETRY_BACKOFF=10s
+      # - PMM_DEV_TELEMETRY_DISABLE_START_DELAY=1
       - PMM_CLICKHOUSE_ADDR=${CH_HOSTNAME:-ch}:9000
       - PMM_CLICKHOUSE_DATABASE=pmm
       - PMM_CLICKHOUSE_BLOCK_SIZE=10000
@@ -289,12 +289,12 @@ services:
       - REVIEWDOG_GITHUB_API_TOKEN=${REVIEWDOG_GITHUB_API_TOKEN}
       - AWS_ACCESS_KEY=${AWS_ACCESS_KEY}
       - AWS_SECRET_KEY=${AWS_SECRET_KEY}
-      # - PMM_PERCONA_TEST_PLATFORM_ADDRESS=https://check.localhost
-      # - PMM_PERCONA_TEST_PLATFORM_INSECURE=1
-      # - PMM_PERCONA_TEST_PLATFORM_PUBLIC_KEY=<public key>
-      # - PMM_TEST_TELEMETRY_INTERVAL=10s
-      # - PMM_TEST_TELEMETRY_RETRY_BACKOFF=10s
-      # - PMM_TEST_TELEMETRY_DISABLE_START_DELAY=1
+      # - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check.localhost
+      # - PMM_DEV_PERCONA_PLATFORM_INSECURE=1
+      # - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=<public key>
+      # - PMM_DEV_TELEMETRY_INTERVAL=10s
+      # - PMM_DEV_TELEMETRY_RETRY_BACKOFF=10s
+      # - PMM_DEV_TELEMETRY_DISABLE_START_DELAY=1
       - PMM_CLICKHOUSE_ADDR=${CH_HOSTNAME:-ch}:9000
       - PMM_CLICKHOUSE_DATABASE=pmm
       - PMM_CLICKHOUSE_BLOCK_SIZE=10000
@@ -371,12 +371,12 @@ services:
       - REVIEWDOG_GITHUB_API_TOKEN=${REVIEWDOG_GITHUB_API_TOKEN}
       - AWS_ACCESS_KEY=${AWS_ACCESS_KEY}
       - AWS_SECRET_KEY=${AWS_SECRET_KEY}
-      # - PMM_PERCONA_TEST_PLATFORM_ADDRESS=https://check.localhost
-      # - PMM_PERCONA_TEST_PLATFORM_INSECURE=1
-      # - PMM_PERCONA_TEST_PLATFORM_PUBLIC_KEY=<public key>
-      # - PMM_TEST_TELEMETRY_INTERVAL=10s
-      # - PMM_TEST_TELEMETRY_RETRY_BACKOFF=10s
-      # - PMM_TEST_TELEMETRY_DISABLE_START_DELAY=1
+      # - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check.localhost
+      # - PMM_DEV_PERCONA_PLATFORM_INSECURE=1
+      # - PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY=<public key>
+      # - PMM_DEV_TELEMETRY_INTERVAL=10s
+      # - PMM_DEV_TELEMETRY_RETRY_BACKOFF=10s
+      # - PMM_DEV_TELEMETRY_DISABLE_START_DELAY=1
       - PMM_CLICKHOUSE_ADDR=${CH_HOSTNAME:-ch}:9000
       - PMM_CLICKHOUSE_DATABASE=pmm
       - PMM_CLICKHOUSE_BLOCK_SIZE=10000

docs/process/best_practices.md

@@ -26,6 +26,14 @@
   - Supervisor-level dependencies between services are not strictly required (due to restarts everything will work eventually), but are nice to have: they help avoid scarry errors in logs.
   - The big exception is exporters: we should follow practices established by the Prometheus community and not fail if the system under monitoring is not available. Other startup errors, like a missing certificate file, should still terminate the exporter.
 
+### Environment Variables
+For consistency, environment variables should keep to the following suggestions:
+- Use the `PMM_DEV_` prefix for any environment variable that is to be used for *only* development/test purposes i.e., 
+variables that are not meant for end-users in any circumstance e.g., `PMM_DEV_PERCONA_PLATFORM_ADDRESS`
+- Use the `PMM_TEST_` prefix for any variable that is not part of PMM GA functionality.
+- Use the `PMM_` prefix for variables that is part of PMM GA functionality.
+- Use a sub-prefix if a number of env vars relate to one component, e.g., `PMM_TEST_HA_`
+- The use of PERCONA_ prefix is prohibited (exception: PMM_PERCONA_PLATFORM_URL, since it's part of a proper name, not a prefix)
 ## Code style
 
 - `gofumpt -s ` (note the `-s`)