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

Doc changes for PMM 3 GA #3408

Draft
wants to merge 1 commit into
base: v3
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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 documentation/docs/alert/contact_points.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ To use SMTP with a PMM Docker installation:
*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
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
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 @@ -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 @@ -39,7 +39,7 @@ To restore the container:
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
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 rm -r /srv/victoriametrics/data
```

6. Copy the data.
Expand All @@ -51,15 +51,15 @@ To restore the container:
7. 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 --volumes-from pmm-data -it percona/pmm-server:3 chown -R root:root /srv && \
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/alertmanager && \
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R root:pmm /srv/clickhouse && \
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R grafana:grafana /srv/grafana && \
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/logs && \
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R postgres:postgres /srv/postgres14 && \
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/prometheus && \
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R pmm:pmm /srv/victoriametrics && \
docker run --rm --volumes-from pmm-data -it percona/pmm-server:3 chown -R postgres:postgres /srv/logs/postgresql14.log
```

8. Start the image.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To run Docker with data container:
```sh
docker create --volume /srv \
--name pmm-data \
perconalab/pmm-server:3.0.0-beta /bin/true
percona/pmm-server:3 /bin/true
```

!!! caution alert alert-warning "Important"
Expand Down Expand Up @@ -38,7 +38,7 @@ To run Docker with data container:
--volumes-from pmm-data \
--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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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:
Expand All @@ -20,7 +20,7 @@ To run Docker with the host directory:
--volumes-from pmm-data \
--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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -26,7 +26,7 @@ To run Docker with volume:
--volumes-from pmm-data \
--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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```


Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/pmm-admin/security/ssl_encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ""
Expand Down Expand Up @@ -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
```


8 changes: 4 additions & 4 deletions documentation/docs/pmm-upgrade/migrating_from_pmm_2.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,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 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"
Expand Down Expand Up @@ -96,13 +96,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:

```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
Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/pmm-upgrade/upgrade_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
2 changes: 1 addition & 1 deletion documentation/docs/pmm-upgrade/upgrade_helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Before starting the upgrade, complete these preparation steps to ensure you can

```sh
# Replace <version> with the latest PMM version
docker pull perconalab/pmm-server:3.0.0-beta
docker pull percona/pmm-server:3
```

## Upgrade steps
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/reference/third-party/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading