From d829cc43c615702da7e0c36731d53060d8bd2d1d Mon Sep 17 00:00:00 2001 From: Catalina A Date: Fri, 20 Dec 2024 18:13:33 +0200 Subject: [PATCH 1/3] updated docker image values --- documentation/docs/alert/contact_points.md | 2 +- documentation/docs/how-to/secure.md | 2 +- documentation/docs/install-pmm/HA.md | 4 ++-- .../install-pmm/install-pmm-client/docker.md | 8 ++++---- .../baremetal/docker/env_var.md | 2 +- .../baremetal/docker/restore_container.md | 20 +++++++++---------- .../docker/run_with_data_container.md | 4 ++-- .../baremetal/docker/run_with_host_dir.md | 4 ++-- .../baremetal/docker/run_with_vol.md | 4 ++-- .../baremetal/docker/upgrade_container.md | 4 ++-- .../baremetal/podman/index.md | 4 ++-- .../docs/pmm-admin/security/ssl_encryption.md | 4 ++-- .../docs/pmm-upgrade/migrating_from_pmm_2.md | 8 ++++---- .../docs/pmm-upgrade/upgrade_docker.md | 4 ++-- .../docs/pmm-upgrade/upgrade_helm.md | 2 +- .../docs/reference/third-party/postgresql.md | 2 +- .../share-dashboards/share_dashboard.md | 2 +- 17 files changed, 40 insertions(+), 40 deletions(-) diff --git a/documentation/docs/alert/contact_points.md b/documentation/docs/alert/contact_points.md index ebb7ddeb3e..5b740115c1 100644 --- a/documentation/docs/alert/contact_points.md +++ b/documentation/docs/alert/contact_points.md @@ -43,7 +43,7 @@ To use SMTP with a PMM Docker installation: *NB: If you are using your Gmail’s SMTP credentials as shown above, you will have to generate an app password and fill it in as the value of your $GF_SMTP_PASSWORD variable.* 2. Pass in the `.env` file to Docker run using the `--env-file` flag: ``` - docker run --env-file=.env -p 443:443 -p 80:80 perconalab/pmm-server:3.0.0-beta + docker run --env-file=.env -p 443:443 -p 80:80 percona/pmm-server:3 ``` This command starts a docker container and will keep running as long as the container is also running. Stopping the command (e.g with Ctrl+C) will stop the container hence, subsequent commands should be run in a new terminal. diff --git a/documentation/docs/how-to/secure.md b/documentation/docs/how-to/secure.md index 7210c3a0cd..b034f1a679 100644 --- a/documentation/docs/how-to/secure.md +++ b/documentation/docs/how-to/secure.md @@ -34,7 +34,7 @@ For example, if your own certificates are in `/etc/pmm-certs`: ```sh docker run -d -p 443:443 --volumes-from pmm-data \ --name pmm-server -v /etc/pmm-certs:/srv/nginx \ - --restart always perconalab/pmm-server:3.0.0-beta + --restart always percona/pmm-server:3 ``` !!! note alert alert-primary "" diff --git a/documentation/docs/install-pmm/HA.md b/documentation/docs/install-pmm/HA.md index 6052d56a85..a94d002a15 100644 --- a/documentation/docs/install-pmm/HA.md +++ b/documentation/docs/install-pmm/HA.md @@ -54,7 +54,7 @@ For all IP addresses, use the format `17.10.1.x`, and for all usernames and pass | `PMM_PASSIVE_NODE_ID` | The unique ID for your first passive PMM Server node.

Example: `pmm-server-passive` | `PMM_PASSIVE2_IP` | The IP address of the instance where the second passive PMM Server is running or the desired IP address for your second passive PMM Server container within the Docker network, depending on your setup.

Example: `17.10.1.7` | `PMM_PASSIVE2_NODE_ID` | The unique ID for your second passive PMM Server node.

Example: `pmm-server-passive2` -| `PMM_DOCKER_IMAGE`         | The specific PMM Server Docker image for this guide.

Example: `perconalab/pmm-server:3.0.0-beta` +| `PMM_DOCKER_IMAGE`         | The specific PMM Server Docker image for this guide.

Example: `percona/pmm-server:3` ??? example "Expected output" @@ -73,7 +73,7 @@ For all IP addresses, use the format `17.10.1.x`, and for all usernames and pass export PMM_PASSIVE_NODE_ID=pmm-server-passive export PMM_PASSIVE2_IP=17.10.1.7 export PMM_PASSIVE2_NODE_ID=pmm-server-passive2 - export PMM_DOCKER_IMAGE=perconalab/pmm-server:3.0.0-beta + export PMM_DOCKER_IMAGE=percona/pmm-server:3 ``` !!! note alert alert-primary "Note" diff --git a/documentation/docs/install-pmm/install-pmm-client/docker.md b/documentation/docs/install-pmm/install-pmm-client/docker.md index e571c51349..499d3159f8 100644 --- a/documentation/docs/install-pmm/install-pmm-client/docker.md +++ b/documentation/docs/install-pmm/install-pmm-client/docker.md @@ -9,7 +9,7 @@ The PMM Client Docker image is available for both x86_64 and ARM64 architectures ```sh docker pull \ - percona/pmm-client:2 + percona/pmm-client:3 ``` 2. Use the image as a template to create a persistent data store that preserves local data when the image is updated: @@ -18,7 +18,7 @@ The PMM Client Docker image is available for both x86_64 and ARM64 architectures docker create \ --volume /srv \ --name pmm-client-data \ - percona/pmm-client:2 /bin/true + percona/pmm-client:3 /bin/true ``` 3. Run the container to start [pmm-agent](../../use/commands/pmm-agent.md) in setup mode. Set `X.X.X.X` to the IP address of your PMM Server. (Do not use the `docker --detach` option as PMM agent only logs to the console.) @@ -35,7 +35,7 @@ The PMM Client Docker image is available for both x86_64 and ARM64 architectures -e PMM_AGENT_SETUP=1 \ -e PMM_AGENT_CONFIG_FILE=config/pmm-agent.yaml \ --volumes-from pmm-client-data \ - percona/pmm-client:2 + percona/pmm-client:3 ``` !!! hint alert-success "Tips" You can find a complete list of compatible environment variables [here](../../use/commands/pmm-agent.md). @@ -53,7 +53,7 @@ You can now add services with [`pmm-admin`](../../use/commands/pmm-admin.md) by !!! hint alert alert-success "Tips" - Adjust host firewall and routing rules to allow Docker communications. ([Read more](../../troubleshoot/checklist.md) - - For help: `docker run --rm percona/pmm-client:2 --help` + - For help: `docker run --rmpercona/pmm-client:3 --help` In the GUI: diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/env_var.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/env_var.md index 145d5b02d9..4afd87a201 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/env_var.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/env_var.md @@ -3,7 +3,7 @@ Configure PMM Server by setting Docker container environment variables using the `-e var=value` syntax: ```bash -docker run -e PMM_DATA_RETENTION=720h -e PMM_DEBUG=true perconalab/pmm-server:3.0.0-beta +docker run -e PMM_DATA_RETENTION=720h -e PMM_DEBUG=true percona/pmm-server:3 ``` ## Core configuration variables diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/restore_container.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/restore_container.md index 1ba2b6fdd8..49ecb77bbb 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/restore_container.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/restore_container.md @@ -39,7 +39,7 @@ To restore the container: 5. Remove Victoria Metrics data folder. ```sh - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta rm -r /srv/victoriametrics/data + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 rm -r /srv/victoriametrics/data ``` 6. Copy the data. @@ -51,15 +51,15 @@ To restore the container: 7. Restore permissions. ```sh - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R root:root /srv && \ - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R pmm:pmm /srv/alertmanager && \ - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R root:pmm /srv/clickhouse && \ - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R grafana:grafana /srv/grafana && \ - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R pmm:pmm /srv/logs && \ - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R postgres:postgres /srv/postgres14 && \ - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R pmm:pmm /srv/prometheus && \ - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R pmm:pmm /srv/victoriametrics && \ - docker run --rm --volumes-from pmm-data -it perconalab/pmm-server:3.0.0-beta chown -R postgres:postgres /srv/logs/postgresql14.log + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R root:root /srv && \ + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/alertmanager && \ + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R root:pmm /srv/clickhouse && \ + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R grafana:grafana /srv/grafana && \ + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/logs && \ + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R postgres:postgres /srv/postgres14 && \ + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/prometheus && \ + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/victoriametrics && \ + docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R postgres:postgres /srv/logs/postgresql14.log ``` 8. Start the image. diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md index 0d75300d01..e7e61d2aa3 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md @@ -9,7 +9,7 @@ To run Docker with data container: ```sh docker create --volume /srv \ --name pmm-data \ - perconalab/pmm-server:3.0.0-beta /bin/true + percona/pmm-server:3 /bin/true ``` !!! caution alert alert-warning "Important" @@ -38,7 +38,7 @@ To run Docker with data container: --volumes-from pmm-data \ --network=pmm_default \ --name pmm-server \ - perconalab/pmm-server:3.0.0-beta + percona/pmm-server:3 ``` 4. Change the password for the default `admin` user, replacing `your_secure_password123` with a strong, unique password: diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md index b27a4cfb24..da822d46e6 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md @@ -7,7 +7,7 @@ To run Docker with the host directory: 1. Pull the image: ```sh - docker pull perconalab/pmm-server:3.0.0-beta + docker pull percona/pmm-server:3 ``` 2. Run the image: @@ -20,7 +20,7 @@ To run Docker with the host directory: --volumes-from pmm-data \ --network=pmm_default \ --name pmm-server \ - perconalab/pmm-server:3.0.0-beta + percona/pmm-server:3 ``` 3. Change the password for the default `admin` user: diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md index 90c1cdc6bf..1495eaba3a 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md @@ -7,7 +7,7 @@ To run Docker with volume: 1. Pull the image: ```sh - docker pull perconalab/pmm-server:3.0.0-beta + docker pull percona/pmm-server:3 ``` 2. Create a volume: @@ -26,7 +26,7 @@ To run Docker with volume: --volumes-from pmm-data \ --network=pmm_default \ --name pmm-server \ - perconalab/pmm-server:3.0.0-beta + percona/pmm-server:3 ``` 4. Change the password for the default `admin` user, replacing `your_secure_password123` with a strong, unique password: diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/upgrade_container.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/upgrade_container.md index 8167bb96e7..b9c91e923c 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/upgrade_container.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/upgrade_container.md @@ -39,7 +39,7 @@ To upgrade the container: 3. Pull the latest image. ```sh - docker pull perconalab/pmm-server:3.0.0-beta + docker pull percona/pmm-server:3 ``` 4. Rename the original container @@ -58,7 +58,7 @@ To upgrade the container: --publish 443:443 \ --volumes-from pmm-data \ --name pmm-server \ - perconalab/pmm-server:3.0.0-beta + percona/pmm-server:3 ``` diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/index.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/index.md index e519f06198..8011749682 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/index.md @@ -79,7 +79,7 @@ On the other hand, the manual method offers a simpler setup with complete contro ```sh PMM_WATCHTOWER_HOST=http://watchtower:8080 PMM_WATCHTOWER_TOKEN=123 - PMM_IMAGE=docker.io/perconalab/pmm-server:3.0.0-beta + PMM_IMAGE=docker.io/percona/pmm-server:3 ``` 3. Create or update the Watchtower service file at `~/.config/systemd/user/watchtower.service`: @@ -154,7 +154,7 @@ On the other hand, the manual method offers a simpler setup with complete contro 2. Create the environment file at `~/.config/systemd/user/pmm-server.env`: ```sh - PMM_IMAGE=docker.io/perconalab/pmm-server:3.0.0-beta + PMM_IMAGE=docker.io/percona/pmm-server:3 ``` 3. Start services: diff --git a/documentation/docs/pmm-admin/security/ssl_encryption.md b/documentation/docs/pmm-admin/security/ssl_encryption.md index 54de5ebda7..f6c3f43b5a 100644 --- a/documentation/docs/pmm-admin/security/ssl_encryption.md +++ b/documentation/docs/pmm-admin/security/ssl_encryption.md @@ -20,7 +20,7 @@ For container-based installation, if your certificates are in a directory called ```sh docker run -d -p 443:443 --volumes-from pmm-data \ --name pmm-server -v /etc/pmm-certs:/srv/nginx \ - --restart always perconalab/pmm-server:3.0.0-beta + --restart always percona/pmm-server:3 ``` !!! note alert alert-primary "" @@ -66,7 +66,7 @@ docker run \ -e PMM_AGENT_CONFIG_FILE=config/pmm-agent.yaml \ -v /your_directory_with/certs:/etc/pki/tls/certs \ --volumes-from pmm-client-data \ -percona/pmm-client:2 +percona/pmm-client:3 ``` diff --git a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md index 1db602c8d8..3c6966ef05 100644 --- a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md +++ b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md @@ -47,13 +47,13 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio 5. Pull PMM 3 Server image: ```sh - docker pull perconalab/pmm-server:3.0.0-beta + docker pull percona/pmm-server:3 ``` 6. Run new container with existing volume: ```sh - docker run -d -v pmm-server-data:/srv -p 443:8443 --name pmm-server --restart always perconalab/pmm-server:3.0.0-beta + docker run -d -v pmm-server-data:/srv -p 443:8443 --name pmm-server --restart always percona/pmm-server:3 ``` === "PMM 2 with data container" @@ -96,13 +96,13 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio 5. Pull PMM 3 Server image: ```sh - docker pull perconalab/pmm-server:3.0.0-beta + docker pull percona/pmm-server:3 ``` 6. Run new container with existing data container: ```sh - docker run -d --volumes-from pmm-server-data -p 443:8443 --name pmm-server --restart always perconalab/pmm-server:3.0.0-beta + docker run -d --volumes-from pmm-server-data -p 443:8443 --name pmm-server --restart always percona/pmm-server:3 ``` ## Step 3: Migrate PMM 2 Clients to PMM 3 diff --git a/documentation/docs/pmm-upgrade/upgrade_docker.md b/documentation/docs/pmm-upgrade/upgrade_docker.md index 5e76d457f1..009d55ea72 100644 --- a/documentation/docs/pmm-upgrade/upgrade_docker.md +++ b/documentation/docs/pmm-upgrade/upgrade_docker.md @@ -29,7 +29,7 @@ Follow these steps to upgrade your PMM Server while preserving your monitoring d 3. Pull the latest image: ```sh - docker pull perconalab/pmm-server:3.0.0-beta + docker pull percona/pmm-server:3 ``` 4. Rename the original container: @@ -47,7 +47,7 @@ Follow these steps to upgrade your PMM Server while preserving your monitoring d --publish 443:8443 \ --volumes-from pmm-data \ --name pmm-server \ - perconalab/pmm-server:3.0.0-beta + percona/pmm-server:3 ``` 6. After upgrading, verify that PMM Server is running correctly and all your data is accessible. diff --git a/documentation/docs/pmm-upgrade/upgrade_helm.md b/documentation/docs/pmm-upgrade/upgrade_helm.md index d034be6231..77bd59a72f 100644 --- a/documentation/docs/pmm-upgrade/upgrade_helm.md +++ b/documentation/docs/pmm-upgrade/upgrade_helm.md @@ -24,7 +24,7 @@ Before starting the upgrade, complete these preparation steps to ensure you can ```sh # Replace with the latest PMM version - docker pull perconalab/pmm-server:3.0.0-beta + docker pull percona/pmm-server:3 ``` ## Upgrade steps diff --git a/documentation/docs/reference/third-party/postgresql.md b/documentation/docs/reference/third-party/postgresql.md index c8bc839074..f780df7ab9 100644 --- a/documentation/docs/reference/third-party/postgresql.md +++ b/documentation/docs/reference/third-party/postgresql.md @@ -103,5 +103,5 @@ To use PostgreSQL as an external database: -e GF_DATABASE_CA_CERT_PATH=$GF_CA_PATH -e GF_DATABASE_CLIENT_KEY_PATH=$GF_KEY_PATH -e GF_DATABASE_CLIENT_CERT_PATH=$GF_CERT_PATH - perconalab/pmm-server:3.0.0-beta + percona/pmm-server:3 ``` diff --git a/documentation/docs/use/dashboards-panels/share-dashboards/share_dashboard.md b/documentation/docs/use/dashboards-panels/share-dashboards/share_dashboard.md index 82ae55bc27..6066e94caa 100644 --- a/documentation/docs/use/dashboards-panels/share-dashboards/share_dashboard.md +++ b/documentation/docs/use/dashboards-panels/share-dashboards/share_dashboard.md @@ -50,7 +50,7 @@ To enable image rendering: -p 8443:443 \ -e GF_RENDERING_SERVER_URL=http://renderer:8081/render \ -e GF_RENDERING_CALLBACK_URL=https://pmm-server:8443/graph/ \ - perconalab/pmm-server:3.0.0-beta + percona/pmm-server:3 ``` ### Render panel image From 8bb356865f86bf61a2d9aba0baa26af8290a5058 Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Fri, 10 Jan 2025 14:13:27 +0200 Subject: [PATCH 2/3] added script option (#3438) --- .../docs/pmm-upgrade/migrating_from_pmm_2.md | 37 ++++++++++++++----- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md index 3c6966ef05..035c1986e9 100644 --- a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md +++ b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md @@ -1,6 +1,9 @@ # Migrate PMM 2 to PMM 3 -PMM 3 introduces significant architectural changes that require gradual transition from PMM 2: +PMM 3 introduces significant architectural changes that require gradual transition from PMM 2. +You can migrate to PMM 3 either automatically using the upgrade script (recommended), or manually by following step-by-step instructions. + +To graduallly migrate to PMM 3: ## Step 1: Upgrade PMM 2 Server to the latest version @@ -13,7 +16,21 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio ## Step 2: Migrate PMM 2 Server to PMM 3 -=== "PMM 2 with Docker volume" +=== "Automated upgrade (Recommended)" + Use this upgrade script for a simplified migration process: + + 1. Download and run the following script to start the upgrade. The `-b` flag ensures your data is backed up before the upgrade. + + ```sh + ./get-pmm.sh -n -b + ``` + + 2. Check additional script options: + ```sh + ./get-pmm.sh -h + ``` + +=== "Manual upgrade from PMM 2 with Docker volume" Follow these manual steps to upgrade your PMM 2 Server to PMM 3: { .power-number} @@ -27,7 +44,7 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio 2. Transfer `/srv` directory ownership: ```sh - docker exec -t chown -R pmm:pmm /srv + docker exec -t chown -R pmm:pmm /srv ``` 3. List and note down your Docker volume: @@ -50,13 +67,13 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio docker pull percona/pmm-server:3 ``` - 6. Run new container with existing volume: + 6. Run new new version of PMM Server with the existing volume: ```sh docker run -d -v pmm-server-data:/srv -p 443:8443 --name pmm-server --restart always percona/pmm-server:3 ``` -=== "PMM 2 with data container" +=== "Manual upgrade from PMM 2 with data container" Follow these manual steps to upgrade your PMM 2 Server to PMM 3: { .power-number} @@ -73,7 +90,7 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio docker exec -t chown -R pmm:pmm /srv ``` - 3. Identify data container using either: + 3. Identify the data container using either: ```sh docker ps -a --filter "status=created" @@ -87,7 +104,7 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio {% endraw %} ``` - 4. Stop and remove existing container: + 4. Stop and remove the existing container: ```sh docker stop pmm-server && docker rm pmm-server @@ -99,7 +116,7 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio docker pull percona/pmm-server:3 ``` - 6. Run new container with existing data container: + 6. Run the new version of PMM Server with the existing data container: ```sh docker run -d --volumes-from pmm-server-data -p 443:8443 --name pmm-server --restart always percona/pmm-server:3 @@ -110,7 +127,7 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio !!! caution alert alert-warning "Important" PMM 3 Server provides limited support for PMM 2 Clients (metrics and Query Analytics only). This support will be removed in PMM 3.3. -Depending on your initial installation method, update PMM Clients using your operating system's package manager or by updating from a tarball. +Depending on your initial installation method, update PMM Clients using your operating system's package manager or using a tarball. For detailed instructions, see the [Upgrade PMM Client topic](../pmm-upgrade/upgrade_client.md). ### Post-migration steps @@ -120,4 +137,4 @@ After you finish migrating: 1. Verify that all PMM Clients are up to date by checking **PMM Configuration > Updates**. 2. Confirm all previously monitored services are reporting correctly to the new PMM 3 Server by reviewing **Configuration > PMM Inventory > Services**. -3. Check the dashboards to make sure you're receiving the metrics information and QAN data. +3. Check the dashboards to make sure you're receiving the metrics and QAN data. From 1a3170f464531de67abc073c77f73d200119c0a6 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Fri, 10 Jan 2025 15:27:18 +0300 Subject: [PATCH 3/3] PMM-12644 Remove the use of data container (#3414) * PMM-12664 Remove the use of the data container * PMM-12664 Fix the GA image name --------- Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- .github/workflows/main.yml | 8 +-- .../baremetal/docker/backup_container.md | 15 ++--- .../baremetal/docker/index.md | 5 +- .../baremetal/docker/remove_container.md | 27 ++++----- .../baremetal/docker/restore_container.md | 36 +++--------- .../docker/run_with_data_container.md | 56 ------------------- .../baremetal/docker/run_with_host_dir.md | 18 +++--- .../baremetal/docker/run_with_vol.md | 8 +-- .../baremetal/helm/index.md | 2 +- .../baremetal/podman/index.md | 2 +- .../docs/pmm-upgrade/migrating_from_pmm_2.md | 1 + .../docs/pmm-upgrade/upgrade_helm.md | 2 +- documentation/mkdocs-base.yml | 1 - 13 files changed, 51 insertions(+), 130 deletions(-) delete mode 100644 documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 8c965b6086..4c39cff41b 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -139,20 +139,20 @@ jobs: git status - typos_check: + spell-check: + name: Spell check runs-on: ubuntu-latest steps: - name: Check out code uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - with: - fetch-depth: 0 + - name: Check spelling of md files uses: crate-ci/typos@9d890159570d5018df91fedfa40b4730cd4a81b1 # v1.28.4 with: files: "**/*.md ./documentation/**/*.md" merge-gatekeeper: - needs: [ check, typos_check ] + needs: [ check, spell-check ] name: Merge Gatekeeper if: ${{ always() }} runs-on: ubuntu-22.04 diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/backup_container.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/backup_container.md index 1f225880bf..95db4da927 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/backup_container.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/backup_container.md @@ -5,19 +5,20 @@ !!! summary alert alert-info "" - Stop and rename the `pmm-server` container. - - Take a local copy of the `pmm-data` container's `/srv` directory. + - Take a local copy of the `pmm-server` container's `/srv` directory. --- !!! caution alert alert-warning "Important" - Grafana plugins have been moved to the data volume `/srv` since the 2.23.0 version. So if you are upgrading PMM from any version before 2.23.0 and have installed additional plugins then plugins should be installed again after the upgrade. + Grafana plugins have been moved to the `/srv` directory since the 2.23.0 version. So if you are upgrading PMM from any version before 2.23.0 and have installed additional plugins then plugins should be installed again after the upgrade. To check used Grafana plugins: ```sh - docker exec -it pmm-server ls /var/lib/grafana/plugins + docker exec -t pmm-server ls -l /var/lib/grafana/plugins ``` -To backup container: + +To back up the container: {.power-number} 1. Stop the container: @@ -26,13 +27,13 @@ To backup container: docker stop pmm-server ``` -2. Move the image: +2. Rename the image: ```sh docker rename pmm-server pmm-server-backup ``` -3. Create a subdirectory (e.g., `pmm-data-backup`) and move to it: +3. Create a subdirectory (e.g., `pmm-data-backup`) and change directory to it: ```sh mkdir pmm-data-backup && cd pmm-data-backup @@ -41,5 +42,5 @@ To backup container: 4. Back up the data: ```sh - docker cp pmm-data:/srv . + docker cp pmm-server-backup:/srv . ``` diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/index.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/index.md index d73990beb9..dbf5bf0e16 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/index.md @@ -14,7 +14,6 @@ You can also install PMM 3 manually, following the instructions below. Before starting the installation, review the installation prerequisites below and choose a method to run PMM Server with Docker based on your preferred data storage option: -- [Running Docker with Data container](../docker/run_with_data_container.md) - [Running Docker with host directory](../docker/run_with_host_dir.md) - [Running Docker with volume](../docker/run_with_vol.md) @@ -35,14 +34,14 @@ Before starting the installation, review the installation prerequisites below an !!! summary alert alert-info "" - Pull the Docker image. - - Copy it to create a persistent data container. + - Choose how you want to store data. - Run the image. - Open the PMM UI in a browser. --- ??? info "Key points" - - To disable the Home Dashboard **PMM Upgrade** panel you can either add `-e DISABLE_UPDATES=true` to the `docker run` command (for the life of the container) or navigate to _PMM --> PMM Settings --> Advanced Settings_ and disable "Check for Updates" (can be turned back on by any admin in the UI). + - To disable the Home Dashboard **PMM Upgrade** panel you can either add `-e PMM_ENABLE_UPDATES=false` to the `docker run` command (for the life of the container) or navigate to _PMM --> PMM Settings --> Advanced Settings_ and disable "Check for Updates" (can be turned back on by any admin in the UI). - Eliminate browser certificate warnings by configuring a [trusted certificate](https://docs.percona.com/percona-monitoring-and-management/how-to/secure.html#ssl-encryption). diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/remove_container.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/remove_container.md index b16b1bd0ee..8812609869 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/remove_container.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/remove_container.md @@ -1,34 +1,31 @@ # Remove container -??? info "Summary" - - !!! summary alert alert-info "" - - Stop the container. - - Remove (delete) both the server and data containers. - - Remove (delete) both images. - - --- - !!! caution alert alert-warning "Caution" These steps delete the PMM Server Docker image and any accumulated PMM metrics data. To remove the container: {.power-number} -1. Stop pmm-server container. +1. Stop pmm-server container: ```sh docker stop pmm-server ``` -2. Remove containers. +2. Remove the container: + + ```sh + docker rm pmm-server + ``` + +3. Remove the data volume: ```sh - docker rm pmm-server pmm-data + docker volume rm pmm-data ``` -3. Remove the image. +4. Remove the image: ```sh - docker rmi $(docker images | grep "percona/pmm-server" | awk {'print $3'}) - ``` \ No newline at end of file + docker rmi $(docker images | grep "percona/pmm-server" | awk '{print $3}') + ``` diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/restore_container.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/restore_container.md index 49ecb77bbb..3033252b70 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/restore_container.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/restore_container.md @@ -1,15 +1,5 @@ # Restore container -??? info "Summary" - - !!! summary alert alert-info "" - - Stop and remove the container. - - Restore (rename) the backup container. - - Restore saved data to the data container. - - Restore permissions to the data. - - --- - !!! caution alert alert-warning "Important" You must have a [backup](backup_container.md) to restore from. @@ -22,7 +12,7 @@ To restore the container: docker stop pmm-server ``` -2. Remove it. +2. Remove the container. ```sh docker rm pmm-server @@ -36,36 +26,24 @@ To restore the container: 4. Change directory to the backup directory (e.g. `pmm-data-backup`). -5. Remove Victoria Metrics data folder. - ```sh - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 rm -r /srv/victoriametrics/data + cd pmm-data-backup ``` -6. Copy the data. +5. Copy the data. ```sh - docker cp srv pmm-data:/ + docker run --rm -v $(pwd)/srv:/backup -v pmm-data:/srv -t percona/pmm-server:3 cp -r /backup/* /srv ``` -7. Restore permissions. +6. Restore permissions. ```sh - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R root:root /srv && \ - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/alertmanager && \ - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R root:pmm /srv/clickhouse && \ - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R grafana:grafana /srv/grafana && \ - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/logs && \ - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R postgres:postgres /srv/postgres14 && \ - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/prometheus && \ - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/victoriametrics && \ - docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R postgres:postgres /srv/logs/postgresql14.log + docker run --rm -v pmm-data:/srv -t percona/pmm-server:3 chown -R pmm:pmm /srv ``` -8. Start the image. +7. Start the image. ```sh docker start pmm-server ``` - - diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md deleted file mode 100644 index e7e61d2aa3..0000000000 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md +++ /dev/null @@ -1,56 +0,0 @@ - -# Run Docker with data container - -To run Docker with data container: -{.power-number} - -1. Create a persistent data container: - - ```sh - docker create --volume /srv \ - --name pmm-data \ - percona/pmm-server:3 /bin/true - ``` - - !!! caution alert alert-warning "Important" - PMM Server expects the data volume to be `/srv`. Using any other value will result in **data loss** when upgrading. - - To check server and data container mount points: - - ```sh - docker inspect pmm-data | grep Destination && \ - docker inspect pmm-server | grep Destination - ``` - -2. Create the Docker network: - - ```sh - docker network create pmm_default - ``` - -3. Run the image: - - ```sh - docker run --detach --restart always \ - --publish 443:8443 \ - --env PMM_WATCHTOWER_HOST=your_watchtower_host \ - --env PMM_WATCHTOWER_TOKEN=your_watchtower_token \ - --volumes-from pmm-data \ - --network=pmm_default \ - --name pmm-server \ - percona/pmm-server:3 - ``` - -4. Change the password for the default `admin` user, replacing `your_secure_password123` with a strong, unique password: - - ```sh - docker exec -t pmm-server change-admin-password your_secure_password123 - ``` - -5. Check the [WatchTower prerequisites](../docker/index.md|#prerequisites) and pass the following command to Docker Socket to start [Watchtower](https://containrrr.dev/watchtower/): - - ```sh - docker run -v /var/run/docker.sock:/var/run/docker.sock -e WATCHTOWER_HTTP_API_UPDATE=1 -e WATCHTOWER_HTTP_API_TOKEN=your_watchtower_token --hostname=your_watchtower_host --network=pmm_default docker.io/perconalab/watchtower - ``` - -6. Visit `https://localhost:443` to see the PMM user interface in a web browser. If you are accessing the docker host remotely, replace `localhost` with the IP or server name of the host. diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md index da822d46e6..1e83e217a4 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md @@ -10,37 +10,39 @@ To run Docker with the host directory: docker pull percona/pmm-server:3 ``` -2. Run the image: +2. Identify a directory on the host that you want to use to persist PMM data. For example, `/home/user/srv`. + +3. Run the image: ```sh docker run --detach --restart always \ --publish 443:8443 \ --env PMM_WATCHTOWER_HOST=your_watchtower_host \ --env PMM_WATCHTOWER_TOKEN=your_watchtower_token \ - --volumes-from pmm-data \ + --volume /home/user/srv:/srv \ --network=pmm_default \ --name pmm-server \ percona/pmm-server:3 ``` -3. Change the password for the default `admin` user: +4. Change the password for the default `admin` user: ```sh docker exec -t pmm-server change-admin-password ``` -4. Check the [WatchTower prerequisites](../docker/index.md|#prerequisites) and pass the following command to Docker Socket to start [Watchtower](https://containrrr.dev/watchtower/): +5. Check the [WatchTower prerequisites](../docker/index.md|#prerequisites) and pass the following command to Docker Socket to start [Watchtower](https://containrrr.dev/watchtower/): ```sh docker run -v /var/run/docker.sock:/var/run/docker.sock -e WATCHTOWER_HTTP_API_UPDATE=1 -e WATCHTOWER_HTTP_API_TOKEN=your_watchtower_token --hostname=your_watchtower_host --network=pmm_default docker.io/perconalab/watchtower ``` -5. Visit `https://localhost:443` to see the PMM user interface in a web browser. (If you are accessing the docker host remotely, replace `localhost` with the IP or server name of the host.) +6. Visit `https://localhost:443` to see the PMM user interface in a web browser. (If you are accessing the docker host remotely, replace `localhost` with the IP or server name of the host.) -## Migrate from data container to host directory/volume +## Migrate from data container to host directory -To migrate your PMM from data container to host directory or volume run the following command: +To migrate your PMM from data container to host directory, run the following command: ```sh -docker cp :/srv /target/host/directory +docker cp :/srv /target/host/directory ``` diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md index 1495eaba3a..d4502fca8f 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md @@ -23,16 +23,16 @@ To run Docker with volume: --publish 443:8443 \ --env PMM_WATCHTOWER_HOST=your_watchtower_host \ --env PMM_WATCHTOWER_TOKEN=your_watchtower_token \ - --volumes-from pmm-data \ + --volume pmm-data:/srv \ --network=pmm_default \ --name pmm-server \ percona/pmm-server:3 ``` -4. Change the password for the default `admin` user, replacing `your_secure_password123` with a strong, unique password: +4. Change the password for the default `admin` user, replacing `your_secure_password` with a strong, unique password: ```sh - docker exec -t pmm-server change-admin-password your_secure_password123 + docker exec -t pmm-server change-admin-password your_secure_password ``` 5. Check the [WatchTower prerequisites](../docker/index.md|#prerequisites) and pass the following command to Docker Socket to start [Watchtower](https://containrrr.dev/watchtower/): @@ -41,4 +41,4 @@ To run Docker with volume: docker run -v /var/run/docker.sock:/var/run/docker.sock -e WATCHTOWER_HTTP_API_UPDATE=1 -e WATCHTOWER_HTTP_API_TOKEN=your_watchtower_token --hostname=your_watchtower_host --network=pmm_default docker.io/perconalab/watchtower ``` -6. Visit `https://localhost:443` to see the PMM user interface in a web browser. If you are accessing the Docker host remotely, replace `localhost` with the IP or server name of the host. \ No newline at end of file +6. Visit `https://localhost:443` to see the PMM user interface in a web browser. If you are accessing the Docker host remotely, replace `localhost` with the IP or server name of the host. diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/helm/index.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/helm/index.md index 0c936e711a..6ac0d59fb1 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/helm/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/helm/index.md @@ -140,7 +140,7 @@ In case you want to add extra environment variables (useful for advanced operati ```yaml pmmEnv: - DISABLE_UPDATES: "1" + PMM_ENABLE_UPDATES: "1" ``` ### PMM SSL certificates diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/index.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/index.md index 6e3f45608e..162be23690 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/index.md @@ -232,7 +232,7 @@ To run Podman as a non-privileged user: # keep updates disabled # do image replacement instead (update the tag and restart the service) - DISABLE_UPDATES=1 + PMM_ENABLE_UPDATES=1 EOF ``` diff --git a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md index 035c1986e9..1fe7549160 100644 --- a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md +++ b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md @@ -1,6 +1,7 @@ # Migrate PMM 2 to PMM 3 PMM 3 introduces significant architectural changes that require gradual transition from PMM 2. + You can migrate to PMM 3 either automatically using the upgrade script (recommended), or manually by following step-by-step instructions. To graduallly migrate to PMM 3: diff --git a/documentation/docs/pmm-upgrade/upgrade_helm.md b/documentation/docs/pmm-upgrade/upgrade_helm.md index 77bd59a72f..419fac8bff 100644 --- a/documentation/docs/pmm-upgrade/upgrade_helm.md +++ b/documentation/docs/pmm-upgrade/upgrade_helm.md @@ -10,7 +10,7 @@ Percona releases new chart versions to update containers when: The UI update feature is disabled by default and should remain so. Do not modify or add the following parameter in your custom `values.yaml` file: ```yaml pmmEnv: - DISABLE_UPDATES: "1" + PMM_ENABLE_UPDATES: "1" ``` ## Before you begin diff --git a/documentation/mkdocs-base.yml b/documentation/mkdocs-base.yml index 4e6275a191..70738860e6 100644 --- a/documentation/mkdocs-base.yml +++ b/documentation/mkdocs-base.yml @@ -152,7 +152,6 @@ nav: - install-pmm/install-pmm-server/baremetal/docker/easy-install.md - install-pmm/install-pmm-server/baremetal/docker/index.md - install-pmm/install-pmm-server/baremetal/docker/run_with_vol.md - - install-pmm/install-pmm-server/baremetal/docker/run_with_data_container.md - install-pmm/install-pmm-server/baremetal/docker/run_with_host_dir.md - install-pmm/install-pmm-server/baremetal/docker/backup_container.md - install-pmm/install-pmm-server/baremetal/docker/restore_container.md