PMM-12189 automate updates of docker readme (#2226)

* PMM-12189 add a readme and an action * PMM-12189 align GO version between el7 and el9 * PMM-12189 restrict the action to prod
percona · Jun 5, 2023 · 7937909 · 7937909
1 parent fa91137
commit 7937909
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 2 deletions.
diff --git a/.github/workflows/dockerhub-readme.yml b/.github/workflows/dockerhub-readme.yml
@@ -0,0 +1,31 @@
+name: Update Docker Hub Readme
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - build/docker/server/README.md
+  workflow_dispatch:
+
+jobs:
+  updateReadme:
+    runs-on: ubuntu-latest
+    environment: Production
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Update Docker Hub Readme for perconalab/pmm-server
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: perconalab/pmm-server
+          readme-filepath: ./build/docker/server/README.md
+
+      - name: Update Docker Hub Readme for percona/pmm-server
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: percona/pmm-server
+          readme-filepath: ./build/docker/server/README.md
diff --git a/build/docker/rpmbuild/Dockerfile.el9 b/build/docker/rpmbuild/Dockerfile.el9
@@ -24,8 +24,8 @@ RUN yum update -y && \
     yum clean all && rm -rf /var/cache/yum
 
 # keep that format for easier search
-ENV GO_VERSION 1.19.1
-ENV GO_RELEASER_VERSION 1.9.2
+ENV GO_VERSION 1.20.1
+ENV GO_RELEASER_VERSION 1.15.2
 
 RUN if [ `uname -i` == "x86_64" ]; then ARCH=amd64; else ARCH=arm64; fi && \
     wget --progress=dot:giga https://dl.google.com/go/go${GO_VERSION}.linux-${ARCH}.tar.gz -O /tmp/golang.tar.gz && \

diff --git a/build/docker/server/README.md b/build/docker/server/README.md
@@ -0,0 +1,48 @@
+# PMM Server
+
+Percona Monitoring and Management (PMM) is an open source database observability, monitoring, and management tool for MySQL, PostgreSQL, MongoDB and ProxySQL, and their servers. With PMM, you can identify critical performance issues faster, understand the root cause of incidents better, and troubleshoot them more efficiently.
+
+- The tool allows you to view node to single query performance metrics and explain plans for all of your databases in a single place.
+- With Query Analytics, you can quickly locate costly and slow running queries and drill into precise execution details to address bottlenecks.
+- Percona Advisors equip you with performance, security and configuration recommendations that help you keep your databases performing at their best.
+- Alerting and management features like backup, restore and built-in open source Private DBaaS are designed to increase the velocity of your IT team.
+
+## Starting PMM Server
+
+```
+docker pull percona/pmm-server:2
+docker volume create pmm-data
+docker run --detach --restart always --publish 443:443 -v pmm-data:/srv --name pmm-server percona/pmm-server:2
+```
+
+Point your browser to https://hostname:443
+
+This example uses the tag `:2` to pull the latest PMM 2.x version, but other, [more specific tags](https://hub.docker.com/r/percona/pmm-server/tags), are also available.
+
+## Environment variables
+
+You can use these environment variables (-e VAR) when running the Docker image.
+
+| Variable                 | Description                                                                                                                 |
+| ------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
+| DISABLE_UPDATES          | Disable automatic updates                                                                                                   |
+| DISABLE_TELEMETRY        | Disable built-in telemetry and disable STT if telemetry is disabled                                                         |
+| METRICS_RESOLUTION       | High metrics resolution in seconds                                                                                          |
+| METRICS_RESOLUTION_HR    | High metrics resolution (same as above)                                                                                     |
+| METRICS_RESOLUTION_MR    | Medium metrics resolution in seconds                                                                                        |
+| METRICS_RESOLUTION_LR    | Low metrics resolution in seconds                                                                                           |
+| DATA_RETENTION           | How long to keep time-series data in ClickHouse. This variable accepts golang style duration format, example: 24h, 30m, 10s |
+| ENABLE_VM_CACHE          | Enable cache in VM                                                                                                          |
+| ENABLE_ALERTING          | Enable integrated alerting                                                                                                  |
+| ENABLE_AZUREDISCOVER     | Enable support for discovery of Azure databases                                                                             |
+| ENABLE_BACKUP_MANAGEMENT | Enable integrated backup tools                                                                                              |
+| ENABLE_DBAAS             | Enable DBaaS features                                                                                                       |
+| PMM_PUBLIC_ADDRESS       | External IP address or the DNS name on which PMM server is running.                                                         |
+| PMM_DEBUG                | Enables a more verbose log level                                                                                            |
+| PMM_TRACE                | Enables a more verbose log level including traceback information                                                            |
+
+## For more information please visit:
+
+[Percona Monitoring and Management](https://docs.percona.com/percona-monitoring-and-management)
+
+[Setting up PMM Server with Docker](https://docs.percona.com/percona-monitoring-and-management/setting-up/server/docker.html)