PMM-13025 - Upgrade changes #1316

catalinaadam · 2024-10-04T13:05:45Z

No description provided.

This reverts commit 6ae1b0d.

README.md

docs/alert/silence_alerts.md

docs/how-to/upgrade.md

docs/pmm-upgrade/upgrade_docker.md

docs/pmm-upgrade/upgrade_from_ppm_2.md

docs/pmm-upgrade/upgrade_podman.md

docs/troubleshoot/upgrade_issues.md

Co-authored-by: Matej Kubinec <[email protected]>

BupycHuk

probably we need to mention that we run watchtower next to PMM Server and used for UI upgrade. it upgrades PMM Server by replacing docker containers.
For that watchtower requires access to docker socket, it's safe, because watchtower is not exposed anywhere outside of docker network.

BupycHuk · 2024-10-21T12:11:05Z

README.md


- `main` is for PMM 2.x (latest)
+- `PMM3-branch` is for PMM 3.x (latest)


I would make it v3 like in other repos.

@BupycHuk , yes, I was planning to rename main to 2.x and PMM3-branch to 3.x after GA, when PMM-3-branch becomes main. Or shall we do this when we move the doc repo to the pmm code repo?

BupycHuk · 2024-10-21T12:12:40Z

docs/alert/silence_alerts.md

@@ -29,9 +29,9 @@ For more information on working with silences, see [About alerting silences](htt

 ### Template compatibility with previous PMM versions

-If you have used Integrated Alerting in previous PMM versions, your custom alert rule templates will be automatically migrated to the new PMM version. After upgrading to the new version, you will find all your alert templates under **Alerting > Alert rule templates**.
+If you have used Integrated Alerting in previous PMM 2.31 and earlier, your custom alert rule templates will be automatically migrated to the new PMM version. After upgrading to the new version, you will find all your alert templates under **Alerting > Alert rule templates**.


we support upgrade only from the latest PMM 2, so I think we can drop it from here.

BupycHuk · 2024-10-21T12:13:42Z

docs/backup/index.md

@@ -20,7 +20,7 @@ For MySQL databases, you can create and restore on-demand and scheduled physical

 ### Sharded MongoDB cluster configurations


@rnovikovP should we deprecate Backup in PMM or we keep supporting it until SEP integration?

BupycHuk · 2024-10-21T12:16:31Z

docs/how-to/upgrade.md

+1. run docker exec -t <pmm-server> supervisorctl stop all to stop all services of pmm-server container
+2. run docker exec -t <pmm-server> chown -R pmm:pmm /srv to transfer ownership of all directories and files located in /srv directory to pmm user
+3. stop and remove pmm-server container (docker stop pmm-server && docker rm pmm-server )
+4. pull a new docker image for PMM Server v3 (once it goes GA, it will be docker pull percona/pmm-server:3 )


I think we should recommend to do it as the first step to have shorter PMM down period.

thanks, @BupycHuk. I. have made this change in the docs/pmm-upgrade/upgrade_from_ppm_2.md topic. This is the originanting topic, which got separated into individual ones. I have deleted it now as it only duplicates content now.

BupycHuk · 2024-10-21T12:17:42Z

docs/how-to/upgrade.md

+2. run docker exec -t <pmm-server> chown -R pmm:pmm /srv to transfer ownership of all directories and files located in /srv directory to pmm user
+3. stop and remove pmm-server container (docker stop pmm-server && docker rm pmm-server )
+4. pull a new docker image for PMM Server v3 (once it goes GA, it will be docker pull percona/pmm-server:3 )
+5. run a new container based on v3 image (see above) while remembering to pass the same pmm-data volume to it (docker run -d -v pmm-data:/srv ... percona/pmm-server:3 )



we also need to mention that environment variables were changed between PMM 2 and PMM 3. @catalinaadam @idoqo do we have list somewhere public?

@BupycHuk , Added a section in the Environment variabled topic

I think we need to expand that. have you checked this doc https://github.com/percona/pmm/blob/v3/docs/process/v2_to_v3_environment_variables.md ?

BupycHuk · 2024-10-21T12:19:09Z

docs/how-to/upgrade.md

+!!! caution alert alert-warning "Known issue for older versions"
    - PMM versions prior to 2.33.0 may not show the latest versions available with instances created from the AWS marketplace in specific environments, including AWS. For solution, see the [troubleshooting](../how-to/troubleshoot.md#pmm-server-not-showing-latest-versions-available-with-the-instances-created-from-aws) section.


I think we can drop it for V3

BupycHuk · 2024-10-21T12:19:50Z

docs/how-to/upgrade.md


-![!image](../_images/PMM_Home_Dashboard_Panels_Upgrade.jpg)

 The panel shows:



there is below section about upgrading from PMM 1, I think we can drop it.

deleted duplicate topic

BupycHuk · 2024-10-21T12:21:23Z

docs/pmm-upgrade/upgrade_agent.md

+ yum --showduplicates search pmm2-client
+ pmm2-client-2.39.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.40.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.40.1-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.41.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.41.1-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.41.2-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.42.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+
+ yum update pmm2-client-2.41.2-6.el9.x86_64


I think in examples we should use PMM 3 versions. For PMM 3 package name is pmm-client.

BupycHuk · 2024-10-21T12:22:08Z

docs/pmm-upgrade/upgrade_from_ppm_2.md

@@ -0,0 +1,68 @@
+# Upgrade from PMM 2 to PMM 3


filename has typo, it should be pmm, not ppm

BupycHuk · 2024-10-21T12:23:27Z

docs/how-to/upgrade.md

+Always upgrade the PMM Server before you upgrade the PMM Client.
+Ensure that the PMM Server version is equal to or higher than the PMM Client version. Otherwise, configuration issues may arise, potentially causing failures in Client-Server communication, as the PMM Server may not recognize all the configuration parameters.
+
+### Migrating from PMM 2


seems like this block duplicates file below

Co-authored-by: Matej Kubinec <[email protected]>

ademidoff · 2024-10-23T11:00:57Z

docs/pmm-upgrade/upgrade_agent.md

+ ```sh
+ yum --showduplicates search pmm2-client
+ pmm2-client-2.39.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.40.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.40.1-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.41.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.41.1-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.41.2-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+ pmm2-client-2.42.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)
+
+ yum update pmm2-client-2.41.2-6.el9.x86_64


Suggested change

```sh

yum --showduplicates search pmm2-client

pmm2-client-2.39.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

pmm2-client-2.40.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

pmm2-client-2.40.1-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

pmm2-client-2.41.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

pmm2-client-2.41.1-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

pmm2-client-2.41.2-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

pmm2-client-2.42.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

yum update pmm2-client-2.41.2-6.el9.x86_64

```sh

yum --showduplicates search pmm-client

pmm-client-3.0.0-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

pmm-client-3.0.1-6.el9.x86_64 : Percona Monitoring and Management Client (pmm-agent)

yum update pmm-client-3.0.1-6.el9.x86_64

Note: the packages do not exist yet, but they are anticipated to be like that.

BupycHuk · 2024-10-24T13:14:48Z

docs/install-pmm/install-pmm-server/baremetal/docker/env_var.md

+    | `PERCONA_TEST_TELEMETRY_DISABLE_START_DELAY` | `PMM_DEV_TELEMETRY_DISABLE_START_DELAY` | 
+    | `PMM_TEST_TELEMETRY_FILE`           | `PMM_DEV_TELEMETRY_FILE`           |   
+    | `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`  | `PMM_DEV_VERSION_SERVICE_URL`      |         
+    | `PERCONA_TEST_STARLARK_ALLOW_RECURSION` | `PMM_DEV_ADVISOR_STARLARK_ALLOW_RECURSION` |       


let's drop PMM_DEV_* env variables as they are for developers.

BupycHuk · 2024-10-24T13:15:00Z

docs/install-pmm/install-pmm-server/baremetal/docker/env_var.md

+    | PMM 2                          | PMM 3                              | 
+    |---------------------------------|------------------------------------|
+    | `OAUTH_PMM_CLIENT_ID`           | `PMM_DEV_OAUTH_CLIENT_ID`          |  
+    | `OAUTH_PMM_CLIENT_SECRET`       | `PMM_DEV_OAUTH_CLIENT_SECRET`      | 
+    | `PERCONA_PLATFORM_API_TIMEOUT`  | `PMM_DEV_PERCONA_PLATFORM_API_TIMEOUT` |  
+    | `PERCONA_TEST_PLATFORM_ADDRESS` | `PMM_DEV_PERCONA_PLATFORM_ADDRESS` |      
+    | `PERCONA_TEST_PLATFORM_INSECURE`| `PMM_DEV_PERCONA_PLATFORM_INSECURE`|        
+    | `PERCONA_TEST_PLATFORM_PUBLIC_KEY` | `PMM_DEV_PERCONA_PLATFORM_PUBLIC_KEY` |     


let's drop PMM_DEV_* env variables as they are for developers.

BupycHuk · 2024-10-24T13:18:06Z

docs/pmm-upgrade/upgrade_from_pmm_2.md

+
+    ```sh
+    docker pull percona/pmm-server:3
+    ```1. Stop all services of the PMM 2 server container:


something went wrong with formatting here

BupycHuk · 2024-10-24T13:19:32Z

docs/reference/faq.md

-!!! seealso alert alert-info "See also"
-    - [Upgrade from PMM1](how-to/upgrade.md#upgrade-from-pmm-1)
-    - [Percona blog: Running PMM1 and PMM2 Clients on the Same Host](https://www.percona.com/blog/2019/11/27/running-pmm1-and-pmm2-clients-on-the-same-host/)
+A direct software upgrade path is not available. For detailed instructions, see [Upgrade from PMM2](../pmm-upgrade/upgrade_from_pmm_2.md)


for PMM 2 to PMM 3 we have direct upgrade, it's not the same as PMM 1 to PMM 2 upgrade.

BupycHuk · 2024-10-24T13:19:48Z

docs/reference/why_pmm.md


-There is no direct software upgrade path.
+There is no direct software upgrade path. For infomation, see [Upgrade from PMM2](../pmm-upgrade/upgrade_from_pmm_2.md).


the same here

catalinaadam added 2 commits October 4, 2024 16:03

rel Notes entry draft

6937dcc

rel notes draft

ae71bc9

catalinaadam requested a review from a team as a code owner October 4, 2024 13:05

catalinaadam added 8 commits October 7, 2024 16:05

Updated relnotes

d2b2ae0

corrected install v3 command

6ae1b0d

Revert "corrected install v3 command"

2200f16

This reverts commit 6ae1b0d.

typo

535e998

draft

1a50c28

draft

a339810

typo

a6f0310

updated troubleshooting and remaining topics

070d440

catalinaadam requested a review from matejkubinec October 11, 2024 08:58

catalinaadam added 2 commits October 11, 2024 13:58

updated api

203e517

Update upgrade_issues.md

35e7c0c

matejkubinec reviewed Oct 21, 2024

View reviewed changes

catalinaadam and others added 6 commits October 21, 2024 14:13

Update docs/how-to/upgrade.md

73758bd

Co-authored-by: Matej Kubinec <[email protected]>

Update docs/pmm-upgrade/upgrade_docker.md

acd3b78

Co-authored-by: Matej Kubinec <[email protected]>

Update docs/pmm-upgrade/upgrade_from_ppm_2.md

525e5b5

Co-authored-by: Matej Kubinec <[email protected]>

Update docs/pmm-upgrade/upgrade_from_ppm_2.md

2f969b9

Co-authored-by: Matej Kubinec <[email protected]>

Merge branch 'PMM3_Beta' into Upgrade_changes

417f6cf

feedback from Matej

c5dab98

catalinaadam requested review from BupycHuk and Nailya October 21, 2024 11:57

added screenshot

d873fea

BupycHuk reviewed Oct 21, 2024

View reviewed changes

catalinaadam and others added 2 commits October 22, 2024 09:20

Update docs/pmm-upgrade/upgrade_docker.md

7a222f1

Co-authored-by: Matej Kubinec <[email protected]>

feedback from Nurlan

ffab19a

ademidoff reviewed Oct 23, 2024

View reviewed changes

catalinaadam added 2 commits October 23, 2024 14:12

feedback from Alex

1166b7e

added separate section about env changed from v2

634b8f2

table formatting

9858df4

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 23, 2024 15:04 — with Render View deployment

table formatting test

600510f

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 23, 2024 15:10 — with Render View deployment

test

492950d

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 23, 2024 15:13 — with Render View deployment

test2

edec715

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 23, 2024 15:17 — with Render View deployment

Update env_var.md

c264596

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 23, 2024 16:00 — with Render View deployment

Update env_var.md

8f4fff3

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 23, 2024 16:15 — with Render View deployment

Update env_var.md

027e5ca

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 23, 2024 16:21 — with Render View deployment

table formatting

cd99f55

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 24, 2024 08:04 — with Render View deployment

formatting

83dd6bc

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 24, 2024 08:16 — with Render View deployment

restructured topic

6529079

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 24, 2024 08:37 — with Render View deployment

improved wording

cf498dc

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 24, 2024 08:46 — with Render View deployment

note about new environment variables for PMM3

53ad24f

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 24, 2024 09:41 — with Render View deployment

watchtower updates

66f85b6

alina-derkach-oaza deployed to Upgrade_changes - PMM3_Beta PR #1316 October 24, 2024 10:55 — with Render View deployment

catalinaadam requested review from BupycHuk, ademidoff and matejkubinec October 24, 2024 12:03

BupycHuk reviewed Oct 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PMM-13025 - Upgrade changes #1316

PMM-13025 - Upgrade changes #1316

catalinaadam commented Oct 4, 2024

BupycHuk left a comment

BupycHuk Oct 21, 2024

catalinaadam Oct 22, 2024

BupycHuk Oct 21, 2024

BupycHuk Oct 21, 2024

BupycHuk Oct 21, 2024

catalinaadam Oct 22, 2024

BupycHuk Oct 21, 2024

catalinaadam Oct 24, 2024

BupycHuk Oct 24, 2024

BupycHuk Oct 21, 2024

BupycHuk Oct 21, 2024

catalinaadam Oct 22, 2024

BupycHuk Oct 21, 2024

BupycHuk Oct 21, 2024

BupycHuk Oct 21, 2024

ademidoff Oct 23, 2024

ademidoff Oct 23, 2024

BupycHuk Oct 24, 2024

BupycHuk Oct 24, 2024

BupycHuk Oct 24, 2024

BupycHuk Oct 24, 2024

BupycHuk Oct 24, 2024


		- `main` is for PMM 2.x (latest)
		- `PMM3-branch` is for PMM 3.x (latest)

		@@ -20,7 +20,7 @@ For MySQL databases, you can create and restore on-demand and scheduled physical

		### Sharded MongoDB cluster configurations

		!!! caution alert alert-warning "Known issue for older versions"
		- PMM versions prior to 2.33.0 may not show the latest versions available with instances created from the AWS marketplace in specific environments, including AWS. For solution, see the [troubleshooting](../how-to/troubleshoot.md#pmm-server-not-showing-latest-versions-available-with-the-instances-created-from-aws) section.


		![!image](../_images/PMM_Home_Dashboard_Panels_Upgrade.jpg)

		The panel shows:


		There is no direct software upgrade path.
		There is no direct software upgrade path. For infomation, see [Upgrade from PMM2](../pmm-upgrade/upgrade_from_pmm_2.md).

PMM-13025 - Upgrade changes #1316

Are you sure you want to change the base?

PMM-13025 - Upgrade changes #1316

Conversation

catalinaadam commented Oct 4, 2024

BupycHuk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment