diff --git a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md index 24668ac8b3..1fe7549160 100644 --- a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md +++ b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md @@ -2,6 +2,10 @@ 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 Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest version: @@ -13,7 +17,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 +45,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 +68,13 @@ Before upgrading to PMM 3, ensure your PMM 2 Server is running the latest versio docker pull percona/pmm-server:3 ``` - 6. Run the new version of PMM Server with the 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} @@ -110,7 +128,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 update from the 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