Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env.dev.example
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/api-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 0 additions & 2 deletions agent/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 0 additions & 2 deletions api-tests/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions build/docker/server/Dockerfile.el9
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions build/scripts/build-server-docker
Original file line number Diff line number Diff line change
Expand Up @@ -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}/
Expand Down
1 change: 0 additions & 1 deletion dashboards/pmm-app/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions dev/docs/process/best_practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down
10 changes: 5 additions & 5 deletions dev/docs/process/v2_to_v3_environment_variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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` | |
Expand All @@ -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` | |
Expand All @@ -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+
Expand Down
6 changes: 3 additions & 3 deletions documentation/docs/pmm-upgrade/migrating_from_pmm_2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
10 changes: 5 additions & 5 deletions get-pmm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion managed/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion managed/utils/env/env.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
6 changes: 5 additions & 1 deletion managed/utils/envvars/parser.go
Original file line number Diff line number Diff line change
Expand Up @@ -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_"
Expand Down Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion ui/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading