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/docs/api/release-notes/3.0.0.Beta.md b/docs/api/release-notes/3.0.0.md similarity index 99% rename from docs/api/release-notes/3.0.0.Beta.md rename to docs/api/release-notes/3.0.0.md index 458bc863ba..ddc5b1827a 100644 --- a/docs/api/release-notes/3.0.0.Beta.md +++ b/docs/api/release-notes/3.0.0.md @@ -1,6 +1,6 @@ --- title: PMM v3 API release notes -slug: release-notes-3-0-0-beta +slug: release-notes-3-0-0 categorySlug: release-notes hidden: 0 --- diff --git a/documentation/docs/alert/contact_points.md b/documentation/docs/alert/contact_points.md index 28b6e3e88e..d3e3233d8b 100644 --- a/documentation/docs/alert/contact_points.md +++ b/documentation/docs/alert/contact_points.md @@ -41,9 +41,10 @@ To use SMTP with a PMM Docker installation: - `GF_SMTP_FROM_NAME`: Name to be used when sending out emails. *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. @@ -122,7 +123,7 @@ A policy will match an alert if the alert’s labels match all the matching labe This can be useful, for example, when you want to send notifications to a catch-all contact point as well as to one of more specific contact points handled by subsequent policies. 6. Toggle **Override grouping** if you do not want to use root policy grouping. 7. Toggle **Override general timings** to specify how often you want to wait until the initial notification is sent for a new group. When this is disabled, PMM uses root policy group timings instead. -8. Add a mute timing if you want to mute notifications or this policy for a specific, regular interval. For example, you can create a mute to suppress trivial notifications during weekends. Mute timings are different from silences in the sense that they are recurring, while silences have a fixed start and end time. +8. Add a mute timing if you want to mute notifications or this policy for a specific, regular interval. For example, you can create a mute to suppress trivial notifications during weekends. Mute timings are different from silences in the sense that they are recurring, while silences have a fixed start and end time. !!! caution alert alert-warning "Important" - Time specified in mute timing must be in UTC and military format i.e. 14:00 not 2:00 PM. + Time specified in mute timing must be in UTC format, i.e. 14:00, not 2:00 PM. diff --git a/documentation/docs/alert/index.md b/documentation/docs/alert/index.md index f155b580dc..b5d91d12c2 100644 --- a/documentation/docs/alert/index.md +++ b/documentation/docs/alert/index.md @@ -13,5 +13,5 @@ Percona Alerting is powered by Grafana infrastructure. It leverages Grafana's ad Depending on the datasources that you want to query, and the complexity of your required evaluation criteria, Percona Alerting enables you to create the following types of alerts: - **Percona templated alerts**: alerts based on a set of Percona-supplied templates with common events and expressions for alerting. -If you need custom expressions on which to base your alert rules, you can also create your own templates. +If you want to use custom expressions in alert rules, you can create your own alert rule templates. - **Grafana managed alerts**: alerts that handle complex conditions and can span multiple different data sources like SQL, Prometheus, InfluxDB, etc. These alerts are stored and executed by Grafana. diff --git a/documentation/docs/configure-pmm/alertmanager.md b/documentation/docs/configure-pmm/alertmanager.md index 7c88ae7b3d..c03f7ebf9c 100644 --- a/documentation/docs/configure-pmm/alertmanager.md +++ b/documentation/docs/configure-pmm/alertmanager.md @@ -5,7 +5,7 @@ Alertmanager manages alerts, de-duplicating, grouping, and routing them to the a This section lets you configure how VictoriaMetrics integrates with an external Alertmanager. !!! hint alert alert-success "Tip" - If possible, use [Integrated Alerting](../alert/index.md) instead of Alertmanager. + If possible, use [Percona Alerting](../alert/index.md) instead of Alertmanager. - The **Alertmanager URL** field should contain the URL of the Alertmanager which would serve your PMM alerts. - The **Prometheus Alerting rules** field is used to specify alerting rules in the YAML configuration format. 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/images/MongoDB_Router_Summary.png b/documentation/docs/images/MongoDB_Router_Summary.png new file mode 100644 index 0000000000..4ff397679a Binary files /dev/null and b/documentation/docs/images/MongoDB_Router_Summary.png differ diff --git a/documentation/docs/images/OplogGBperHour.png b/documentation/docs/images/OplogGBperHour.png new file mode 100644 index 0000000000..99d8e31d97 Binary files /dev/null and b/documentation/docs/images/OplogGBperHour.png differ diff --git a/documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg b/documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg index ccc97f0cf2..2a986ac6a5 100644 Binary files a/documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg and b/documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg differ diff --git a/documentation/docs/index.md b/documentation/docs/index.md index 0d0efb0613..6067d6a436 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -1,8 +1,7 @@ # About PMM -!!! info "" - This is the documentation for the latest release, **PMM {{release}}** Beta. See the [Release Notes](release-notes/3.0.0_Beta.md) for details. +:material-information: Info: This is the documentation for the latest release, **PMM {{release}}**. See the [Release Notes](release-notes/3.0.0.md) for details. Percona Monitoring and Management (PMM) is an open source database observability, monitoring, and management tool for use with MySQL, PostgreSQL, MongoDB, and the servers on which they run. It enables you to view node- to single-query performance metrics for all of your databases in a single place. diff --git a/documentation/docs/install-pmm/HA.md b/documentation/docs/install-pmm/HA.md index 890d2a4ac8..eb6c9f28a4 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/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/easy-install.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/easy-install.md index 6162acb16c..3a067c2023 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/easy-install.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/easy-install.md @@ -10,14 +10,12 @@ Download and install PMM Server using `cURL` or `wget`: === "cURL" ```sh - export PMM_REPO=perconalab/pmm-server PMM_TAG=3.0.0-beta curl -fsSL https://raw.githubusercontent.com/percona/pmm/refs/heads/v3/get-pmm.sh | /bin/bash ``` === "wget" ```sh - export PMM_REPO=perconalab/pmm-server PMM_TAG=3.0.0-beta wget -O - https://raw.githubusercontent.com/percona/pmm/refs/heads/v3/get-pmm.sh | /bin/bash ``` 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/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 1ba2b6fdd8..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 perconalab/pmm-server:3.0.0-beta 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 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 -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 0d75300d01..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 \ - perconalab/pmm-server:3.0.0-beta /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 \ - perconalab/pmm-server:3.0.0-beta - ``` - -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 b27a4cfb24..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 @@ -7,40 +7,42 @@ 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: +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 \ - perconalab/pmm-server:3.0.0-beta + 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 90c1cdc6bf..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 @@ -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: @@ -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 \ - 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: +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/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/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 b0b5468ba4..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 @@ -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: @@ -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-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..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,10 @@ # 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 +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: @@ -47,16 +65,16 @@ 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: + 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 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" +=== "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 +91,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 +105,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 @@ -96,13 +114,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: + 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 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 @@ -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 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 +138,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. 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..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 @@ -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/release-notes/3.0.0_Beta.md b/documentation/docs/release-notes/3.0.0.md similarity index 74% rename from documentation/docs/release-notes/3.0.0_Beta.md rename to documentation/docs/release-notes/3.0.0.md index c8183f66ea..8c89062fe6 100644 --- a/documentation/docs/release-notes/3.0.0_Beta.md +++ b/documentation/docs/release-notes/3.0.0.md @@ -1,14 +1,27 @@ -# Percona Monitoring and Management 3.0.0 Beta +# Percona Monitoring and Management 3.0.0 -| **Release date** | November 22nd, 2024 | -| ----------------- | ----------------------------------------------------------------------------------------------- | +| **Release date** | January, 2025 | +| ----------------- | :---------------------------------------------------------------------------------------------- | | **Installation** | [Installing Percona Monitoring and Management](../quickstart/index.md) | +| **Upgrade**| [Migrate PMM 2 to PMM 3](../pmm-upgrade/migrating_from_pmm_2.md) + Percona Monitoring and Management (PMM) is an open source database monitoring, management, and observability solution for MySQL, PostgreSQL, and MongoDB. -It enables you to observe the health of your database systems, explore new patterns in their behavior, troubleshoot them and execute database management operations—regardless of whether your databases are located on-premises or in the cloud. +PMM empowers you to: + +- Monitor the health and performance of your database systems +- Identify patterns and trends in database behavior +- Troubleshoot issues effectively +- Execute database management tasks seamlessly, whether your databases are on-premises or in the cloud + + +## General availability of PMM 3.0.0 + +We’re excited to announce the General Availability of PMM 3.0.0, a new major version that introduces a complete architectural overhaul of PMM. + +This milestone delivers major security improvements with rootless deployments, encryption of sensitive data, enhanced stability through containerized architecture, and improved user experience with flexible monitoring configurations. Key changes include official ARM support, MongoDB 8.0 monitoring, and a streamlined upgrade process. -PMM 3.0.0 Beta introduces major security improvements with rootless deployments, encryption of sensitive data, enhanced stability through containerized architecture, and improved user experience with flexible monitoring configurations. Key changes include official ARM support, MongoDB 8.0 monitoring, and a streamlined upgrade process. ## Security enhancements @@ -46,12 +59,18 @@ For more information, see [PMM data encryption](../pmm-admin/security/data_encry We've made a significant enhancement to the way API authentication is handled. PMM no longer relies on API keys as the primary method for controlling access to the PMM Server components and resources. Instead, PMM now leverages Grafana service accounts, which provide a more secure and manageable authentication mechanism compared to API keys. -The transition to service accounts brings fine-grained access control and logging of all actions performed, providing more security, better visibility and auditing capabilities. +This transition to service accounts brings fine-grained access control and logging of all actions performed, providing more security, better visibility and auditing capabilities. -When you install PMM 3, any existing API keys will be seamlessly converted to service accounts with corresponding service tokens. For more information about using service accounts in PMM, see [Service account authentication](../api/authentication.md). +#### Migration from API keys +With this change, API keys are now deprecated. When upgrading from PMM 2 to PMM 3, your existing API keys will be automatically converted to service accounts when you first log in as an Admin user or via CLI. +For more information see [Migrate to PMM 2 to PMM 3](../pmm-upgrade/migrating_from_pmm_2.md#step-3-migrate-pmm-2-clients-to-pmm-3) and [Service account authentication](../api/authentication.md). ![Service Accounts page](../images/Service_Accounts.png) +#### CVEs eliminated through architectural changes + +The removal of legacy components like Integrated Alerting and DBaaS, combined with the security enhancements above, eliminates multiple potential vulnerabilities and CVEs. This makes PMM 3 our most secure release yet. + ## Enhanced stability ### Containerized PMM architecture for AMI and OVF deployments @@ -74,13 +93,17 @@ At the same time, we're maintaining the UI upgrade option by integrating [Watcht For easy adoption, Watchtower comes pre-configured in our [Easy-Install script](../quickstart.md), enabling one-step PMM setup. +### Reduced PMM container image size + +We've optimized the PMM 3 container image from 3.1GB to 2.6GB, reducing its size by 0.5GB. This reduction improves download speeds and enhances deployment reliability, particularly in environments with limited storage capacity. + ## Improved user experience ### New upgrade UI We’ve introduced a new **Updates** page under **PMM Configuration** to support the new container-based upgrade system. This centralized interface offers clear visibility into the versions and configurations of both your PMM Server and Clients, simplifying the update process. -With this update, you’ll receive proactive notifications whenever new versions are release to help you make informed decisions before proceeding with available upgrades. +With this update, you’ll receive proactive notifications whenever new versions are released to help you make informed decisions before proceeding with available upgrades. ![Update page](../images/Update_page.png) @@ -108,7 +131,7 @@ You can find your Instance ID in the AWS Console. For detailed instructions, see ### Official ARM support for PMM Client -PMM 3 Beta now officially supports ARM architecture, upgrading from its experimental status in PMM 2.43. This means you can reliably monitor databases on ARM platforms, taking advantage of their cost-effective infrastructure and energy efficiency in data centers and cloud environments. +PMM 3 now officially supports ARM architecture, upgrading from its experimental status in PMM 2.43. This means you can reliably monitor databases on ARM platforms, taking advantage of their cost-effective infrastructure and energy efficiency in data centers and cloud environments. Installation follows the standard PMM Client process, with no special requirements for ARM systems. @@ -116,7 +139,7 @@ Try out this feature and share your experience on the [PMM forum](https://forums ### Improved UX with Grafana's latest release -PMM now integrates Grafana 11.1.8, which delivers the following important enhancements alongside all the advancements introduced since the previous Grafana 9.2.20 integration in PMM2. +PMM now integrates Grafana 11.1.8, which delivers the following important enhancements alongside all the advancements introduced since the previous Grafana 9.2.20 integration in PMM 2. For the full list of Grafana changes included with this update, see [Grafana’s 11.1.8 changelog](https://community.grafana.com/t/changelog-updates-in-grafana-11-1-8/134843) and [Grafana release highlights](https://grafana.com/docs/grafana/latest/whatsnew/). @@ -150,7 +173,23 @@ PMM now provides full monitoring support for the default `postgres` database on This enhancement resolves a previous visibility gap where database activity was hidden when applications used the default database. -While using the default database for applications is not recommended, PMM v3 ensures comprehensive visibility, empowering teams to identify and address this practice proactively and maintain better database management. +While using the default database for applications is not recommended, PMM 3 ensures comprehensive visibility, empowering teams to identify and address this practice proactively and maintain better database management. + +### Added Oplog generation rate panel to MongoDB dashboards + +The **MongoDB Sharded Cluster Summary** and **MongoDB ReplSet Summary** dashboards now include an **Oplog GB/Hour** panel showing the oplog generation rate per hour in a column format. + +The panel is located in the **Replication** section, helping you monitor oplog generation alongside other replication metrics for better visibility into your database replication patterns: + +![New Oplog panel](../images/OplogGBperHour.png) + +### General availability of MongoDB Router Summary dashboard + +The [MongoDB Router Summary](../reference/dashboards/dashboard-mongodb-router-summary.md), initially introduced as an experimental dashboard in PMM 2, is now generally available in PMM 3. This dashboard provides comprehensive monitoring for MongoS routers in sharded MongoDB clusters, offering insights into MongoS availability, version details and resource utilization. + +You can access this dashboard at **MongoDB > High availability > Router summary**. + +![MongoDB_Router_Summary dashboard GAed](../images/MongoDB_Router_Summary.png) ### [Tech Preview] Support for PSMDB and Community MongoDB 8.0 @@ -198,6 +237,15 @@ If you are an existing PMM user who relies on DBaaS functionality, we encourage To learn more about integrating Percona Everest with PMM and adding monitoring endpoints, see [Add monitoring endpoints in the Everest documentation](https://docs.percona.com/everest/use/monitor_endpoints.html). +### Finalized Integrated Alerting deprecation and API removal + +This release completes the deprecation of Integrated Alerting started in PMM 2.31.0 by removing its remaining components and APIs: + +- Removed all Integrated Alerting API endpoints, including `/v1/Settings/TestEmailAlertingSettings` +- Removed Integrated Alerting-related fields from the PMM Settings API (`email_alerting_settings` and `slack_alerting_settings`) + +If you still have alert rules that haven't been migrated to Percona Alerting, use the [Integrated Alerting Migration Script](https://github.com/percona/pmm/blob/main/ia_migration.py) to migrate them. [Percona Alerting](../alert/index.md) provides enhanced capabilities through Grafana's alerting infrastructure and pre-configured Alert Rule Templates. + ### Breaking API changes This release introduces major breaking API changes: @@ -208,11 +256,11 @@ This release introduces major breaking API changes: - Service, node, and agent management has been streamlined through consolidated endpoints where the resource type is specified as a top-level property in the request payload. - Low-level Inventory API sections have been removed from documentation in favor of the Management API for inventory-related tasks. -For detailed information about all these API changes and new endpoints, see the [PMM API documentation](https://percona-pmm.readme.io/v3/reference/release-notes-3-0-0-beta). +For detailed information about all these API changes and new endpoints, see the [PMM API documentation](https://percona-pmm.readme.io/v3/reference/release-notes-3-0-0). ### New upgrade environment variables -When migrating from PMM v2 to PMM v3, you’ll need to update your environment variables to match the new naming convention. This is because PMM v3 introduces several important changes to improve consistency and clarity: +When migrating from PMM 2 to PMM 3, you’ll need to update your environment variables to match the new naming convention. This is because PMM 3 introduces several important changes to improve consistency and clarity: - environment variables now use PMM_ prefix - some boolean flags reversed (e.g., `DISABLE_` > `ENABLE_`) @@ -230,11 +278,11 @@ For the full list of affected plugins and guidance on migration, see [Grafana's We will provide regular updates on our migration progress in future releases to help you prepare for this change and modernize your dashboards. -## Components upgrade +## Component upgrades We've upgraded following PMM components to their latest stable versions to enhance functionality, security, and performance: -- **Grafana 11.1.8**: Includes significant improvements over the previous version 9.2.20 integration in PMM2. +- **Grafana 11.1.8**: Includes significant improvements over the previous version 9.2.20 integration in PMM 2. - **Node Exporter 1.8.2**: The latest stable release enhances system metrics collection with improved security, additional metrics for custom dashboards, and critical bug fixes. This version strengthens our ability to monitor crucial system-level metrics through upstream improvements. - **ClickHouse Datasource plugin**: Updated to address security vulnerabilities and maintain system integrity. This update ensures continued reliable operation of ClickHouse-related dashboards. - **ClickHouse-go driver**: Upgraded QAN to use version 2 of the driver, improving database connectivity and performance. @@ -261,8 +309,19 @@ While the Nomad binary is now included and properly configured within the PMM Cl - [PMM-11216](https://perconadev.atlassian.net/browse/PMM-11216) - Added ability to upgrade PMM Server between different version tags, enabling more flexible version management for Docker-based deployments. +- [PMM-xxxx](https://perconadev.atlassian.net/browse/PMM-xxxx) - Building on the OpenShift compatibility introduced for PMM Client in PMM 2.44, PMM 3.0 extends this support to include PMM Server as well. All PMM Docker images now comply with Red Hat certification requirements, ensuring seamless deployment of both PMM Client and PMM Server in OpenShift environments. + ## Fixed issues - [PMM-13122](https://perconadev.atlassian.net/browse/PMM-13122) - Fixed navigation between pages to properly maintain selected service names and timeframes when switching between different dashboards and metrics views. -- [PMM-12013](https://perconadev.atlassian.net/browse/PMM-12013) - Fixed reliability and memory usage issues with RDS monitoring in large deployments by running separate RDS exporters per AWS access key. This improves metric collection stability and reduces memory consumption when monitoring multiple RDS instances. \ No newline at end of file +- [PMM-12013](https://perconadev.atlassian.net/browse/PMM-12013) - Fixed reliability and memory usage issues with RDS monitoring in large deployments by running separate RDS exporters per AWS access key. This improves metric collection stability and reduces memory consumption when monitoring multiple RDS instances. + +- [PMM-13360](https://perconadev.atlassian.net/browse/PMM-13360) - Fixed an issue in the MongoDB ReplSet Summary dashboard where nodes in `down` state would sometimes disappear from the **States** panel and their version information would be removed from the MongoDB Versions panel. Nodes in `down` state now remain visible with their last known version information preserved. + +!!! seealso alert alert-info "Ready to install or migrate to PMM 3?" + + We provide two installation scripts to help you get started with this new version: + + - For new installations, the [Easy-Install script](../quickstart/index.md) comes with Watchtower pre-configured, enabling one-step PMM setup with automatic updates. + - For existing PMM 2 users, we provide a dedicated [Upgrade script]((../pmm-upgrade/migrating_from_pmm_2.md)) that safely migrates your installation to PMM 3 and ensures data is backed up before the upgrade. diff --git a/documentation/docs/release-notes/index.md b/documentation/docs/release-notes/index.md index 7b0478b76d..b10f38b440 100644 --- a/documentation/docs/release-notes/index.md +++ b/documentation/docs/release-notes/index.md @@ -1,2 +1,2 @@ # Release Notes -- [Percona Monitoring and Management 3.0.0 Beta](3.0.0_Beta.md) \ No newline at end of file +- [Percona Monitoring and Management 3.0.0](3.0.0.md) \ No newline at end of file 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 diff --git a/documentation/mkdocs-base.yml b/documentation/mkdocs-base.yml index 4e6275a191..9c95dbe2ce 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 @@ -269,9 +268,10 @@ nav: - Percona Alerting: - alert/index.md - alert/alert_rules.md - - alert/alert_notifications.md + - alert/contact_points.md - alert/templates_list.md - alert/silence_alerts.md + - alert/disable_alerts.md - Backup and restore: - backup/index.md - backup/prepare_storage_location.md @@ -337,7 +337,7 @@ nav: - Release notes: - Release notes index: release-notes/index.md - - "PMM 3.0.0-BETA (2024-11-22)": release-notes/3.0.0_Beta.md + - "PMM 3.0.0 (2025-01-xx)": release-notes/3.0.0.md - Reference: - Architecture: diff --git a/documentation/mkdocs-pdf.yml b/documentation/mkdocs-pdf.yml index 0ae7e55926..a4d285e13d 100644 --- a/documentation/mkdocs-pdf.yml +++ b/documentation/mkdocs-pdf.yml @@ -7,9 +7,9 @@ plugins: version_selector: false # https://github.com/orzih/mkdocs-with-pdf with-pdf: - output_path: "pdf/PerconaMonitoringAndManagement-3.0.0-beta.pdf" + output_path: "pdf/PerconaMonitoringAndManagement-3.0.0.pdf" cover_title: "Percona Monitoring and Management Documentation" - cover_subtitle: 3.0.0 (December 13, 2024) + cover_subtitle: 3.0.0 (January 13, 2025) author: "Percona Technical Documentation Team" cover_logo: docs/images/Percona_Logo_Color.png custom_template_path: resources/templates diff --git a/documentation/variables.yml b/documentation/variables.yml index 5cf63923e7..e2a5dd0cc1 100644 --- a/documentation/variables.yml +++ b/documentation/variables.yml @@ -2,8 +2,8 @@ # See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path release: '3.0.0' -version: 'Beta' -release_date: 2024-11-22 +version: '3.0.0' +release_date: 2025-01-30 # SVG icons. Use in markdown as {{icon.}} # For the Percona image icon (encoded inline SVG), see https://css-tricks.com/using-svg/ icon: