Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PMM-13025 - Upgrade changes #1316

Open
wants to merge 41 commits into
base: PMM3_Beta
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
6937dcc
rel Notes entry draft
catalinaadam Oct 4, 2024
ae71bc9
rel notes draft
catalinaadam Oct 4, 2024
d2b2ae0
Updated relnotes
catalinaadam Oct 7, 2024
6ae1b0d
corrected install v3 command
catalinaadam Oct 8, 2024
2200f16
Revert "corrected install v3 command"
catalinaadam Oct 8, 2024
535e998
typo
catalinaadam Oct 8, 2024
1a50c28
draft
catalinaadam Oct 9, 2024
a339810
draft
catalinaadam Oct 9, 2024
a6f0310
typo
catalinaadam Oct 10, 2024
070d440
updated troubleshooting and remaining topics
catalinaadam Oct 11, 2024
203e517
updated api
catalinaadam Oct 11, 2024
35e7c0c
Update upgrade_issues.md
catalinaadam Oct 16, 2024
73758bd
Update docs/how-to/upgrade.md
catalinaadam Oct 21, 2024
acd3b78
Update docs/pmm-upgrade/upgrade_docker.md
catalinaadam Oct 21, 2024
525e5b5
Update docs/pmm-upgrade/upgrade_from_ppm_2.md
catalinaadam Oct 21, 2024
2f969b9
Update docs/pmm-upgrade/upgrade_from_ppm_2.md
catalinaadam Oct 21, 2024
417f6cf
Merge branch 'PMM3_Beta' into Upgrade_changes
catalinaadam Oct 21, 2024
c5dab98
feedback from Matej
catalinaadam Oct 21, 2024
d873fea
added screenshot
catalinaadam Oct 21, 2024
7a222f1
Update docs/pmm-upgrade/upgrade_docker.md
catalinaadam Oct 22, 2024
ffab19a
feedback from Nurlan
catalinaadam Oct 23, 2024
1166b7e
feedback from Alex
catalinaadam Oct 23, 2024
634b8f2
added separate section about env changed from v2
catalinaadam Oct 23, 2024
afaab30
table formatting
catalinaadam Oct 23, 2024
37556c0
removed info abour force update via UI
catalinaadam Oct 23, 2024
6ac3352
table formatting
catalinaadam Oct 23, 2024
876052b
table formatting
catalinaadam Oct 23, 2024
7b1d084
table formatting
catalinaadam Oct 23, 2024
9858df4
table formatting
catalinaadam Oct 23, 2024
600510f
table formatting test
catalinaadam Oct 23, 2024
492950d
test
catalinaadam Oct 23, 2024
edec715
test2
catalinaadam Oct 23, 2024
c264596
Update env_var.md
alina-derkach-oaza Oct 23, 2024
8f4fff3
Update env_var.md
alina-derkach-oaza Oct 23, 2024
027e5ca
Update env_var.md
alina-derkach-oaza Oct 23, 2024
cd99f55
table formatting
catalinaadam Oct 24, 2024
83dd6bc
formatting
catalinaadam Oct 24, 2024
6529079
restructured topic
catalinaadam Oct 24, 2024
cf498dc
improved wording
catalinaadam Oct 24, 2024
53ad24f
note about new environment variables for PMM3
catalinaadam Oct 24, 2024
66f85b6
watchtower updates
catalinaadam Oct 24, 2024
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 .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build PMM Docs 2.x
name: Build PMM Docs 3.x

on:
push:
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ We use [MkDocs] to convert [Markdown] files into a static HTML website (or [PDF]

The documentation source files are in the `docs` directory. (Other files in this repo are explained in [Directories and files](#directories-and-files).)

The two major PMM versions are kept in separate branches:
The three major PMM versions are kept in separate branches:

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make it v3 like in other repos.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?


- `main` is for PMM 2.x

- `1.x` is for PMM 1.x

Expand Down Expand Up @@ -159,7 +161,7 @@ View the site at <http://0.0.0.0:8000>

## Version switching

We use [mike] to build different versions of the documentation. Currently, only two are built, the latest PMM 1 and PMM 2 versions.
We use [mike] to build different versions of the documentation. Currently, only two are built, the latest PMM 2 and PMM 3 versions.

A [GitHub actions] workflow runs `mike` which in turn runs `mkdocs`. The HTML is committed and pushed to the `publish` branch. The whole branch is then copied (by an internal Percona Jenkins job) to our web server.

Expand Down
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 0 additions & 6 deletions docs/alert/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
# About Percona Alerting

!!! alert alert-info "Important"
Percona Alerting is the new Alerting feature introduced in PMM 2.31. This replaces the Integrated Alerting feature available in previous versions.

Alerting notifies of important or unusual activity in your database environments so that you can identify and resolve problems quickly. When something needs your attention, Percona Alerting can be configured to automatically send you a notification through your specified contact points.


PMM 2.31 introduced Percona Alerting which replaces Integrated Alerting in previous PMM versions. In addition to full feature parity, Percona Alerting includes additional benefits like Grafana-based alert rules and a unified, easy-to-use alerting command center on the **Alerting** page.

Percona Alerting is enabled by default in the PMM Settings. This feature adds the **Alert rule templates** option on the main menu and alert template options on the **Alerting** page.

These options enable you to create alerts based on a set of Percona-supplied templates with common events and expressions for alerting.
8 changes: 5 additions & 3 deletions docs/alert/silence_alerts.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Silence alerts

Create a silence when you want to suppress/stop alerts and their associated notifications for a very specific amount of time.
Silences default to today’s current date and have a default duration of two hours.
Silences default to today’s current date and have a default duration of two hours.

You can also schedule a silence for a future date and time. This is referred to as a `Pending` silence, which can be observed on the Silences page.

Expand All @@ -14,6 +14,7 @@ Silenced alerts are still recorded under **Alerting > Fired Alerts** so that you
You can silence an alert by creating a silence from the **Silences** page. Here you define labels that match the alert that you want to silence.

To create a new silence:
{.power-number}

1. Click the **Create silence** button.
2. Select the start and end date to indicate when the silence should go into effect and expire.
Expand All @@ -29,13 +30,14 @@ 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**.
After upgrading from the latest PMM 2 version to PMM 3, you will find all your alert templates under **Alerting > Alert rule templates**.

If you have any templates available in the ``/srv/ia/templates`` folder, make sure to transfer them to ``/srv/alerting/templates`` as PMM 2.31 and later will look for custom templates in this location.
If you have any templates available in the `/srv/ia/templates` folder, make sure to transfer them to `/srv/alerting/templates` as PMM 3 will look for custom templates in this location.

### Template compatibility with other alerting tools

If you have existing YAML alert templates that you want to leverage in Percona Alerting:
{.power-number}

1. Go to **Alerting > Alert rule templates** tab and click **Add template** at the top right-hand side of the table.
2. Upload a local .yaml file that contains the definition of one or more alert templates then click **Add**. Alert templates added in bulk will be displayed individually on **Alert rule templates** page.
Expand Down
2 changes: 1 addition & 1 deletion docs/backup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For MySQL databases, you can create and restore on-demand and scheduled physical

### Sharded MongoDB cluster configurations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


PMM 2.38 added support for creating backups of sharded MongoDB clusters. However, the restoring process is not handled end-to-end, and requires you to manually restore the artifacts using the CLI in Percona Backup for MongoDB.
PMM 3 supports creating backups of sharded MongoDB clusters. However, the restoring process is not handled end-to-end, and requires you to manually restore the artifacts using the CLI in Percona Backup for MongoDB.


## Start here
Expand Down
2 changes: 1 addition & 1 deletion docs/backup/mongodb-backup/backup_mongo.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ PMM supports the following actions for MongoDB backups:

## Sharded clusters

Backups of sharded clusters is supported starting with PMM 2.38. However, restoring for sharded cluster configurations is only supported from the CLI, and is handled via [Percona Backup for MongoDB](https://docs.percona.com/percona-backup-mongodb/usage/restore.html).
PMM 3 supports backing up sharded clusters. However, restoring for sharded cluster configurations is only supported from the CLI, and is handled via [Percona Backup for MongoDB](https://docs.percona.com/percona-backup-mongodb/usage/restore.html).

- Storing backups on Amazon S3-compatible object storage, and on mounted filesystem
- Creating Logical snapshot backups
Expand Down
2 changes: 1 addition & 1 deletion docs/backup/mongodb-backup/mongo_prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Services that do not specify a cluster name should be removed and re-added using

Use `pbm` in manual mode only for restoring sharded cluster backups or other operations that can only be completed via the PBM CLI! Since PMM takes care of the PBM configuration, any unnecessary manual intervention can break the state.

PMM 2.32 and later require PBM 2.0.1 or newer.
PMM 3 and later require PBM 2.0.1 or newer.
2 changes: 1 addition & 1 deletion docs/backup/mongodb-backup/restore_MongoDB_backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,6 @@ To restore to a new cluster manually:

### Restoring from a sharded cluster

Sharded cluster backups are supported starting with PMM 2.38 and PMM handles the backup process end-to-end. However, restoring such artifacts is currently possible only via the CLI, using Percona Backup for MongoDB.
Sharded cluster backups are supported and PMM handles the backup process end-to-end. However, restoring such artifacts is currently possible only via the CLI, using Percona Backup for MongoDB.

For information on restoring sharded backups, check the [PBM documentation](https://docs.percona.com/percona-backup-mongodb/usage/restore.html)
10 changes: 1 addition & 9 deletions docs/how-to/integrate-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,8 @@ We recommend that you connect with a Percona Account, as this gives you access t
#### Prerequisites
To ensure that PMM can establish a connection to Percona Platform:

### Upgrade to PMM 2.27.0 or later
Before connecting your PMM Server to Percona Platform, make sure you are using PMM version 2.27 or newer. Otherwise, upgrade your PMM installation beforehand.

This is required because, starting with PMM 2.27, Percona Platform has replaced username/password authentication with access token authentication. Access-token authentication increases security and enables federated identity.

This change did not affect existing connections to PMM Platform, which were not automatically terminated.

For more information, see [Install and set up PMM](../setting-up/index.md).

### Check that you are a member of an existing Platform organization

1. Log in to [Percona Platform](https://portal.percona.com) using your Percona Account. If you are connecting via GitHub, make sure you set your email address as **public** in your GitHub account. If your email address is private instead, Percona Platform cannot access it to authenticate you.

2. On the **Getting Started** page, check that the **Create organization** step shows an option to view your organization.
Expand Down
64 changes: 0 additions & 64 deletions docs/how-to/upgrade.md

This file was deleted.

Loading
Loading