Doc changes for PMM 3 GA

.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

documentation/docs/alert/contact_points.md

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

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 ""

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.</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"
@@ -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"

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:
 

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

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

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

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'})
-    ```
+    docker rmi $(docker images | grep "percona/pmm-server" | awk '{print $3}')
+    ```

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
     ```
-
-