PMM Release 2.37.0 docs (#1042)

* PMM Release 2.37.0 docs * PMM-11951 fix warn block (#1056) * Inventory view (#1062) * PMM-11438-stop-internal-postgresql-server (#1035) * PMM-11438 env var with disable build-in * PMM-11438 padding to env to fit the column * PMM-11438 docker setting-up with disable built-in * Update docs/details/postgresql.md Co-authored-by: Rasika Chivate <[email protected]> --------- Co-authored-by: Rasika Chivate <[email protected]> * PMM-11912 DBaaS templates (#1041) * PMM-11912 DBaaS templates * Update DBaaS_tepmplate.md * Update DBaaS_tepmplate.md * Customize PXC DB configuration * Update DBaaS_tepmplate.md * Update DBaaS_tepmplate.md * Update DBaaS_tepmplate.md * Update docs/dbaas/DBaaS_tepmplate.md Co-authored-by: Diogo Recharte <[email protected]> * Update DBaaS_tepmplate.md * Update DBaaS_tepmplate.md * Update DBaaS_tepmplate.md * Update docs/dbaas/DBaaS_tepmplate.md Co-authored-by: Diogo Recharte <[email protected]> * Update docs/dbaas/DBaaS_tepmplate.md Co-authored-by: Diogo Recharte <[email protected]> * Update DBaaS_tepmplate.md * Update DBaaS_tepmplate.md * Update DBaaS_tepmplate.md * fixed the typo in the md file * Update DBaaS_template.md * Update DBaaS_template.md * Update DBaaS_template.md * Update DBaaS_template.md * Update DBaaS_template.md --------- Co-authored-by: Diogo Recharte <[email protected]> * security info to reassure users (#1040) Co-authored-by: Rasika Chivate <[email protected]> * PMM-11488 PGSM 2.0 doc correction/changes. (#1032) * PMM rel 2.36.0 * PMM-11488 Info for PGSM 2.0. * PMM-11488 Fix. * PMM-11488 Add query. * Update docs/get-started/query-analytics.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/get-started/query-analytics.md Co-authored-by: Rasika Chivate <[email protected]> * Update query-analytics.md * PMM-11488 Correction. * Update docs/get-started/query-analytics.md Co-authored-by: Rasika Chivate <[email protected]> * PMM-11488 Small improvements. * PMM-11488 Small changes. * Update docs/get-started/query-analytics.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/release-notes/2.36.0.md Co-authored-by: Rasika Chivate <[email protected]> --------- Co-authored-by: rasika-chivate <[email protected]> * Clarify what ignored env variables mean. (#1046) * Clarify what ignored env variables mean. * Update docs/setting-up/server/docker.md Co-authored-by: Nurlan Moldomurov <[email protected]> * Update docker.md --------- Co-authored-by: Rasika Chivate <[email protected]> Co-authored-by: Nurlan Moldomurov <[email protected]> * Add meta tags and contact us section (#1045) new file: docs/_images/PMM.png modified: overrides/main.html Co-authored-by: Rasika Chivate <[email protected]> * Remove duplicated entry (#1044) `pmm-admin add external [FLAGS] [NAME] [ADDRESS]` (CAUTION: Technical preview feature)` seems to be useless Co-authored-by: Rasika Chivate <[email protected]> * PMM-7 clean up table markup and use default alignment (#1051) * PMM-7 clean up table markup and use default alignment * PMM-7 try using bold * PMM-7 no quotes doesnt break on underscores * PMM-7 remove the last bold * PMM-7 fix the typo - Percona server * reworked to start demystifying SSL (#1047) * reworked to start demystifying SSL I reworked this page to try and make it easier to understand the process of putting proper SSL/TLS security in place on PMM. Still needs more work and would be really nice to hide the two mount/copy sections because you don't need to see both...just pick the one you want to do. Also removed some stuff that added little to no value (pmm-admin status doesn't indicate anything about security from what I could see for example) * Update docs/how-to/secure.md Co-authored-by: Denys Kondratenko <[email protected]> * Update docs/how-to/secure.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/how-to/secure.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/how-to/secure.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/how-to/secure.md * Update docs/how-to/secure.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/how-to/secure.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/how-to/secure.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/how-to/secure.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/how-to/secure.md Co-authored-by: Denys Kondratenko <[email protected]> * Update docs/how-to/secure.md * Update secure.md * Formating fixes * Formatting and language updates * Update secure.md * Update secure.md --------- Co-authored-by: Rasika Chivate <[email protected]> Co-authored-by: Denys Kondratenko <[email protected]> * PMM-11951-documentation-for-external-postgres (#1049) * PMM-11951 external docs clarified * PMM-11951 uniform look of examples * PMM-11951 ref percona server -> pmm-server, create user and db * PMM-11951 external postgres with percona test pref * PMM-11951 grafana with external * Update checks development guideline (#1048) * Update checks development guideline * Improvement * Update docs/details/develop-checks/checks-v2.md Co-authored-by: Catalina A <[email protected]> * Update docs/details/develop-checks/checks-v2.md * Update docs/details/develop-checks/checks-v2.md * Update docs/details/develop-checks/checks-v2.md --------- Co-authored-by: Roma Novikov <[email protected]> Co-authored-by: Catalina A <[email protected]> * Update alerting.md (#1039) removed optionally from the line "An alert rule consists of one or more queries and expressions, a condition, the frequency of evaluation, and (optionally) the duration over which the condition is met." As we discussed, for every one of the 16 templates the duration is REQUIRED Co-authored-by: Michael Okoko <[email protected]> * Document clickhouse select option (#1059) * document clickhouse select option * Update checks-v2.md --------- Co-authored-by: Rasika Chivate <[email protected]> Co-authored-by: Catalina A <[email protected]> * Inventory view * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> * Fix the render of icons * Provide a better wording for nodes * line br * Tweaks the icons even more * Update docs/details/dashboards/dashboard-inventory.md * Update docs/details/dashboards/dashboard-inventory.md Co-authored-by: Alex Tymchuk <[email protected]> --------- Co-authored-by: rishat-ishbulatov <[email protected]> Co-authored-by: Rasika Chivate <[email protected]> Co-authored-by: Diogo Recharte <[email protected]> Co-authored-by: Jiří Čtvrtka <[email protected]> Co-authored-by: Michał Nosek <[email protected]> Co-authored-by: Nurlan Moldomurov <[email protected]> Co-authored-by: Alina Derkach <[email protected]> Co-authored-by: Aleksandar Yanakiev <[email protected]> Co-authored-by: Alex Tymchuk <[email protected]> Co-authored-by: Steve Hoffman <[email protected]> Co-authored-by: Denys Kondratenko <[email protected]> Co-authored-by: Artem Gavrilov <[email protected]> Co-authored-by: Roma Novikov <[email protected]> Co-authored-by: Harry Geffin <[email protected]> Co-authored-by: Michael Okoko <[email protected]> * Updated references to Inventory view (#1065) Co-authored-by: Alex Tymchuk <[email protected]> * PMM-11412 K8s new dashboards (#1058) * PMM-11412 K8s new dashbaords * Added image and md file * Added K8s Cluster Summary dashboard * Added images and md file * Added discalimer * Updated index and config file * Create kubernetes_volume.md * added image for K8s volumes dashboard * Update kubernetes_volume.md * Update index.md * Update mkdocs-base.yml * made changes in the config file * Update mkdocs-base.yml * Added a note for minikune cluster * Update kubernetes_volume.md * RN 2.37.0 (#1043) * RN 2.37.0 * Update 2.37.0.md * Update 2.37.0.md * Added new features * Added improvements * Added bugs list * Update 2.37.0.md * Update docs/release-notes/2.37.0.md Co-authored-by: Roma Novikov <[email protected]> * Update 2.37.0.md * Update 2.37.0.md * PMM-11281 description * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md Added RH from Obs team. * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Config changes * Server features items * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update docs/release-notes/2.37.0.md Co-authored-by: Denys Kondratenko <[email protected]> * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update 2.37.0.md * Update docs/release-notes/2.37.0.md Co-authored-by: Catalina A <[email protected]> * Update docs/release-notes/2.37.0.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/release-notes/2.37.0.md Co-authored-by: Alex Tymchuk <[email protected]> * Update docs/release-notes/2.37.0.md Co-authored-by: Alex Tymchuk <[email protected]> * Update 2.37.0.md * Added a table for CVE details in the RN * Changes for QAN RN. * Added list of CVEs * Update 2.37.0.md * Added components upgrade section * Removed the CVE list --------- Co-authored-by: Roma Novikov <[email protected]> Co-authored-by: Duygu Aksoy <[email protected]> Co-authored-by: catalina-adam <[email protected]> Co-authored-by: Denys Kondratenko <[email protected]> Co-authored-by: Catalina A <[email protected]> Co-authored-by: Alex Tymchuk <[email protected]> Co-authored-by: Jiří Čtvrtka <[email protected]> * updated the config file --------- Co-authored-by: rishat-ishbulatov <[email protected]> Co-authored-by: Catalina A <[email protected]> Co-authored-by: Diogo Recharte <[email protected]> Co-authored-by: Jiří Čtvrtka <[email protected]> Co-authored-by: Michał Nosek <[email protected]> Co-authored-by: Nurlan Moldomurov <[email protected]> Co-authored-by: Alina Derkach <[email protected]> Co-authored-by: Aleksandar Yanakiev <[email protected]> Co-authored-by: Alex Tymchuk <[email protected]> Co-authored-by: Steve Hoffman <[email protected]> Co-authored-by: Denys Kondratenko <[email protected]> Co-authored-by: Artem Gavrilov <[email protected]> Co-authored-by: Roma Novikov <[email protected]> Co-authored-by: Harry Geffin <[email protected]> Co-authored-by: Michael Okoko <[email protected]> Co-authored-by: Duygu Aksoy <[email protected]> Co-authored-by: catalina-adam <[email protected]> Co-authored-by: Jiří Čtvrtka <[email protected]>
percona · May 2, 2023 · 5d7e05e · 5d7e05e
1 parent fa815bd
commit 5d7e05e
Show file tree

Hide file tree

Showing 26 changed files with 288 additions and 47 deletions.
diff --git a/docs/_images/INVENTORY_ICON.png b/docs/_images/INVENTORY_ICON.png
diff --git a/docs/_images/Inventory.png b/docs/_images/Inventory.png
diff --git a/docs/_images/PMM_Add_Instance_MySQL.png b/docs/_images/PMM_Add_Instance_MySQL.png
diff --git a/docs/_images/PMM_Add_Instance_MySQL_TLS.png b/docs/_images/PMM_Add_Instance_MySQL_TLS.png
diff --git a/docs/_images/PMM_Add_Instance_PostgreSQL.png b/docs/_images/PMM_Add_Instance_PostgreSQL.png
diff --git a/docs/_images/PMM_Add_Instance_PostgreSQL_TLS.png b/docs/_images/PMM_Add_Instance_PostgreSQL_TLS.png
diff --git a/docs/_images/PMM_Inventory_Item_Selection.png b/docs/_images/PMM_Inventory_Item_Selection.png
diff --git a/docs/_images/PMM_K8s_Cluster_Summary.png b/docs/_images/PMM_K8s_Cluster_Summary.png
diff --git a/docs/_images/PMM_K8s_Pods_Status.png b/docs/_images/PMM_K8s_Pods_Status.png
diff --git a/docs/_images/PMM_K8s_volume.png b/docs/_images/PMM_K8s_volume.png
diff --git a/docs/_images/arrow-downward.ico b/docs/_images/arrow-downward.ico
diff --git a/docs/_images/dots-three-vertical.ico b/docs/_images/dots-three-vertical.ico
diff --git a/docs/details/dashboards/dashboard-inventory.md b/docs/details/dashboards/dashboard-inventory.md
@@ -1,41 +1,47 @@
 # PMM Inventory
 
-The *Inventory* dashboard is a high level overview of all objects registered by PMM.
+The **Inventory** dashboard is a high-level overview of all objects registered in PMM.
 
-To see it select <i class="uil uil-cog"></i> *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.inventory}} *Inventory list*.
+To check your inventory list, go to <i class="uil uil-cog"></i> **Configuration** > **Inventory**.
 
-![!image](../../_images/PMM_Inventory.jpg)
+![!image](../../_images/Inventory.png)
 
-Inventory objects form a hierarchy with Node at the top, then Service and Agents assigned to a Node.
+Inventory objects form a hierarchy with Node at the top, then Service and Agents assigned to a Node. This information is detailed in the two tabs available on this page.
 
-There are three tabs where items for each type are listed with their details:
+### **Services** tab
 
-- *Services*
+Shows individual services, the nodes on which they run, and the Agents that help collect the service metrics.
+The **Status** column shows the status of your databases based on metrics coming directly from the database.
+The **Monitoring** column summarizes the status of all the Agents assigned to the service.
 
-    Individual service names and where they run, against which agents will be assigned. Each instance of a service gets a `service_id` value that is related to a `node_id`. Examples are MySQL, Amazon Aurora MySQL. This feature also allows to support multiple mysqld instances on a single node, with different service names, e.g. `mysql1-3306`, and `mysql1-3307`.
+You can check Query Analytics information and the Service Overview Dashboard for each service by clicking on the <image src="../../_images/dots-three-vertical.ico" width="15px" aria-label="triple dots" /> icon in the **Options** column.
 
-- *Agents*
+From here you can also check additional information about the service, by clicking on the <image src="../../_images/arrow-downward.ico" width="15px" aria-label="downward arrow"/> icon. This expands the service entry to show reference information like service labels and IDs.
 
-    Each binary (exporter, agent) running on a client will get an `agent_id` value. Examples:
+Each instance of a service gets a `service_type` attribute so one can clearly tell what type of database it is, for instance: `mysql`, `postgresql`, `mongodb`, etc. Every service is related to a certain node via its `node_id` attribute. This feature allows to support multiple instances on a single node, with different service names, e.g. `mysql1-3306`, and `mysql1-3307`.
 
-    - `pmm-agent` one is the top of the tree, assigned to a `node_id`
-    - `node_exporter` is assigned to pmm-agent `agent_id`
-    - `mysqld_exporter` and QAN MySQL Perfschema are assigned to a `service_id`.
+Each binary (exporter, agent) running on a client will get an `agent_type` value. Examples:
 
-- *Nodes*
+- `pmm-agent` is at the top of the tree, assigned to PMM Agent itself
+- `node_exporter` is assigned to an agent that extracts the node metrics
+- `mysqld_exporter` and `qan-mysql-perfschema-agent` are assigned to agents that extract metrics from mysql and its performance schema respectively.
 
-    Where the service and agents will run. Assigned a `node_id`, associated with a `machine_id` (from `/etc/machine-id`). Some examples are bare metal, virtualized, container.
+### **Nodes** tab
+
+Shows where the service and agents run.
+
+Each `node_id` is associated with a `machine_id` (from `/etc/machine-id`). Nodes also have `node_type` attributes, which give an idea about their nature. Some examples are: generic, container, remote, remote_rds, etc.
+
+By expanding the entry from the options column, you can check the node labels and attributes.
 
 ## Removing items from the inventory
 
