Skip to content

Commit

Permalink
Updated relnotes
Browse files Browse the repository at this point in the history
  • Loading branch information
catalinaadam committed Oct 7, 2024
1 parent ae71bc9 commit d2b2ae0
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 16 deletions.
Binary file added docs/Update_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Home_Dashboard_Panels_Upgrade.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 28 additions & 13 deletions docs/how-to/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,51 @@
# Upgrade

To upgrade your PMM instance, go to **PMM Configuration > Updates**. Here, you can view the current PMM Server version, check if your instance is up-to-date, and see the timestamp of the last update check.

If an update is available, simply click the **Update** button to install the latest version.

![Update page](../Update_page.png)

You can also check a summary of this information on the **Upgrade** panel on the Home page.

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

Client and Server components are installed and updated separately.


## Plan the upgrade order

### Upgrade PMM Server first

Make sure to upgrade the PMM Server before you upgrade the PMM Client.

Ensure that the PMM Server version is higher than or equal to the PMM Client version. Otherwise, there might be configuration issues, thus leading to failure in the client-server communication as PMM Server might not be able to identify all the parameters in the configuration.
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

When upgrading PMM from PMM v2, follow the following staged approach:
1. upgrade to the latest PMM v2 version
2. Proceed to upgrading to PMM 3.

For example, for a PMM Server version 2.25.0, the PMM Client version should be 2.25.0 or 2.24.0. If the PMM Client version is 2.26.0, PMM might not work as expected.
Make sure you have access to the machine where PMM Server:
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 )
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 )

### Staged upgrade approach

When upgrading PMM from older versions (2.30.0 and below), we recommend following a staged approach: first, upgrade to version 2.33.0, and then proceed to the latest version.

This sequential upgrading process ensures that PMM's internal components are migrated and updated correctly.

## Update the Server

!!! caution alert alert-warning "Known issues for older versions"
- Upgrading to PMM 2.32.0 from older versions fails. We recommend upgrading directly to2.33 or latest version. For more information, see the [troubleshooting topic](../how-to/troubleshoot.md#pmm-server-fails-while-upgrading).

!!! 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.


Client and server components are installed and updated separately.

PMM Server can run natively, as a Docker image, a virtual appliance, or an AWS cloud instance. Each has its own installation and update steps.

The preferred and simplest way to update PMM Server is with the *PMM Upgrade* panel on the Home page.

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

The panel shows:

Expand Down
6 changes: 3 additions & 3 deletions docs/release-notes/3.0.0_Beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ It enables you to observe the health of your database systems, explore new patte

### Streamlined update process

Weve introduced a new **Update** page in PMM which simplifies the way you manage your PMM Server and Client versions.
We've enhanced PMM's update system with a new **Update** page, accessible via **PMM Configuration > Updates**. This new intuitive interface replaces the previous RPM-based update method, allowing you to easily track versions, configurations, and the health status of your PMM Server and Clients.

This interface replaces the previous RPM-based update method with a more intuitive solution for easily tracking versions, configurations, and the health of your PMM Server and Clients.
This change comes with proactive notifications, alerting you immediately when new versions are released, and providing detailed change summaries so you can make informed decisions before upgrading.

With this enhancement, PMM proactively notifies you as soon as a new version is available, allowing you to review changes before deciding to upgrade. You can also access this information at any time from **PMM Configuration > Update**s.
![Update page](../Update_page.png)

### Encryption of sensitive data

Expand Down

0 comments on commit d2b2ae0

Please sign in to comment.