diff --git a/.env.dev.example b/.env.dev.example index a220e46f849..6d2fdeacf19 100644 --- a/.env.dev.example +++ b/.env.dev.example @@ -77,7 +77,7 @@ WATCHTOWER_DOCKER_PATH=/var/run/docker.sock # GF_RENDERING_CALLBACK_URL=https://pmm-server:8443/graph/ # Use these to debug telemetry -# PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check-dev.percona.com +# PMM_PERCONA_PLATFORM_ADDRESS=https://check-dev.percona.com # PMM_DEV_PERCONA_PLATFORM_INSECURE=1 # PMM_DEV_TELEMETRY_INTERVAL=30s # PMM_DEV_TELEMETRY_DISABLE_START_DELAY=1 diff --git a/.github/workflows/api-tests.yml b/.github/workflows/api-tests.yml index 39c10f5bc78..b24fc860a65 100644 --- a/.github/workflows/api-tests.yml +++ b/.github/workflows/api-tests.yml @@ -64,7 +64,6 @@ jobs: container_name: pmm-server environment: - PMM_DEBUG=1 - - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check-dev.percona.com ports: - 443:8443 volumes: diff --git a/agent/docker-compose.yml b/agent/docker-compose.yml index 7af8a57a1ef..ed92c986127 100644 --- a/agent/docker-compose.yml +++ b/agent/docker-compose.yml @@ -10,8 +10,6 @@ services: - PMM_DEBUG=1 # for local development - PMM_DEV_ADVISOR_CHECKS_FILE=/srv/checks/custom-checks.yml - # for check-dev - # - PMM_DEV_PERCONA_PLATFORM_ADDRESS=check-dev.percona.com:443 volumes: - ./testdata/checks:/srv/checks diff --git a/api-tests/docker-compose.yml b/api-tests/docker-compose.yml index 464fdd6ae71..181a50f4d59 100644 --- a/api-tests/docker-compose.yml +++ b/api-tests/docker-compose.yml @@ -9,8 +9,6 @@ services: - PMM_DEBUG=1 # for local development # - PMM_DEV_ADVISOR_CHECKS_FILE=/srv/checks/custom-checks.yml - # for check-dev - - PMM_DEV_PERCONA_PLATFORM_ADDRESS=check-dev.percona.com volumes: - ./testdata/checks:/srv/checks diff --git a/build/docker/server/Dockerfile.el9 b/build/docker/server/Dockerfile.el9 index 57e0b959408..97d1dc4e85d 100644 --- a/build/docker/server/Dockerfile.el9 +++ b/build/docker/server/Dockerfile.el9 @@ -2,11 +2,13 @@ FROM oraclelinux:9-slim ARG VERSION ARG BUILD_DATE +ARG PMM_PERCONA_PLATFORM_ADDRESS ENV LANG=en_US.utf8 ENV GF_PLUGIN_DIR=/srv/grafana/plugins ENV PERCONA_TELEMETRY_DISABLE=1 ENV PS1="[\u@\h \W] # " +ENV PMM_PERCONA_PLATFORM_ADDRESS=${PMM_PERCONA_PLATFORM_ADDRESS} WORKDIR /opt diff --git a/build/scripts/build-server-docker b/build/scripts/build-server-docker index 221e5067f1d..8a02f45ad52 100755 --- a/build/scripts/build-server-docker +++ b/build/scripts/build-server-docker @@ -35,6 +35,7 @@ GO_VERSION=$(grep '^go ' ${root_dir}/tmp/source/pmm/go.mod | awk '{print $2}') docker build --build-arg BUILD_DATE="`date --rfc-3339=seconds`" \ --build-arg VERSION="$IMAGE_VERSION" \ --build-arg GO_VERSION="$GO_VERSION" \ + --build-arg PMM_PERCONA_PLATFORM_ADDRESS="$PMM_PERCONA_PLATFORM_ADDRESS" \ -f ${docker_root}/${docker_file} \ -t ${DOCKER_TAG} \ ${docker_root}/ diff --git a/dashboards/pmm-app/docker-compose.yaml b/dashboards/pmm-app/docker-compose.yaml index fb1815b6a91..e17ca835856 100644 --- a/dashboards/pmm-app/docker-compose.yaml +++ b/dashboards/pmm-app/docker-compose.yaml @@ -8,7 +8,6 @@ services: - './dist:/srv/grafana/plugins/pmm-app/dist' environment: - PMM_DEBUG=1 - - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check-dev.percona.com:443 ports: - 80:8080 - 443:8443 diff --git a/dev/docs/process/best_practices.md b/dev/docs/process/best_practices.md index afa11f7cdb9..37f70473a01 100644 --- a/dev/docs/process/best_practices.md +++ b/dev/docs/process/best_practices.md @@ -29,11 +29,11 @@ ### 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` +variables that are not meant for end-users in any circumstance e.g., `PMM_DEV_TELEMETRY_FILE` - 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_HA_` -- The use of PERCONA_ prefix is prohibited (exception: PMM_PERCONA_PLATFORM_URL, since it's part of a proper name, not a prefix) +- The use of PERCONA_ prefix is prohibited (exception: the `PMM_PERCONA_PLATFORM_` proper name, e.g. `PMM_PERCONA_PLATFORM_ADDRESS`, since it's part of a proper name, not a prefix) ## Code style - `gofumpt -s ` (note the `-s`) diff --git a/dev/docs/process/v2_to_v3_environment_variables.md b/dev/docs/process/v2_to_v3_environment_variables.md index 7ca77e9677b..543c0ce8164 100644 --- a/dev/docs/process/v2_to_v3_environment_variables.md +++ b/dev/docs/process/v2_to_v3_environment_variables.md @@ -19,9 +19,9 @@ Below is a list of affected variables and their new names. | `METRICS_RESOLUTION_MR` | `PMM_METRICS_RESOLUTION_MR` | | | `OAUTH_PMM_CLIENT_ID` | `PMM_DEV_OAUTH_CLIENT_ID` | Removed in PMM v3 | | `OAUTH_PMM_CLIENT_SECRET` | `PMM_DEV_OAUTH_CLIENT_SECRET` | Removed in PMM v3 | -| `PERCONA_TEST_AUTH_HOST` | | Removed in PMM v3, use `PMM_DEV_PERCONA_PLATFORM_ADDRESS` | +| `PERCONA_TEST_AUTH_HOST` | | Removed in PMM v3, use `PMM_PERCONA_PLATFORM_ADDRESS` | | `PERCONA_TEST_CHECKS_FILE` | `PMM_DEV_ADVISOR_CHECKS_FILE` | | -| `PERCONA_TEST_CHECKS_HOST` | | Removed in PMM v3, use `PMM_DEV_PERCONA_PLATFORM_ADDRESS` | +| `PERCONA_TEST_CHECKS_HOST` | | Removed in PMM v3, use `PMM_PERCONA_PLATFORM_ADDRESS` | | `PERCONA_TEST_CHECKS_INTERVAL` | | Removed in PMM v3 as it wasn't actually used. | | `PERCONA_TEST_CHECKS_PUBLIC_KEY` | | Removed in PMM v3, use `PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY` | | `PERCONA_TEST_NICER_API` | | Removed in PMM v3 | @@ -35,7 +35,7 @@ Below is a list of affected variables and their new names. | `PERCONA_TEST_PMM_DISABLE_BUILTIN_CLICKHOUSE` | `PMM_DISABLE_BUILTIN_CLICKHOUSE` | | | `PERCONA_TEST_PMM_DISABLE_BUILTIN_POSTGRES` | `PMM_DISABLE_BUILTIN_POSTGRES` | | | `PERCONA_TEST_INTERFACE_TO_BIND` | `PMM_INTERFACE_TO_BIND` | | -| `PERCONA_TEST_PLATFORM_ADDRESS` | `PMM_DEV_PERCONA_PLATFORM_ADDRESS` | | +| `PERCONA_TEST_PLATFORM_ADDRESS` | `PMM_PERCONA_PLATFORM_ADDRESS` | | | `PERCONA_TEST_PLATFORM_INSECURE` | `PMM_DEV_PERCONA_PLATFORM_INSECURE` | | | `PERCONA_TEST_PLATFORM_PUBLIC_KEY` | `PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY` | Removed in PMM v3 | | `PERCONA_TEST_POSTGRES_ADDR` | `PMM_POSTGRES_ADDR` | | @@ -45,7 +45,7 @@ Below is a list of affected variables and their new names. | `PERCONA_TEST_POSTGRES_SSL_KEY_PATH` | `PMM_POSTGRES_SSL_KEY_PATH` | | | `PERCONA_TEST_POSTGRES_SSL_MODE` | `PMM_POSTGRES_SSL_MODE` | | | `PERCONA_TEST_POSTGRES_DBPASSWORD` | `PMM_POSTGRES_DBPASSWORD` | | -| `PERCONA_TEST_SAAS_HOST` | | Removed in PMM v3, use `PMM_DEV_PERCONA_PLATFORM_ADDRESS` | +| `PERCONA_TEST_SAAS_HOST` | | Removed in PMM v3, use `PMM_PERCONA_PLATFORM_ADDRESS` | | `PERCONA_TEST_POSTGRES_USERNAME` | `PMM_POSTGRES_USERNAME` | | | `PERCONA_TEST_STARLARK_ALLOW_RECURSION` | `PMM_DEV_ADVISOR_STARLARK_ALLOW_RECURSION` | | | `PMM_TEST_TELEMETRY_DISABLE_SEND` | `PMM_DEV_TELEMETRY_DISABLE_SEND` | | @@ -54,7 +54,7 @@ Below is a list of affected variables and their new names. | `PERCONA_TEST_TELEMETRY_HOST` | `PMM_DEV_TELEMETRY_HOST` | | | `PERCONA_TEST_TELEMETRY_INTERVAL` | `PMM_DEV_TELEMETRY_INTERVAL` | | | `PERCONA_TEST_TELEMETRY_RETRY_BACKOFF` | `PMM_DEV_TELEMETRY_RETRY_BACKOFF` | | -| `PERCONA_TEST_VERSION_SERVICE_URL` | | Removed in PMM v3, use `PMM_DEV_PERCONA_PLATFORM_ADDRESS` | +| `PERCONA_TEST_VERSION_SERVICE_URL` | | Removed in PMM v3, use `PMM_PERCONA_PLATFORM_ADDRESS` | ## Changes to environment variables in v3+ diff --git a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md index a0bfcc3b94b..4f1cbd8ed41 100644 --- a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md +++ b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md @@ -472,9 +472,9 @@ The following table lists all the environment variable changes between PMM v2 an #### Removed variables | PMM 2 | PMM 3 | Comments | |-------------------------------------|------------------------------------|------------------------------| - | `PERCONA_TEST_AUTH_HOST` | | Removed, use `PMM_DEV_PERCONA_PLATFORM_ADDRESS` | - | `PERCONA_TEST_CHECKS_HOST` | | Removed, use `PMM_DEV_PERCONA_PLATFORM_ADDRESS` | + | `PERCONA_TEST_AUTH_HOST` | | Removed, use `PMM_PERCONA_PLATFORM_ADDRESS` | + | `PERCONA_TEST_CHECKS_HOST` | | Removed, use `PMM_PERCONA_PLATFORM_ADDRESS` | | `PERCONA_TEST_CHECKS_INTERVAL` | | Removed, not used | | `PERCONA_TEST_CHECKS_PUBLIC_KEY` | | Removed, use `PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY` | | `PERCONA_TEST_NICER_API` | | Removed in PMM v3 | - | `PERCONA_TEST_SAAS_HOST` | | Removed, use `PMM_DEV_PERCONA_PLATFORM_ADDRESS` | + | `PERCONA_TEST_SAAS_HOST` | | Removed, use `PMM_PERCONA_PLATFORM_ADDRESS` | diff --git a/get-pmm.sh b/get-pmm.sh index 62daf417b6a..383f419bd12 100755 --- a/get-pmm.sh +++ b/get-pmm.sh @@ -335,12 +335,12 @@ ENV_MAPPING=( "METRICS_RESOLUTION_MR=PMM_METRICS_RESOLUTION_MR" "OAUTH_PMM_CLIENT_ID=PMM_DEV_OAUTH_CLIENT_ID" "OAUTH_PMM_CLIENT_SECRET=PMM_DEV_OAUTH_CLIENT_SECRET" - "PERCONA_TEST_AUTH_HOST=PMM_DEV_PERCONA_PLATFORM_ADDRESS" + "PERCONA_TEST_AUTH_HOST=PMM_PERCONA_PLATFORM_ADDRESS" "PERCONA_TEST_CHECKS_FILE=PMM_DEV_ADVISOR_CHECKS_FILE" - "PERCONA_TEST_CHECKS_HOST=PMM_DEV_PERCONA_PLATFORM_ADDRESS" - "PERCONA_TEST_PLATFORM_ADDRESS=PMM_DEV_PERCONA_PLATFORM_ADDRESS" + "PERCONA_TEST_CHECKS_HOST=PMM_PERCONA_PLATFORM_ADDRESS" + "PERCONA_TEST_PLATFORM_ADDRESS=PMM_PERCONA_PLATFORM_ADDRESS" "PERCONA_TEST_PLATFORM_INSECURE=PMM_DEV_PERCONA_PLATFORM_INSECURE" - "PERCONA_TEST_SAAS_HOST=PMM_DEV_PERCONA_PLATFORM_ADDRESS" + "PERCONA_TEST_SAAS_HOST=PMM_PERCONA_PLATFORM_ADDRESS" "PERCONA_TEST_POSTGRES_ADDR=PMM_POSTGRES_ADDR" "PERCONA_TEST_POSTGRES_DBNAME=PMM_POSTGRES_DBNAME" "PERCONA_TEST_POSTGRES_SSL_CA_PATH=PMM_POSTGRES_SSL_CA_PATH" @@ -359,7 +359,7 @@ ENV_MAPPING=( "PERCONA_TEST_PMM_DISABLE_BUILTIN_CLICKHOUSE=PMM_DISABLE_BUILTIN_CLICKHOUSE" "PERCONA_TEST_PMM_DISABLE_BUILTIN_POSTGRES=PMM_DISABLE_BUILTIN_POSTGRES" "PERCONA_TEST_INTERFACE_TO_BIND=PMM_INTERFACE_TO_BIND" - "PERCONA_TEST_VERSION_SERVICE_URL=PMM_DEV_PERCONA_PLATFORM_ADDRESS" + "PERCONA_TEST_VERSION_SERVICE_URL=PMM_PERCONA_PLATFORM_ADDRESS" "PMM_TEST_TELEMETRY_FILE=PMM_DEV_TELEMETRY_FILE" "PERCONA_TEST_TELEMETRY_HOST=PMM_DEV_TELEMETRY_HOST" "PERCONA_TEST_TELEMETRY_INTERVAL=PMM_DEV_TELEMETRY_INTERVAL" diff --git a/managed/CONTRIBUTING.md b/managed/CONTRIBUTING.md index df5266ff111..03f7a9641c3 100644 --- a/managed/CONTRIBUTING.md +++ b/managed/CONTRIBUTING.md @@ -63,7 +63,7 @@ go test -timeout=30s -p 1 ./... | PMM_DEV_TELEMETRY_FILE | Sets path for telemetry config file | | | PMM_DEV_TELEMETRY_DISABLE_START_DELAY | Disable the default telemetry execution start delay, so that telemetry gathering is run immediately upon system | false | | PMM_DEV_TELEMETRY_RETRY_BACKOFF | Sets telemetry reporting retry backoff time | 1h | -| PMM_DEV_PERCONA_PLATFORM_ADDRESS | Sets Percona Platform address | https://check.percona.com | +| PMM_PERCONA_PLATFORM_ADDRESS | Sets Percona Platform address | https://check-dev.percona.com | ## Add instances for monitoring diff --git a/managed/utils/env/env.go b/managed/utils/env/env.go index 8adb81768a3..ea354e8b144 100644 --- a/managed/utils/env/env.go +++ b/managed/utils/env/env.go @@ -36,7 +36,7 @@ const ( PlatformAPITimeout = "PMM_DEV_PERCONA_PLATFORM_API_TIMEOUT" // PlatformAddress is the environment variable name used to store the URL for Percona Platform. - PlatformAddress = "PMM_DEV_PERCONA_PLATFORM_ADDRESS" + PlatformAddress = "PMM_PERCONA_PLATFORM_ADDRESS" // EnableInternalPgQAN is used to enable Query Analytics for PMM's internal PostgreSQL. EnableInternalPgQAN = "PMM_ENABLE_INTERNAL_PG_QAN" diff --git a/managed/utils/envvars/parser.go b/managed/utils/envvars/parser.go index 3b807c8827a..7ae6cf648a8 100644 --- a/managed/utils/envvars/parser.go +++ b/managed/utils/envvars/parser.go @@ -31,7 +31,7 @@ import ( ) const ( - defaultPlatformAddress = "https://check.percona.com" + defaultPlatformAddress = "https://check-dev.percona.com" defaultPlatformAPITimeout = 30 * time.Second // EnvVMAgentPrefix is the prefix for environment variables related to the VMAgent. EnvVMAgentPrefix = "VMAGENT_" @@ -246,6 +246,10 @@ func ParseEnvVars(envs []string) (*models.ChangeSettingsParams, []error, []strin // This variable is not part of the settings and is parsed separately. continue + case pkgenv.PlatformAddress: + // This variable is not part of the settings and is parsed separately. + continue + default: // handle prefixes diff --git a/ui/docker-compose.yml b/ui/docker-compose.yml index 4e682cd97b4..1658673bf8c 100644 --- a/ui/docker-compose.yml +++ b/ui/docker-compose.yml @@ -40,7 +40,6 @@ services: environment: - PMM_DEBUG=1 - GF_DEFAULT_APP_MODE=development - - PMM_DEV_PERCONA_PLATFORM_ADDRESS=https://check-dev.percona.com:443 - PMM_WATCHTOWER_HOST=http://watchtower:8080 - PMM_WATCHTOWER_TOKEN=123 # Uncomment to specify to which docker image to update