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-11246 RelNotes entry about Full OpenShift support #3488

Open
wants to merge 33 commits into
base: v3
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
d829cc4
updated docker image values
catalinaadam Dec 20, 2024
955c373
PMM-13360
catalinaadam Jan 7, 2025
5776a2f
Update documentation/docs/release-notes/3.0.0_GA.md
catalinaadam Jan 7, 2025
3b18dad
Update documentation/docs/release-notes/3.0.0_GA.md
catalinaadam Jan 7, 2025
9ccfb34
PMM-13360
catalinaadam Jan 7, 2025
01bd769
Update dashboard-mongodb-replset-summary.md
catalinaadam Jan 7, 2025
b4c575f
Update documentation/docs/release-notes/3.0.0_GA.md
catalinaadam Jan 8, 2025
c528f84
transferred content from beta and restructured intro for GA info
catalinaadam Jan 8, 2025
04de157
formatting
catalinaadam Jan 8, 2025
be419d1
Merge branch 'v3' into Release-3-0-0-GA
ademidoff Jan 9, 2025
8bb3568
added script option (#3438)
catalinaadam Jan 10, 2025
0ce841b
mentioned upgrade option in rel notes (#3440)
catalinaadam Jan 10, 2025
1a3170f
PMM-12644 Remove the use of data container (#3414)
ademidoff Jan 10, 2025
881881a
PMM-12287 Document removal of Integrated Alerting (#3435)
ademidoff Jan 10, 2025
7d0314c
RelNotes for PMM-13633 (#3454)
catalinaadam Jan 14, 2025
d6533e2
ReLNotes entry for new container size image (#3449)
catalinaadam Jan 15, 2025
1c1db77
Rel notes for oplog Per Hour panel (#3443)
catalinaadam Jan 15, 2025
358b0f7
Rel notes - PMM12644-Remove data container (#3437)
catalinaadam Jan 15, 2025
e954c25
Merge branch 'Release-3-0-0-GA' into RelNotes-3-0-0-GA
catalinaadam Jan 15, 2025
fc925f5
removed "beta"references
catalinaadam Jan 17, 2025
1c5b598
RelNotes entry about Docker Image label changes (#3471)
catalinaadam Jan 20, 2025
70904e3
entry for MongoDB_Router_Summary GAed
catalinaadam Jan 21, 2025
7c60b3c
added SS
catalinaadam Jan 21, 2025
3264ef6
added link to Router Summary dashboard
catalinaadam Jan 21, 2025
9c61ebc
rel highlight about CVEs (#3480)
catalinaadam Jan 21, 2025
859d1d5
formatting
catalinaadam Jan 21, 2025
f0ca458
Merge branch 'RelNotes-3-0-0-GA' of https://github.com/percona/pmm in…
catalinaadam Jan 21, 2025
df9bcf2
updated API RelNotes file name
catalinaadam Jan 21, 2025
989fccf
updated version names
catalinaadam Jan 21, 2025
3757a4c
removed note about Redhat labels as this was mentioned in 2.44
catalinaadam Jan 22, 2025
3cd1744
formatting
catalinaadam Jan 22, 2025
725f6c0
entry about Full OpenShift support
catalinaadam Jan 22, 2025
d2a95f7
rewording
catalinaadam Jan 22, 2025
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
8 changes: 4 additions & 4 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
7 changes: 4 additions & 3 deletions documentation/docs/alert/contact_points.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion documentation/docs/alert/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion documentation/docs/configure-pmm/alertmanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/how-to/secure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ""
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/docs/images/OplogGBperHour.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 documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions documentation/docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
<i info>:material-information: Info:</i> 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.

Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/install-pmm/HA.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.</br></br>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.</br></br>Example: `17.10.1.7`
| `PMM_PASSIVE2_NODE_ID` | The unique ID for your second passive PMM Server node.</br></br>Example: `pmm-server-passive2`
| `PMM_DOCKER_IMAGE` &nbsp; &nbsp; &nbsp; &nbsp; | The specific PMM Server Docker image for this guide.</br></br>Example: `perconalab/pmm-server:3.0.0-beta`
| `PMM_DOCKER_IMAGE` &nbsp; &nbsp; &nbsp; &nbsp; | The specific PMM Server Docker image for this guide.</br></br>Example: `percona/pmm-server:3`


??? example "Expected output"
Expand All @@ -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"
Expand Down
8 changes: 4 additions & 4 deletions documentation/docs/install-pmm/install-pmm-client/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.)
Expand All @@ -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).
Expand All @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -41,5 +42,5 @@ To backup container:
4. Back up the data:

```sh
docker cp pmm-data:/srv .
docker cp pmm-server-backup:/srv .
```
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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).

Expand Down
Original file line number Diff line number Diff line change
@@ -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'})
```
docker rmi $(docker images | grep "percona/pmm-server" | awk '{print $3}')
```
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -22,7 +12,7 @@ To restore the container:
docker stop pmm-server
```

2. Remove it.
2. Remove the container.

```sh
docker rm pmm-server
Expand All @@ -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
```


Loading
Loading