-You can remove items from the inventory.
+To remove items from the inventory:
 
-1. Select <i class="uil uil-cog"></i> *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.inventory}} *Inventory list*.
+1. Go to <i class="uil uil-cog"></i> **Configuration** > {{icon.inventory}} **Inventory**.
 
 2. In the first column, select the items to be removed.
 
-    ![!image](../../_images/PMM_Inventory_Item_Selection.jpg)
-
-3. Click *Delete*. The interface will ask you to confirm the operation:
+   ![!image](../../_images/PMM_Inventory_Item_Selection.png)
 
-    ![!image](../../_images/PMM_Inventory_Item_Delete.jpg)
+3. Click **Delete** and confirm the removal.
diff --git a/docs/details/dashboards/index.md b/docs/details/dashboards/index.md
@@ -2,6 +2,9 @@
 
 | Category          | Dashboard                                                                                | Elements { data-sort-method='number'} |
 |-------------------|------------------------------------------------------------------------------------------|:-------------------------------------:|
+| Kubernetes        | [Kubernetes Cluster Summary]                                                              | 7
+| Kubernetes        | [Kubernetes Pods Status]                                                                         | 26
+| Kubernetes        | [Kubernetes Volumes]                                                             | 57
 | Insight           | [Advanced Data Exploration]                                                              | 7
 | Insight           | [Home Dashboard]                                                                         | 26
 | Insight           | [Prometheus Exporter Status]                                                             | 57
@@ -63,6 +66,9 @@
 
 [Advanced Data Exploration]: dashboard-advanced-data-exploration.md
 [Home Dashboard]: dashboard-home.md
+[Kubernetes Cluster Summary]: kubernetes_cluster_summary.md
+[Kubernetes Pods Status]: kubernetes_pods_status.md
+[Kubernetes Volumes]: kubernetes_volume.md
 [DB Cluster Summary]: dashboard-cluster-summary.md
 [Prometheus Exporter Status]: dashboard-prometheus-exporter-status.md
 [Prometheus Exporters Overview]: dashboard-prometheus-exporters-overview.md

diff --git a/docs/details/dashboards/kubernetes_cluster_summary.md b/docs/details/dashboards/kubernetes_cluster_summary.md
@@ -0,0 +1,24 @@
+# Kubernetes Cluster Summary
+
+!!! caution alert alert-warning "Disclaimer"
+    This is an Experimental Dashboard that is not part of the official Percona Monitoring and Management (PMM) deployment and might be updated. We ship this Dashboard to obtain feedback from our users.
+
+!!! note alert alert-primary "Availability"
+    This experimental dashboard is available starting with PMM 2.30.0.
+
+
+![!image](../../_images/PMM_K8s_volume.png)
+
+*Kubernetes Volumes* dashboard provides a comprehensive overview of your Kubernetes cluster, including:
+
+- Resources
+- Node Status
+- [Pod](https://kubernetes.io/docs/concepts/workloads/pods/) Status
+- [PVC](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) status
+- CPU Overview
+- Kubernetes Resource Count
+- Memory Overview and more
+
+With this dashboard, you can view all workloads running in the cluster and optimize their performance.
+
+
diff --git a/docs/details/dashboards/kubernetes_pods_status.md b/docs/details/dashboards/kubernetes_pods_status.md
@@ -0,0 +1,16 @@
+# Kubernetes Pods Status
+
+!!! caution alert alert-warning "Disclaimer"
+    This is an Experimental Dashboard that is not part of the official Percona Monitoring and Management (PMM) deployment and might be updated. We ship this Dashboard to obtain feedback from our users.
+
+!!! note alert alert-primary "Availability"
+    This experimental dashboard is available starting with PMM 2.37.0.
+
+
+![!image](../../_images/PMM_K8s_Pods_Status.png)
+
+Kubernetes Pods Status dashboard provides detailed information about the state and performance of your pods, including CPU, Memory, and Network metrics. 
+
+This dashboard can help you quickly pinpoint any issues affecting your pods and ensure they continue to operate smoothly.
+
+
diff --git a/docs/details/dashboards/kubernetes_volume.md b/docs/details/dashboards/kubernetes_volume.md
@@ -0,0 +1,16 @@
+# Kubernetes Volumes
+
+!!! caution alert alert-warning "Disclaimer"
+    This is an Experimental Dashboard that is not part of the official Percona Monitoring and Management (PMM) deployment and might be updated. We ship this Dashboard to obtain feedback from our users.
+
+!!! note alert alert-primary ""
+    This dashboard will not work for minikube cluster as there are no drivers for it.
+
+
+![!image](../../_images/PMM_K8s_volume.png)
+
+Starting with PMM 2.37.0 we have introduced *Kubernetes Volumes* dashboard. This dashboard provides insights into your Kubernetes volumes, including capacity and usage, in real-time. 
+
+With this dashboard, you can easily monitor the performance and usage of your volumes and take proactive measures to ensure their performance.
+
+
diff --git a/docs/details/postgresql.md b/docs/details/postgresql.md
@@ -7,7 +7,7 @@ You can use an external PostgreSQL database instance outside the PMM Server cont
 PMM predefines certain flags that allow you to use PostgreSQL parameters as environment variables:
 
 !!! caution alert alert-warning "Warning"
-The `PERCONA_TEST_*` environment variables are experimental and subject to change. It is recommended that you use these variables for testing purposes only and not on production. The minimum supported PostgreSQL server version is 14.
+    The `PERCONA_TEST_*` environment variables are experimental and subject to change. It is recommended that you use these variables for testing purposes only and not on production. The minimum supported PostgreSQL server version is 14.
 
 To use PostgreSQL as an external database instance, use the following environment variables:
 

diff --git a/docs/get-started/backup/mongo-prerequisites.md b/docs/get-started/backup/mongo-prerequisites.md
@@ -7,7 +7,8 @@ Before creating MongoDB backups, make sure to:
 3. For setups where PMM Server runs as a Docker container, enable backup features at container creation time by adding `-e ENABLE_BACKUP_MANAGEMENT=1` to your `docker run` command.
 4. Check that [PMM Client](../../setting-up/client/index.md) is installed. For creating logical backups, the PMM client should run on at least one node of the replica set. Make sure this is the one that will be used for backup and restore jobs. For physical backups, make sure PMM client runs on all nodes instead.  
 5. Check that [Percona Backup for MongoDB](https://docs.percona.com/percona-backup-mongodb/index.html) (PBM) is installed and `pbm-agent` is running on all MongoDB nodes in the replica set. PMM 2.32 and later require PBM 2.0.1 or newer.
-6. Check that your MongoDB Services are managed as clusters in PMM. Go to **PMM Inventory > Services** page and make sure that all the services in the table specify a cluster name in the **Other Details** column. Services that do not specify a cluster name should be removed and re-added using command like the following:
+6. Check that your MongoDB Services are managed as clusters in PMM. Go to **PMM Inventory > Services** page, expand the **Details** section <image src="../../_images/arrow-downward.ico" width="15px" aria-label="downward arrow"/> on the **Options** column, and make sure that all the services in the table specify a cluster name.
+Services that do not specify a cluster name should be removed and re-added using command like the following:
    <pre><code>pmm-admin add mongodb \
    --username=pmm_mongodb --password=password \
    query-source=profiler <mark>--cluster=mycluster</mark></code></pre>