diff --git a/documentation/docs/admin/manage-users/add_users.md b/documentation/docs/admin/manage-users/add_users.md index 8a0794aafdd..79ad3cd12b4 100644 --- a/documentation/docs/admin/manage-users/add_users.md +++ b/documentation/docs/admin/manage-users/add_users.md @@ -4,14 +4,10 @@ Adding users with basic authentication (username and password stored in PMM) fro If your organization uses LDAP, OAuth, SAML, or other authentication methods, users are managed through your external authentication system. See [available authentication methods](edit_users.md#available-authentication-methods) for more information. -!!! note "Authentication methods" - -![!](../../images/PMM-manage-users.png) - To add a new user in PMM: {.power-number} -1. On the **Users** tab, click **New user**. +1. Go to **Users and access** page, click **New user**. 2. On the **Add new user** dialog box, enter the following: - **Name** - Full name of the user - **Email** - Email address or username (if this is an existing Grafana user) @@ -20,6 +16,8 @@ To add a new user in PMM: 3. Click **Create user**. +![!](../../images/PMM-manage-users.png) + The new user can now log in to PMM using the username and password you created. ## Assign user roles diff --git a/documentation/docs/admin/manage-users/delete_users.md b/documentation/docs/admin/manage-users/delete_users.md index a2e01786e32..2e0edbc03bc 100644 --- a/documentation/docs/admin/manage-users/delete_users.md +++ b/documentation/docs/admin/manage-users/delete_users.md @@ -3,6 +3,6 @@ You can delete a user in PMM as follows: {.power-number} -1. Go to **PMM Administration > Users and access > Users** tab +1. Go to **Users and access > Users** tab. 2. Click the **Edit user** icon next to the user you want to delete. 3. Click **Delete user**. \ No newline at end of file diff --git a/documentation/docs/admin/manage-users/edit_users.md b/documentation/docs/admin/manage-users/edit_users.md index 463b241e4d3..8577c1f7a0b 100644 --- a/documentation/docs/admin/manage-users/edit_users.md +++ b/documentation/docs/admin/manage-users/edit_users.md @@ -10,11 +10,13 @@ You can edit users by changing the information or settings for an individual use You can grant or revoke admin access to a user as follows: {.power-number} -1. On the **Users** tab, click the user account you want to edit. +1. Go to **Users and access**. -2. To grant or revoke the privileges, click the user. User information dialog box opens. +2. Locate the user account you want to update and click the Edit (pencil) icon. -3. In the **Permissions** section, click **Change** and then select **Yes/No**, depending on whether you want to provide admin access or not. +3. In the **User information** dialog, scroll to **Permissions** section and click **Change** + +4. Choose **Yes/No**, depending on whether you want to provide admin access or not. 4. Click **Change**. @@ -27,13 +29,15 @@ You can change the organization role assigned to your user account. To change the role: {.power-number} -1. On the **Users** tab, click the user for whom you want to change the role. +1. On the **Users and access**, click the user for whom you want to change the role. + +2. Locate the user account you want to update and click the Edit (pencil) icon. -2. In the **Organizations** section, click **Change role**. +3. In the **Organizations** section, click **Change role**. -3. Select the role from the drop-down and click **Save**. +4. Select the role from the drop-down and click **Save**. -The following are the privileges for the various *roles*: +Here are the privileges for the various *roles*: - **Admin** - Managing data sources, teams, and users within an organization diff --git a/documentation/docs/admin/manage-users/index.md b/documentation/docs/admin/manage-users/index.md index 3c0e6a7d395..bc8c714398d 100644 --- a/documentation/docs/admin/manage-users/index.md +++ b/documentation/docs/admin/manage-users/index.md @@ -1,12 +1,28 @@ -# About user management in PMM +# User management in PMM -A user refers to any individual who can log in to PMM. Each user is assigned a specific role that is associated with permissions. Permissions determine the tasks a user can perform in the system. For instance, the Admin role confers permissions that allow an authorized administrator to create and delete user profiles. +User management controls who can access PMM and what actions they can perform. Every user who logs into PMM has a specific role assigned, which determines their permissions. -The following topics are covered as part of access control: +User management defines who can access PMM and what actions they are allowed to perform: +- **Users**: Individual accounts that can log in to PMM with unique credentials. -- [Add users](add_users.md) -- [Edit users](edit_users.md) -- [Delete users](delete_users.md) +- **Roles**: Predefined permission sets that determine what users can do. The Admin role, for example, allows creating and deleting user profiles, while other roles may have more limited permissions. + +- **Permissions**: Specific actions or tasks that a role authorizes. Permissions are role-based—users inherit all permissions associated with their assigned role. + +## User management tasks + +This section covers the following user management operations: + +- [Add users](add_users.md): Create new user accounts and assign roles +- [Edit users](edit_users.md): Modify user profiles and change assigned roles +- [Delete users](delete_users.md): Remove user accounts from the system + +!!! note + Only users with the Admin role can perform user management tasks. + +## Understanding roles and permissions + +User capabilities depend entirely on the role assigned to them. For a comprehensive overview of available roles and their associated permissions, see [Access control in PMM](../roles/access-control/intro.md). ## Next steps diff --git a/documentation/docs/admin/roles/access-control/assign_roles.md b/documentation/docs/admin/roles/access-control/assign_roles.md index bae490387d4..c6726024b6a 100644 --- a/documentation/docs/admin/roles/access-control/assign_roles.md +++ b/documentation/docs/admin/roles/access-control/assign_roles.md @@ -3,8 +3,8 @@ To assign access roles to users: {.power-number} -1. From the [main menu](../../../reference/ui/ui_components.md), go to **PMM Configuration > Settings > Advanced Settings** and enable the **Access Roles** option. -2. Go to **Administration > Users and access > Users**. +1. From the [main menu](../../../reference/ui/ui_components.md), go to **Configuration > Settings > Advanced Settings** and enable the **Access control** option. +2. Go to **Users and access > Users**. 3. Click on the user you want to assign roles to. 4. From the **Roles** drop-down select the appropriate roles. 5. Verify the assigned roles appear in the **Access Role** column. diff --git a/documentation/docs/admin/roles/access-control/create_roles.md b/documentation/docs/admin/roles/access-control/create_roles.md index 928a2934cf4..8b9ccf8206a 100644 --- a/documentation/docs/admin/roles/access-control/create_roles.md +++ b/documentation/docs/admin/roles/access-control/create_roles.md @@ -13,13 +13,13 @@ Roles are essential components of PMM's access control system. They allow you to To create access roles in PMM: {.power-number} -1. From the [main menu](../../../reference/ui/ui_components.md), go to **PMM Configuration > Settings > Advanced Settings** and enable the **Access control** option. -2. Go to **Administration > Users and access > Access Roles**. +1. From the [main menu](../../../reference/ui/ui_components.md), go to **Configuration > Settings > Advanced Settings** and enable the **Access control** option. +2. Go to **Users and access > Access Roles**. ![PMM Access Control - Create role](../../../images/lbac/PMM_access_control_create_role.png) 3. Click **Create**. -4. On the **Create role** page, enter the Role name and Role description. +4. On the **Create role** page, enter a role name and description. 5. Configure metrics access by setting label selectors: - select a Label (e.g., "service_name", "environment") - choose an Operator (e.g., "=", "!=", "=~") @@ -29,6 +29,6 @@ To create access roles in PMM: For information on how the Prometheus selectors work, see [Prometheus selectors](https://prometheus.io/docs/prometheus/latest/querying/basics/#time-series-selectors). -6. Review your selections, then click **Create** to finalize the role. +6. Review your selections, then click **Create role** to finish creating the role. diff --git a/documentation/docs/admin/roles/access-control/enable_access_control.md b/documentation/docs/admin/roles/access-control/enable_access_control.md index 408295e4f2e..ae01cb4e92c 100644 --- a/documentation/docs/admin/roles/access-control/enable_access_control.md +++ b/documentation/docs/admin/roles/access-control/enable_access_control.md @@ -37,8 +37,8 @@ Choose your preferred method to enable this feature: {.power-number} 1. Log in to PMM with an administrator account. - 2. From the main menu, go to **PMM Configuration > Settings > Advanced Settings > Access Control**. - 3. Toggle the toggle. + 2. From the main menu, go to **Configuration > Settings > Advanced Settings**. + 3. Toggle the **Access Control** toggle. 4. Click **Apply changes** to save your settings. ## After enabling access control diff --git a/documentation/docs/admin/roles/access-control/intro.md b/documentation/docs/admin/roles/access-control/intro.md index 47c51bfd6f7..0a7a4bf7cad 100644 --- a/documentation/docs/admin/roles/access-control/intro.md +++ b/documentation/docs/admin/roles/access-control/intro.md @@ -36,10 +36,10 @@ Here's how LBAC works: To implement label-based access control in PMM: {.power-number} -1. [Enable access control](enable_access_control.md) in your PMM settings -2. Learn about the [labels available for filtering](labels.md) -3. [Create access roles](create_roles.md) based on your organizational needs -4. Review common [use cases and examples](use_cases.md) for inspiration +1. [Enable access control](enable_access_control.md) in your PMM settings. +2. Learn about the [labels available for filtering](labels.md). +3. [Create access roles](create_roles.md) based on your organizational needs. +4. Review common [use cases and examples](use_cases.md) for inspiration. !!! tip "Best practice" Start with broader access controls and refine them over time as you understand your organization's specific needs. Test LBAC behavior in both dashboards and QAN to ensure proper access control. diff --git a/documentation/docs/admin/roles/access-control/labels.md b/documentation/docs/admin/roles/access-control/labels.md index f49b46692de..7c37623d42d 100644 --- a/documentation/docs/admin/roles/access-control/labels.md +++ b/documentation/docs/admin/roles/access-control/labels.md @@ -37,16 +37,13 @@ You can add standard or custom labels while adding a service to monitoring in PM To set the labels via the user interface: {.power-number} - 1. From the **Main** menu, go to **PMM Configuration > PMM Services > Add Service**. + 1. From the main menu, go to **Inventory > Add Service**. 2. Select the service you want to monitor. 3. Complete the required connection details. - 4. Enter standard labels via the input section `Labels`. - - 5. Enter custom labels via section `Custom labels`. - + 4. In the **Labels** section, enter standard and custom labels. ![PMM Inventory - Add Service](../../../images/lbac/PMM_access_control_add_labels_services.png) === "Using pmm-admin" @@ -58,7 +55,7 @@ PMM allows modifying certain standard labels after a service is created: - `environment` - `cluster` -- `replication_set` +- `replication_set` - `external_group` For other standard labels that cannot be modified directly, you must remove the service and re-add it with the desired labels. diff --git a/documentation/docs/admin/roles/access-control/manage_roles.md b/documentation/docs/admin/roles/access-control/manage_roles.md index e7e3a97b624..df10cecf1c4 100644 --- a/documentation/docs/admin/roles/access-control/manage_roles.md +++ b/documentation/docs/admin/roles/access-control/manage_roles.md @@ -7,30 +7,30 @@ You can manage roles in PMM by editing or deleting a role. To edit access roles: {.power-number} -1. From [main menu](../../../reference/ui/ui_components.md), go to **PMM Configuration > Settings > Advanced Settings** and enable the **Access Roles** option. +1. From the [main menu](../../../reference/ui/ui_components.md), go to **Configuration > Settings > Advanced Settings** then enable **Access control**. -2. Go to **Administration > Users and access > Access Roles**. +2. Go to **Users and access > Access roles**. -3. On the role you want to edit, click the **ellipsis (three vertical dots) > edit role** in the **Options** column. The **Edit** role page opens. +3. In the **Options** column, click the ellipsis (three vertical dots) next to the role you want to edit, then select **Edit** to open the **Edit role** page: ![PMM Access Control - Edit role](../../../images/lbac/PMM_access_control_edit_role.png) 4. Make the required changes to the role. -5. Click **Save Changes**. +5. Click **Save changes**. ## Set a role as default -When a user signs in to PMM for the first time and the user has no role assigned, the user is automatically assigned the *Default* role. For administrators, the default role provides a convenient way to configure default permissions for new users. +When a user signs in to PMM for the first time and the user has no role assigned, the user is automatically assigned the **Default** role. For administrators, the default role provides a convenient way to configure default permissions for new users. To set a role as default, do the following: {.power-number} -1. From [main menu](../../../reference/ui/ui_components.md), go to **PMM Configuration > Settings > Advanced Settings** and enable the **Access Roles** option. +1. From [main menu](../../../reference/ui/ui_components.md), go to **Configuration > Settings > Advanced Settings** and enable the **Access control** option. -2. Go to **Administration > Users and access > Access Roles**. +2. Go to **Users and access > Access roles**. -3. On the role you want to set as default, click the **ellipsis (three vertical dots) → set as default** in the **Options** column. +3. On the **Options** column, click the ellipsis (three vertical dots) next to the role you want to set, then select **Set as default**. ## Remove roles @@ -38,8 +38,9 @@ To set a role as default, do the following: To remove access roles, do the following: {.power-number} -1. From [main menu](../../../reference/ui/ui_components.md), go to **PMM Configuration > Settings > Advanced Settings** and enable the **Access Roles** option. - -2. On the role you want to remove, click the **ellipsis (three vertical dots) > Delete** in the **Options** column. Delete role pop-up opens. +1. From [main menu](../../../reference/ui/ui_components.md), go to **Configuration > Settings > Advanced Settings** and enable the **Access control** option. -3. Click **Confirm** and delete the role. +2. Go to **Users and access > Access roles**. + +3. In the **Options** column, click the ellipsis (three vertical dots) next to the role you want to remove, then select **Delete**. +4. Click **Confirm and delete role**. diff --git a/documentation/docs/api/authentication.md b/documentation/docs/api/authentication.md index 011302c0aa1..c198504a68b 100644 --- a/documentation/docs/api/authentication.md +++ b/documentation/docs/api/authentication.md @@ -35,15 +35,14 @@ PMM uses Grafana service account tokens for authentication. These tokens are ran Here's how to generate a service account token: {.power-number} -1. Log into PMM. -2. From the side menu, click **Administration > Users and access**. -3. Click on the **Service accounts** card. +1. Log in to PMM. +2. From the side menu, click **Users and access > Service accounts**. 4. Click **Add service account**. Specify a unique name for your service account, select a role from the drop-down menu, and click **Create** to display your newly created service account. 5. Click **Add service account token**. 6. In the pop-up dialog, provide a name for the new service token, or leave the field empty to generate an automatic name. 7. Optionally, set an expiration date for the service account token. PMM cannot automatically rotate expired tokens, which means and you will need to manually [update the PMM-agent configuration file](../use/commands/pmm-agent.md) with a new service account token. Permanent tokens, on the other hand, remain valid indefinitely unless specifically revoked. -8. Click **Generate Token**. A pop-up window will display the new token, which usually has a *glsa_* prefix. -9. Copy your service token to the clipboard and store it securely. +8. Click **Generate token**. A pop-up window will display the new token, which usually has a *glsa_* prefix. +9. Click **Copy your service token to the clipboard** and store it securely. Now you can use your new service token for authentication in PMM API calls or in your [pmm-agent configuration](../use/commands/pmm-agent.md). ## Authenticate diff --git a/documentation/docs/configure-pmm/percona_platform/account-info.md b/documentation/docs/configure-pmm/percona_platform/account-info.md deleted file mode 100644 index dfa8f1733e6..00000000000 --- a/documentation/docs/configure-pmm/percona_platform/account-info.md +++ /dev/null @@ -1,25 +0,0 @@ -# Check Percona Portal account information - -!!! caution alert alert-warning "Percona Platform deprecation" - - **Percona Platform is deprecated as of PMM 3.5.0 and will be discontinued with PMM 3.7.0 (March 2026).** - - All advisors and alert templates are now built directly into PMM as free, offline features. Platform connectivity, Percona Account sign-in, and account information features (Entitlements and Support tickets) in PMM will be removed. - - [Migrate to a supported authentication method](../../admin/manage-users/edit_users.md#migrate-from-percona-account-authentication-deprecated) before March 2026. - - **Need help?** Contact [Percona Support](https://www.percona.com/services/support) for migration assistance. - - -When you connect your PMM instances to Percona Platform with a customer account, PMM reveals two new tabs on the main menu, where you can check all the information available for your customer accounts: **Entitlements** and **Support tickets**: - -![CustomerTickets](../../images/CustomerTickets.png) - -![CustomerEntitlements](../../images/CustomerEntitlements.png) - - -When you connect your PMM instances to Percona Platform with a customer account, PMM reveals two new tabs on the main menu, where you can check all the information available for your customer accounts: **Entitlements** and **Support tickets**: - -![CustomerTickets](../../images/CustomerTickets.png) - -![CustomerEntitlements](../../images/CustomerEntitlements.png) diff --git a/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md b/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md index 59e9bf028cf..4852ba1f02d 100644 --- a/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md +++ b/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md @@ -19,7 +19,7 @@ For security reasons, access tokens expire after 30 minutes. Make sure to paste To connect your PMM Server to Percona Platform: {.power-number} -1. In PMM, go to **PMM Configuration > Settings > Percona Platform** tab to fill in the **Connect PMM to Percona Portal** form: ![Percona_Platform_Login](../../images/PMM_Settings_Percona_Platform_Login.png) +1. In PMM, go to **Configuration > Settings > Percona Platform** tab to fill in the **Connect PMM to Percona Portal** form: ![Percona_Platform_Login](../../images/PMM_Settings_Percona_Platform_Login.png) 2. The **PMM Server ID** field is automatically populated with the ID identified for your PMM instance. Enter the name of your PMM instance and click **Get token** to go to Percona Platform Portal and generate your access token. 3. Log into Percona Platform using your Percona Account (if you don't have an active current session). diff --git a/documentation/docs/discover-pmm/why-pmm.md b/documentation/docs/discover-pmm/why-pmm.md index a15f5e6738c..8d639025406 100644 --- a/documentation/docs/discover-pmm/why-pmm.md +++ b/documentation/docs/discover-pmm/why-pmm.md @@ -2,13 +2,13 @@ Percona Monitoring and Management (PMM) delivers: -* **Comprehensive monitoring** of MySQL, MariaDB, MongoDB, and PostgreSQL databases. -* **Built-in advisors and alerts** that work offline with no subscription required. Proactively detect security threats, performance issues, and configuration problems. -* **Query performance insights** to identify and optimize slow queries for improved system efficiency. +* **Comprehensive monitoring** of MySQL, MariaDB, MongoDB, and PostgreSQL databases +* **Built-in advisors and alerts** that work offline with no subscription required. Proactively detect security threats, performance issues, and configuration problems +* **Query performance insights** to identify and optimize slow queries for improved system efficiency * **Database-specific features** tailored for deep monitoring of different database engines -* **Built-in security** with SSL encryption and robust authentication. -* **Flexible customization** through custom dashboards, metrics, and exporters. +* **Built-in security** with SSL encryption and robust authentication +* **Flexible customization** through custom dashboards, metrics, and exporters * **Centralized management** of multiple database instances across different hosts -* **Active community support** with regular updates and improvements. +* **Active community support** with regular updates and improvements -![!PMM Home Screen](../images/Home_screen.jpg) + ![!PMM Home Screen](../images/Home_screen.png) diff --git a/documentation/docs/images/![!image](..:..:images:PMM_Mongodb_Collections_Overview_Experimental.png b/documentation/docs/images/![!image](..:..:images:PMM_Mongodb_Collections_Overview_Experimental.png new file mode 100644 index 00000000000..c93406704f6 Binary files /dev/null and b/documentation/docs/images/![!image](..:..:images:PMM_Mongodb_Collections_Overview_Experimental.png differ diff --git a/documentation/docs/images/Home_screen.png b/documentation/docs/images/Home_screen.png new file mode 100644 index 00000000000..8bfeb914b6a Binary files /dev/null and b/documentation/docs/images/Home_screen.png differ diff --git a/documentation/docs/images/MM_Disk_Details.jpg b/documentation/docs/images/MM_Disk_Details.jpg new file mode 100644 index 00000000000..c057da6229f Binary files /dev/null and b/documentation/docs/images/MM_Disk_Details.jpg differ diff --git a/documentation/docs/images/MM_MySQL_Instances_Overview.jpg b/documentation/docs/images/MM_MySQL_Instances_Overview.jpg new file mode 100644 index 00000000000..d43a0363990 Binary files /dev/null and b/documentation/docs/images/MM_MySQL_Instances_Overview.jpg differ diff --git a/documentation/docs/images/MongoDB_Router_Summary.png b/documentation/docs/images/MongoDB_Router_Summary.png index 4ff397679a1..c8f8c3166f3 100644 Binary files a/documentation/docs/images/MongoDB_Router_Summary.png and b/documentation/docs/images/MongoDB_Router_Summary.png differ diff --git a/documentation/docs/images/PBM_Dashboard.png b/documentation/docs/images/PBM_Dashboard.png index 9a22e3463bb..d9848d3402e 100644 Binary files a/documentation/docs/images/PBM_Dashboard.png and b/documentation/docs/images/PBM_Dashboard.png differ diff --git a/documentation/docs/images/PMM-change-role.png b/documentation/docs/images/PMM-change-role.png index 94a32ef54fd..3db50e344c2 100644 Binary files a/documentation/docs/images/PMM-change-role.png and b/documentation/docs/images/PMM-change-role.png differ diff --git a/documentation/docs/images/PMM-manage-users.png b/documentation/docs/images/PMM-manage-users.png index ed6cc4e122b..a0b56abc1fd 100644 Binary files a/documentation/docs/images/PMM-manage-users.png and b/documentation/docs/images/PMM-manage-users.png differ diff --git a/documentation/docs/images/PMM_Advanced_Data_Exploration.jpg b/documentation/docs/images/PMM_Advanced_Data_Exploration.jpg index 3cec740296e..853ade4675e 100644 Binary files a/documentation/docs/images/PMM_Advanced_Data_Exploration.jpg and b/documentation/docs/images/PMM_Advanced_Data_Exploration.jpg differ diff --git a/documentation/docs/images/PMM_CPU_Utilization_Details.jpg b/documentation/docs/images/PMM_CPU_Utilization_Details.jpg index 372bffc139a..949be740853 100644 Binary files a/documentation/docs/images/PMM_CPU_Utilization_Details.jpg and b/documentation/docs/images/PMM_CPU_Utilization_Details.jpg differ diff --git a/documentation/docs/images/PMM_Disk_Details.jpg b/documentation/docs/images/PMM_Disk_Details.jpg index 5f1012e3ff0..c2433ce19ca 100644 Binary files a/documentation/docs/images/PMM_Disk_Details.jpg and b/documentation/docs/images/PMM_Disk_Details.jpg differ diff --git a/documentation/docs/images/PMM_Experimental_Environment_Overview_Dashboard.png b/documentation/docs/images/PMM_Experimental_Environment_Overview_Dashboard.png index 60bedce7df3..15bc81634c8 100644 Binary files a/documentation/docs/images/PMM_Experimental_Environment_Overview_Dashboard.png and b/documentation/docs/images/PMM_Experimental_Environment_Overview_Dashboard.png differ diff --git a/documentation/docs/images/PMM_Home_Dashboard.png b/documentation/docs/images/PMM_Home_Dashboard.png index 1b5a9149b77..80e03ac89a8 100644 Binary files a/documentation/docs/images/PMM_Home_Dashboard.png and b/documentation/docs/images/PMM_Home_Dashboard.png differ diff --git a/documentation/docs/images/PMM_Home_Dashboard_Numbered.png b/documentation/docs/images/PMM_Home_Dashboard_Numbered.png index f3b14c439e4..844ee783c8f 100644 Binary files a/documentation/docs/images/PMM_Home_Dashboard_Numbered.png and b/documentation/docs/images/PMM_Home_Dashboard_Numbered.png differ diff --git a/documentation/docs/images/PMM_K8s_volume.png b/documentation/docs/images/PMM_K8s_volume.png index ce73dc0c714..9ed35abbee5 100644 Binary files a/documentation/docs/images/PMM_K8s_volume.png and b/documentation/docs/images/PMM_K8s_volume.png differ diff --git a/documentation/docs/images/PMM_Memory_Details.jpg b/documentation/docs/images/PMM_Memory_Details.jpg index e6084a5cf68..7ebddf54b4c 100644 Binary files a/documentation/docs/images/PMM_Memory_Details.jpg and b/documentation/docs/images/PMM_Memory_Details.jpg differ diff --git a/documentation/docs/images/PMM_MongoDB_Cluster_Summary.jpg b/documentation/docs/images/PMM_MongoDB_Cluster_Summary.jpg index f451ea010a2..193e9487296 100644 Binary files a/documentation/docs/images/PMM_MongoDB_Cluster_Summary.jpg and b/documentation/docs/images/PMM_MongoDB_Cluster_Summary.jpg differ diff --git a/documentation/docs/images/PMM_MongoDB_InMemory_Details.jpg b/documentation/docs/images/PMM_MongoDB_InMemory_Details.jpg index 74a1ee866e2..e4a845c82e2 100644 Binary files a/documentation/docs/images/PMM_MongoDB_InMemory_Details.jpg and b/documentation/docs/images/PMM_MongoDB_InMemory_Details.jpg differ diff --git a/documentation/docs/images/PMM_MongoDB_Instance_Summary.jpg b/documentation/docs/images/PMM_MongoDB_Instance_Summary.jpg index 41de04bc6bf..6619a524e4d 100644 Binary files a/documentation/docs/images/PMM_MongoDB_Instance_Summary.jpg and b/documentation/docs/images/PMM_MongoDB_Instance_Summary.jpg differ diff --git a/documentation/docs/images/PMM_MongoDB_Instances_Compare.jpg b/documentation/docs/images/PMM_MongoDB_Instances_Compare.jpg index c594693a917..829b4cdf78a 100644 Binary files a/documentation/docs/images/PMM_MongoDB_Instances_Compare.jpg and b/documentation/docs/images/PMM_MongoDB_Instances_Compare.jpg differ diff --git a/documentation/docs/images/PMM_MongoDB_Instances_Overview.jpg b/documentation/docs/images/PMM_MongoDB_Instances_Overview.jpg index 1a144c7969d..352ad7f90d8 100644 Binary files a/documentation/docs/images/PMM_MongoDB_Instances_Overview.jpg and b/documentation/docs/images/PMM_MongoDB_Instances_Overview.jpg differ diff --git a/documentation/docs/images/PMM_MongoDB_MMAPv1_Details.jpg b/documentation/docs/images/PMM_MongoDB_MMAPv1_Details.jpg index 7c7c3b429d2..bc259ac6e83 100644 Binary files a/documentation/docs/images/PMM_MongoDB_MMAPv1_Details.jpg and b/documentation/docs/images/PMM_MongoDB_MMAPv1_Details.jpg differ diff --git a/documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg b/documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg index 8e529936c5c..c609d88d32b 100644 Binary files a/documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg and b/documentation/docs/images/PMM_MongoDB_ReplSet_Summary.jpg differ diff --git a/documentation/docs/images/PMM_MongoDB_WiredTiger_Details.jpg b/documentation/docs/images/PMM_MongoDB_WiredTiger_Details.jpg index f43869fd2da..bf42ee4399a 100644 Binary files a/documentation/docs/images/PMM_MongoDB_WiredTiger_Details.jpg and b/documentation/docs/images/PMM_MongoDB_WiredTiger_Details.jpg differ diff --git a/documentation/docs/images/PMM_Mongodb_Collections_Oplog_Experimental.png b/documentation/docs/images/PMM_Mongodb_Collections_Oplog_Experimental.png index c4ecdbdb744..aee3032af71 100644 Binary files a/documentation/docs/images/PMM_Mongodb_Collections_Oplog_Experimental.png and b/documentation/docs/images/PMM_Mongodb_Collections_Oplog_Experimental.png differ diff --git a/documentation/docs/images/PMM_Mongodb_Collections_Overview_Experime.png b/documentation/docs/images/PMM_Mongodb_Collections_Overview_Experime.png new file mode 100644 index 00000000000..805efe60f1b Binary files /dev/null and b/documentation/docs/images/PMM_Mongodb_Collections_Overview_Experime.png differ diff --git a/documentation/docs/images/PMM_Mongodb_Collections_Overview_Experimental.png b/documentation/docs/images/PMM_Mongodb_Collections_Overview_Experimental.png index 8f59a54242d..1cb90bcc31c 100644 Binary files a/documentation/docs/images/PMM_Mongodb_Collections_Overview_Experimental.png and b/documentation/docs/images/PMM_Mongodb_Collections_Overview_Experimental.png differ diff --git a/documentation/docs/images/PMM_MySQL_Amazon_Aurora_Details_full.jpg b/documentation/docs/images/PMM_MySQL_Amazon_Aurora_Details_full.jpg index 4857bb14f1b..7609ef580ea 100644 Binary files a/documentation/docs/images/PMM_MySQL_Amazon_Aurora_Details_full.jpg and b/documentation/docs/images/PMM_MySQL_Amazon_Aurora_Details_full.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Command_Handler_Counters_Compare.jpg b/documentation/docs/images/PMM_MySQL_Command_Handler_Counters_Compare.jpg index 38bf2b43bce..aa6a6aa6f75 100644 Binary files a/documentation/docs/images/PMM_MySQL_Command_Handler_Counters_Compare.jpg and b/documentation/docs/images/PMM_MySQL_Command_Handler_Counters_Compare.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Group_Replication_Summary.jpg b/documentation/docs/images/PMM_MySQL_Group_Replication_Summary.jpg index 4c52347f368..905efb380ae 100644 Binary files a/documentation/docs/images/PMM_MySQL_Group_Replication_Summary.jpg and b/documentation/docs/images/PMM_MySQL_Group_Replication_Summary.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_InnoDB_Compression_Details.jpg b/documentation/docs/images/PMM_MySQL_InnoDB_Compression_Details.jpg index 4f7c810d03d..9eb27446f1c 100644 Binary files a/documentation/docs/images/PMM_MySQL_InnoDB_Compression_Details.jpg and b/documentation/docs/images/PMM_MySQL_InnoDB_Compression_Details.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_InnoDB_Details.jpg b/documentation/docs/images/PMM_MySQL_InnoDB_Details.jpg index 7348f4bfee0..ca41dfa9cf2 100644 Binary files a/documentation/docs/images/PMM_MySQL_InnoDB_Details.jpg and b/documentation/docs/images/PMM_MySQL_InnoDB_Details.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Instance_Summary.jpg b/documentation/docs/images/PMM_MySQL_Instance_Summary.jpg index 6683b7f9b54..a18ce8f6e22 100644 Binary files a/documentation/docs/images/PMM_MySQL_Instance_Summary.jpg and b/documentation/docs/images/PMM_MySQL_Instance_Summary.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Instances_Compare.jpg b/documentation/docs/images/PMM_MySQL_Instances_Compare.jpg index 872db74a639..682dcf9d89a 100644 Binary files a/documentation/docs/images/PMM_MySQL_Instances_Compare.jpg and b/documentation/docs/images/PMM_MySQL_Instances_Compare.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Instances_Overview.jpg b/documentation/docs/images/PMM_MySQL_Instances_Overview.jpg index 73d41fe4db5..89a499608d3 100644 Binary files a/documentation/docs/images/PMM_MySQL_Instances_Overview.jpg and b/documentation/docs/images/PMM_MySQL_Instances_Overview.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_MyISAM_Aria_Details.jpg b/documentation/docs/images/PMM_MySQL_MyISAM_Aria_Details.jpg index 5e4f39206b1..348f6c915ec 100644 Binary files a/documentation/docs/images/PMM_MySQL_MyISAM_Aria_Details.jpg and b/documentation/docs/images/PMM_MySQL_MyISAM_Aria_Details.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_MyRocks_Details.jpg b/documentation/docs/images/PMM_MySQL_MyRocks_Details.jpg index bf78c91c77e..ede1a235781 100644 Binary files a/documentation/docs/images/PMM_MySQL_MyRocks_Details.jpg and b/documentation/docs/images/PMM_MySQL_MyRocks_Details.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Performance_Schema_Details.jpg b/documentation/docs/images/PMM_MySQL_Performance_Schema_Details.jpg index ba26f003a8a..e7339f96aff 100644 Binary files a/documentation/docs/images/PMM_MySQL_Performance_Schema_Details.jpg and b/documentation/docs/images/PMM_MySQL_Performance_Schema_Details.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Replication_Summary.jpg b/documentation/docs/images/PMM_MySQL_Replication_Summary.jpg index 0cc3e04d4b6..1567dcd5b35 100644 Binary files a/documentation/docs/images/PMM_MySQL_Replication_Summary.jpg and b/documentation/docs/images/PMM_MySQL_Replication_Summary.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Table_Details.jpg b/documentation/docs/images/PMM_MySQL_Table_Details.jpg index 3532557c172..254fbd14f5a 100644 Binary files a/documentation/docs/images/PMM_MySQL_Table_Details.jpg and b/documentation/docs/images/PMM_MySQL_Table_Details.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_User_Details.jpg b/documentation/docs/images/PMM_MySQL_User_Details.jpg index cf82c649997..a8cda88094e 100644 Binary files a/documentation/docs/images/PMM_MySQL_User_Details.jpg and b/documentation/docs/images/PMM_MySQL_User_Details.jpg differ diff --git a/documentation/docs/images/PMM_MySQL_Wait_Event_Analyses_Details.jpg b/documentation/docs/images/PMM_MySQL_Wait_Event_Analyses_Details.jpg index 0ab366e2af4..dfe3e03f3a0 100644 Binary files a/documentation/docs/images/PMM_MySQL_Wait_Event_Analyses_Details.jpg and b/documentation/docs/images/PMM_MySQL_Wait_Event_Analyses_Details.jpg differ diff --git a/documentation/docs/images/PMM_NUMA_Details.jpg b/documentation/docs/images/PMM_NUMA_Details.jpg index bf3f4399063..5d164179464 100644 Binary files a/documentation/docs/images/PMM_NUMA_Details.jpg and b/documentation/docs/images/PMM_NUMA_Details.jpg differ diff --git a/documentation/docs/images/PMM_Network_Details.jpg b/documentation/docs/images/PMM_Network_Details.jpg index 06a8ed69cbe..fc3821b0d70 100644 Binary files a/documentation/docs/images/PMM_Network_Details.jpg and b/documentation/docs/images/PMM_Network_Details.jpg differ diff --git a/documentation/docs/images/PMM_Node_Summary.jpg b/documentation/docs/images/PMM_Node_Summary.jpg index 4fff33df378..8852e2b53d8 100644 Binary files a/documentation/docs/images/PMM_Node_Summary.jpg and b/documentation/docs/images/PMM_Node_Summary.jpg differ diff --git a/documentation/docs/images/PMM_Node_Temperature_Details.jpg b/documentation/docs/images/PMM_Node_Temperature_Details.jpg index 175bbbeb208..bdeb9ce3098 100644 Binary files a/documentation/docs/images/PMM_Node_Temperature_Details.jpg and b/documentation/docs/images/PMM_Node_Temperature_Details.jpg differ diff --git a/documentation/docs/images/PMM_Nodes_Compare.jpg b/documentation/docs/images/PMM_Nodes_Compare.jpg index 2882cf98b38..5e20740db01 100644 Binary files a/documentation/docs/images/PMM_Nodes_Compare.jpg and b/documentation/docs/images/PMM_Nodes_Compare.jpg differ diff --git a/documentation/docs/images/PMM_Nodes_Overview.jpg b/documentation/docs/images/PMM_Nodes_Overview.jpg index 93b5cb9312d..174925c9653 100644 Binary files a/documentation/docs/images/PMM_Nodes_Overview.jpg and b/documentation/docs/images/PMM_Nodes_Overview.jpg differ diff --git a/documentation/docs/images/PMM_PXC_Galera_Node_Summary.jpg b/documentation/docs/images/PMM_PXC_Galera_Node_Summary.jpg index 9d58cb37b85..c261e9b1a64 100644 Binary files a/documentation/docs/images/PMM_PXC_Galera_Node_Summary.jpg and b/documentation/docs/images/PMM_PXC_Galera_Node_Summary.jpg differ diff --git a/documentation/docs/images/PMM_PXC_Galera_Nodes_Compare_full.jpg b/documentation/docs/images/PMM_PXC_Galera_Nodes_Compare_full.jpg index 15d979dadfa..3cc77ee0bdf 100644 Binary files a/documentation/docs/images/PMM_PXC_Galera_Nodes_Compare_full.jpg and b/documentation/docs/images/PMM_PXC_Galera_Nodes_Compare_full.jpg differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Checkpoints_Buffers_WAL.png b/documentation/docs/images/PMM_PostgreSQL_Checkpoints_Buffers_WAL.png index cbf1cd2b8c5..983994a2df6 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_Checkpoints_Buffers_WAL.png and b/documentation/docs/images/PMM_PostgreSQL_Checkpoints_Buffers_WAL.png differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Instance_Summary.jpg b/documentation/docs/images/PMM_PostgreSQL_Instance_Summary.jpg index 3df8e25b175..378641dcfbe 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_Instance_Summary.jpg and b/documentation/docs/images/PMM_PostgreSQL_Instance_Summary.jpg differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Instances_Compare.jpg b/documentation/docs/images/PMM_PostgreSQL_Instances_Compare.jpg index e7eda842cd5..2048e5a9c78 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_Instances_Compare.jpg and b/documentation/docs/images/PMM_PostgreSQL_Instances_Compare.jpg differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Instances_Overview.jpg b/documentation/docs/images/PMM_PostgreSQL_Instances_Overview.jpg index 0e356220161..56d73f62308 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_Instances_Overview.jpg and b/documentation/docs/images/PMM_PostgreSQL_Instances_Overview.jpg differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Instances_Overview_Extended.png b/documentation/docs/images/PMM_PostgreSQL_Instances_Overview_Extended.png index ec10a4ab87d..0013d969ba6 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_Instances_Overview_Extended.png and b/documentation/docs/images/PMM_PostgreSQL_Instances_Overview_Extended.png differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Patroni_Details.png b/documentation/docs/images/PMM_PostgreSQL_Patroni_Details.png index 3b651741a0f..6992d0baa24 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_Patroni_Details.png and b/documentation/docs/images/PMM_PostgreSQL_Patroni_Details.png differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Replication_Overview.png b/documentation/docs/images/PMM_PostgreSQL_Replication_Overview.png index 2ddd0bdf8f0..f8d93f14da6 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_Replication_Overview.png and b/documentation/docs/images/PMM_PostgreSQL_Replication_Overview.png differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Top_Queries.png b/documentation/docs/images/PMM_PostgreSQL_Top_Queries.png index 2a69de27ad8..f093f8de245 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_Top_Queries.png and b/documentation/docs/images/PMM_PostgreSQL_Top_Queries.png differ diff --git a/documentation/docs/images/PMM_PostgreSQL_vacuum_monitor-experimental.png b/documentation/docs/images/PMM_PostgreSQL_vacuum_monitor-experimental.png index b6161ac29a3..ce19682a18a 100644 Binary files a/documentation/docs/images/PMM_PostgreSQL_vacuum_monitor-experimental.png and b/documentation/docs/images/PMM_PostgreSQL_vacuum_monitor-experimental.png differ diff --git a/documentation/docs/images/PMM_Processes_Details.jpg b/documentation/docs/images/PMM_Processes_Details.jpg index dd9783307e8..e81d91f9d50 100644 Binary files a/documentation/docs/images/PMM_Processes_Details.jpg and b/documentation/docs/images/PMM_Processes_Details.jpg differ diff --git a/documentation/docs/images/PMM_Prometheus_Exporter_Status_full.jpg b/documentation/docs/images/PMM_Prometheus_Exporter_Status_full.jpg index f4824e512ac..087b60b3b47 100644 Binary files a/documentation/docs/images/PMM_Prometheus_Exporter_Status_full.jpg and b/documentation/docs/images/PMM_Prometheus_Exporter_Status_full.jpg differ diff --git a/documentation/docs/images/PMM_Prometheus_Exporters_Overview.jpg b/documentation/docs/images/PMM_Prometheus_Exporters_Overview.jpg index 28e00533ac3..f6fc1015854 100644 Binary files a/documentation/docs/images/PMM_Prometheus_Exporters_Overview.jpg and b/documentation/docs/images/PMM_Prometheus_Exporters_Overview.jpg differ diff --git a/documentation/docs/images/PMM_Settings_Percona_Platform_Login.png b/documentation/docs/images/PMM_Settings_Percona_Platform_Login.png index 5d8e0285fc3..fc3b2f0801c 100644 Binary files a/documentation/docs/images/PMM_Settings_Percona_Platform_Login.png and b/documentation/docs/images/PMM_Settings_Percona_Platform_Login.png differ diff --git a/documentation/docs/images/PMM_Settings_SSH_Key.jpg b/documentation/docs/images/PMM_Settings_SSH_Key.jpg index 2cda5badaec..3cfb9cb40dd 100644 Binary files a/documentation/docs/images/PMM_Settings_SSH_Key.jpg and b/documentation/docs/images/PMM_Settings_SSH_Key.jpg differ diff --git a/documentation/docs/images/PMM_VictoriaMetrics.jpg b/documentation/docs/images/PMM_VictoriaMetrics.jpg index ab504f25283..4e687daf658 100644 Binary files a/documentation/docs/images/PMM_VictoriaMetrics.jpg and b/documentation/docs/images/PMM_VictoriaMetrics.jpg differ diff --git a/documentation/docs/images/PMM_VictoriaMetrics_Agents_Overview.jpg b/documentation/docs/images/PMM_VictoriaMetrics_Agents_Overview.jpg index 6605eaeb8d6..f52a8cd2dae 100644 Binary files a/documentation/docs/images/PMM_VictoriaMetrics_Agents_Overview.jpg and b/documentation/docs/images/PMM_VictoriaMetrics_Agents_Overview.jpg differ diff --git a/documentation/docs/images/PMM_access_control_add_labels_services.png b/documentation/docs/images/PMM_access_control_add_labels_services.png new file mode 100644 index 00000000000..b5a567b495d Binary files /dev/null and b/documentation/docs/images/PMM_access_control_add_labels_services.png differ diff --git a/documentation/docs/images/PMM_access_control_create_role.png b/documentation/docs/images/PMM_access_control_create_role.png new file mode 100644 index 00000000000..a4344e4c01e Binary files /dev/null and b/documentation/docs/images/PMM_access_control_create_role.png differ diff --git a/documentation/docs/images/Redis-Persistance-details.png b/documentation/docs/images/Redis-Persistance-details.png index c26a234e82e..8a7cae5df65 100644 Binary files a/documentation/docs/images/Redis-Persistance-details.png and b/documentation/docs/images/Redis-Persistance-details.png differ diff --git a/documentation/docs/images/Valkey_Clients_dashboard.png b/documentation/docs/images/Valkey_Clients_dashboard.png index b538b749c70..d943cbb3998 100644 Binary files a/documentation/docs/images/Valkey_Clients_dashboard.png and b/documentation/docs/images/Valkey_Clients_dashboard.png differ diff --git a/documentation/docs/images/Valkey_Command_Detail.png b/documentation/docs/images/Valkey_Command_Detail.png index 8f475b34702..a4e266231e0 100644 Binary files a/documentation/docs/images/Valkey_Command_Detail.png and b/documentation/docs/images/Valkey_Command_Detail.png differ diff --git a/documentation/docs/images/Valkey_Overview_Dashboard.png b/documentation/docs/images/Valkey_Overview_Dashboard.png index 7699e947bfb..b808fd7b9be 100644 Binary files a/documentation/docs/images/Valkey_Overview_Dashboard.png and b/documentation/docs/images/Valkey_Overview_Dashboard.png differ diff --git a/documentation/docs/images/Valkey_network.png b/documentation/docs/images/Valkey_network.png index d8eb09a6643..a5fa57c0757 100644 Binary files a/documentation/docs/images/Valkey_network.png and b/documentation/docs/images/Valkey_network.png differ diff --git a/documentation/docs/images/lbac/PMM_access_control_add_labels_services.png b/documentation/docs/images/lbac/PMM_access_control_add_labels_services.png index 738c3bbdf60..b5a567b495d 100644 Binary files a/documentation/docs/images/lbac/PMM_access_control_add_labels_services.png and b/documentation/docs/images/lbac/PMM_access_control_add_labels_services.png differ diff --git a/documentation/docs/images/lbac/PMM_access_control_create_role.png b/documentation/docs/images/lbac/PMM_access_control_create_role.png index 0e640b0ee0a..423f5252a94 100644 Binary files a/documentation/docs/images/lbac/PMM_access_control_create_role.png and b/documentation/docs/images/lbac/PMM_access_control_create_role.png differ diff --git a/documentation/docs/images/lbac/PMM_access_control_select_role b/documentation/docs/images/lbac/PMM_access_control_select_role new file mode 100644 index 00000000000..05ef5dd4e00 --- /dev/null +++ b/documentation/docs/images/lbac/PMM_access_control_select_role @@ -0,0 +1,12 @@ +# Assign access roles to users + +To assign access roles to users: +{.power-number} + +1. From the [main menu](../../../reference/ui/ui_components.md), go to **Configuration > Settings > Advanced Settings** and enable the **Access control** option. +2. Go to **Users and access > Users**. +3. Click on the user you want to assign roles to. +4. From the **Access Role** drop-down select the appropriate roles. +5. Verify the assigned roles appear in the **Access Role** column. + +![PMM Access Control - Assign role](../../images/lbac/PMM_access_control_select_role.png) \ No newline at end of file diff --git a/documentation/docs/images/lbac/PMM_access_control_select_role.png b/documentation/docs/images/lbac/PMM_access_control_select_role.png index 4164bd57d7b..82b24d4fea6 100644 Binary files a/documentation/docs/images/lbac/PMM_access_control_select_role.png and b/documentation/docs/images/lbac/PMM_access_control_select_role.png differ diff --git a/documentation/docs/images/metrics-monitor.advanced-data-exploration.node-memory-numa.png b/documentation/docs/images/metrics-monitor.advanced-data-exploration.node-memory-numa.png index 37e6a20f18c..27dfe650fb7 100644 Binary files a/documentation/docs/images/metrics-monitor.advanced-data-exploration.node-memory-numa.png and b/documentation/docs/images/metrics-monitor.advanced-data-exploration.node-memory-numa.png differ diff --git a/documentation/docs/images/native_sidebar.png b/documentation/docs/images/native_sidebar.png new file mode 100644 index 00000000000..465f6448946 Binary files /dev/null and b/documentation/docs/images/native_sidebar.png differ diff --git a/documentation/docs/images/valkey-load.png b/documentation/docs/images/valkey-load.png index 9dbfe42b730..4a471f504c2 100644 Binary files a/documentation/docs/images/valkey-load.png and b/documentation/docs/images/valkey-load.png differ diff --git a/documentation/docs/images/valkey_cluster_details.png b/documentation/docs/images/valkey_cluster_details.png index c0d2f9a624b..0b426fbbc3a 100644 Binary files a/documentation/docs/images/valkey_cluster_details.png and b/documentation/docs/images/valkey_cluster_details.png differ diff --git a/documentation/docs/images/valkey_memory.png b/documentation/docs/images/valkey_memory.png index 2183f75e7da..ead6cb3c145 100644 Binary files a/documentation/docs/images/valkey_memory.png and b/documentation/docs/images/valkey_memory.png differ diff --git a/documentation/docs/images/valkey_replication.png b/documentation/docs/images/valkey_replication.png index f0deb8590a6..2385764a835 100644 Binary files a/documentation/docs/images/valkey_replication.png and b/documentation/docs/images/valkey_replication.png differ diff --git a/documentation/docs/images/valkey_slowlog.png b/documentation/docs/images/valkey_slowlog.png index 9ecaddfe9ae..2b4f6243a39 100644 Binary files a/documentation/docs/images/valkey_slowlog.png and b/documentation/docs/images/valkey_slowlog.png differ diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql/mysql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql/mysql.md index 3171cb9dc4d..d29c1730e37 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql/mysql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql/mysql.md @@ -666,7 +666,6 @@ Once the service is confirmed as active, verify that metrics are being properly - [Running custom MySQL queries in PMM][BLOG_CUSTOM_QUERIES_MYSQL] [DASH_MYSQLUSERDETAILS]: ../../../../reference//dashboards/dashboard-mysql-user-details.md -[DASH_PXCGALERACLUSTER]: ../../../../reference/dashboards/dashboard-pxc-galera-cluster-summary.md [LOGROTATE]: https://linux.die.net/man/8/logrotate [PERCONA_SERVER_MYSQL]: https://www.percona.com/software/mysql-database/percona-server [PERCONA_XTRADB_CLUSTER]: https://www.percona.com/software/mysql-database/percona-xtradb-cluster diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/configure_aws.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/configure_aws.md index 623e13ae5e6..89e6c4fe0ce 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/configure_aws.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/configure_aws.md @@ -81,7 +81,7 @@ sudo ufw --force enable After the initial setup, create additional user accounts in PMM for your team members. Follow the principle of least privilege when assigning user roles. {.power-number} -1. Go to **Administration > Users and access > Users**. +1. Go to **Users and access > Users**. 2. Click **New user** and configure the user with an appropriate role: - **Admin**: Full system access diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/deploy_aws.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/deploy_aws.md index f3a1d99a284..15718efb083 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/deploy_aws.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/deploy_aws.md @@ -65,15 +65,13 @@ Once your instance status shows "Running" and passes all status checks in the AW 3. Change the default credentials then use the new ones to log in to the PMM Server home page. You will reuse these credentials when configuring PMM Clients on other hosts. - ![PMM Home Dashboard](../../../../images/PMM_Home_Dashboard.png) - ## Configure PMM Server and IP settings After initial access, configure your PMM Server's security groups and IP addressing. ### SSH access For SSH access instructions, see [Connecting to Your Linux Instance Using SSH](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html). -Replace the user name `ec2-user` with `admin`. You can also add SSH keys later through the **PMM Configuration > Settings > SSH Key** page. +Replace the user name `ec2-user` with `admin`. You can also add SSH keys later through the **Configuration > Settings > SSH Key** page. ## Next steps diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md index 99c2481d134..e120e3dcff2 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md @@ -134,7 +134,7 @@ After basic installation, you may want to customize your PMM Server setup: - Disable the upgrade panel if needed: - **via Docker**: add `-e PMM_ENABLE_UPDATES=false` to the `docker run` command (for the life of the container) - - **via UI**: go to **PMM Configuration > Settings > Advanced Settings** and disable **Check for Updates** (can be turned back on by any admin in the UI) + - **via UI**: go to **Configuration > Settings > Advanced Settings** and disable **Check for Updates** (can be turned back on by any admin in the UI) - Enable HTTP (insecure, NOT recommended): add `--publish 80:8080` to the `docker run` command. diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/run_with_host_dir.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/run_with_host_dir.md index fef8cb5fab2..5d557bd64d6 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/run_with_host_dir.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/run_with_host_dir.md @@ -64,7 +64,7 @@ docker volume create pmm-data ``` 2. Copy data from host directory to the volume: ```sh - docker run --rm -v /path/on/host:/source -v pmm-data:/target alpine cp -a /source/. /target/ +docker run --rm -v /path/on/host:/source -v pmm-data:/target alpine cp -a /source/. /target/ ``` 3. Update your container to use the volume instead of the host directory. diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/podman/index.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/podman/index.md index 09013171586..268105bb191 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/podman/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/podman/index.md @@ -69,7 +69,8 @@ When you initiate an update in the UI with Podman: This method enables updates through the PMM web interface using Watchtower and systemd services. When you initiate an update in the UI, PMM Server updates its image reference, prompting Watchtower to pull the new image. Watchtower then stops the existing container, and systemd automatically restarts it with the updated image. - + {.power-number} + 1. Create directories for configuration files if they don't exist: ```sh diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/login_UI.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/login_UI.md index 82281fba6c4..36939bea78f 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/login_UI.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/login_UI.md @@ -7,13 +7,13 @@ To log in to the PMM user interface: 1. Open a web browser and visit the guest IP address. Your browser may display a security warning about an untrusted certificate. This is expected with the default self-signed certificate. You can safely proceed to the website. -2. The PMM [login screen](../../../../reference/ui/log_in.md) appears. +2. The PMM [Log in screen](../../../../reference/ui/log_in.md) appears. 3. On the login screen, enter the default credentials: `admin`/`admin`. 4. (Recommended) Follow the prompts to change the default password. You also can change the default password through SSH by using the `change-admin-password` command. -5. The PMM Home Dashboard appears. +5. The PMM Home dashboard appears. ??? info "(Optional) Change root password from UI" You can change the root password directly from the user interface: @@ -39,7 +39,7 @@ To log in to the PMM user interface: 2. Log into the PMM user interface. - 3. Select **PMM Configuration > Settings > SSH Key**. + 3. Select **Configuration > Settings > SSH Key**. 4. Copy and paste the contents of the `admin.pub` file into the **SSH Key** field. diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/remove_virtual_machine.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/remove_virtual_machine.md index dc171211965..abaeba39671 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/remove_virtual_machine.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/remove_virtual_machine.md @@ -19,7 +19,7 @@ To remove a PMM Server virtual machine from VirtualBox: {.power-number} 1. Select the PMM Server VM in the VirtualBox Manager and right-click and select **Close > Power Off**. -2. Right-click on the powered-off VM and select **Remove** . +2. Right-click on the powered-off VM and select **Remove**. 3. Choose **Delete all files** to remove the VM and its disk images, then click **Remove** to confirm. ## Verify removal diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/ssh.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/ssh.md index 548e18d5412..765a495e7f5 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/ssh.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/ssh.md @@ -10,7 +10,7 @@ To configure SSH access: {.power-number} 1. Enter your **public key** in the **SSH Key** field. -2. Click **Apply SSH Key**. +2. Click **Apply SSH key**. This adds the key to the virtual machine so you can connect to your PMM Server instance via SSH. diff --git a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md index 0d05d73c556..dc27ec803aa 100644 --- a/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md +++ b/documentation/docs/pmm-upgrade/migrating_from_pmm_2.md @@ -280,7 +280,7 @@ Before migrating PMM 2 to PMM 3, ensure your PMM 2 Server is running the latest ## Step 3: Migrate PMM 2 Clients to PMM 3 !!! caution alert alert-warning "Important" - PMM 3 Server provides limited support for PMM 2 Clients (metrics and Query Analytics only). This support will be removed in PMM 3.3. + PMM 2 Clients are deprecated. Compatibility with PMM Server 3.4.0 and later is not guaranteed, and transitional support will be removed in a future release. Upgrade to PMM 3 Client as soon as possible to ensure full functionality. Depending on your initial installation method, update PMM Clients using your operating system's package manager or using a tarball. For detailed instructions, see the [Upgrade PMM Client topic](../pmm-upgrade/upgrade_client.md). @@ -312,7 +312,7 @@ PMM 3 replaces API keys with service accounts to enhance security and simplify a ### Verify the conversion -To verify that API keys were successfully migrated, go to **Administration > Users and Access > Service Accounts**, where you can check the list of service accounts available and confirm that the **API Keys** menu is no longer displayed. +To verify that API keys were successfully migrated, go to **Users and Access > Service accounts**, where you can check the list of service accounts available and confirm that the **API Keys** menu is no longer displayed. If any API keys fail to migrate, you can either: @@ -324,11 +324,10 @@ If any API keys fail to migrate, you can either: After you finish migrating PMM: {.power-number} -1. Verify that all PMM Clients are up to date by checking **PMM Configuration > Updates**. -2. Confirm all previously monitored services are reporting correctly to the new PMM 3 Server by reviewing **Configuration > PMM Inventory > Services**. +1. Verify that all PMM Clients are up to date by checking **Configuration > Updates**. +2. Confirm all previously monitored services are reporting correctly to the new PMM 3 Server by reviewing **Inventory > Services**. 3. Check the dashboards to make sure you're receiving the metrics and QAN data. - ### Variables for migrating from PMM v2 to PMM v3 When migrating from PMM v2 to PMM v3, you'll need to update your environment variables to match the new naming convention. This is because PMM v3 introduces several important changes to improve consistency and clarity: diff --git a/documentation/docs/pmm-upgrade/migrating_from_vmware.md b/documentation/docs/pmm-upgrade/migrating_from_vmware.md index e9d5cb79f4f..eeb236bf975 100644 --- a/documentation/docs/pmm-upgrade/migrating_from_vmware.md +++ b/documentation/docs/pmm-upgrade/migrating_from_vmware.md @@ -13,7 +13,7 @@ Before starting the migration: ### Platform-specific prerequisites -=== " For Docker/Podman" +=== "For Docker/Podman" - Confirm Docker/Podman installation and sufficient disk space - Ensure port `443` availability @@ -61,7 +61,7 @@ To migrate away from VMware: 4. Export custom configurations to save them before migration: - - **Dashboards**: navigate to each custom dashboards, click the share icon and select **Export > Save to file**. + - **Dashboards**: navigate to each custom dashboards, click the share icon and select **Export > Export as JSON > Download file**. - **Alert rules**: go to **Alerting > Alert rules** and copy the configuration details or take screenshots of each rule. Alternatively, export all rules via the PMM API: ```bash curl -k -u admin: https:///graph/api/ruler/grafana/api/v1/rules diff --git a/documentation/docs/pmm-upgrade/ui_upgrade.md b/documentation/docs/pmm-upgrade/ui_upgrade.md index 8e7af0fb254..6736e943773 100644 --- a/documentation/docs/pmm-upgrade/ui_upgrade.md +++ b/documentation/docs/pmm-upgrade/ui_upgrade.md @@ -15,9 +15,9 @@ If Watchtower is not installed, the UI upgrade options will not be available. Se The preferred and simplest way to update PMM v3 Server is via the **Updates** page: {.power-number} -1. Go to **PMM Configuration > Updates** in your PMM web interface. Here you can check the current PMM Server version, the timestamp of the last update check and whether your instance is up-to-date. +1. Go to **Configuration > Updates** in your PMM web interface. Here you can check the current PMM Server version, the timestamp of the last update check and whether your instance is up-to-date. -2. If an update is available, click the **Update now** button to install the latest version. +2. Click Check Updates now If an update is available, click the **Update now** button to install the latest version. ![Update page](../images/Update_page.png) diff --git a/documentation/docs/pmm-upgrade/upgrade_aws.md b/documentation/docs/pmm-upgrade/upgrade_aws.md index 79cc02ef984..c23a438b39f 100644 --- a/documentation/docs/pmm-upgrade/upgrade_aws.md +++ b/documentation/docs/pmm-upgrade/upgrade_aws.md @@ -20,16 +20,16 @@ To upgrade PMM Server on AWS: aws ec2 create-snapshot --volume-id vol-xxxxxxxxx --description "Pre-upgrade backup $(date)" ``` -2. Go to **PMM Configuration > Updates** and click **Update now** if a newer version is available. +2. Go to **Configuration > Updates > Check updates now** and click **Upgrade now** if a newer version is available. ## Post-upgrade tasks After upgrading PMM Server: {.power-number} -1. Go to **Dashboards > Experimental > PMM Health** and check that all services are running. +1. Go to **All Dashboards > Experimental > PMM Health** and check that all services are running. -2. Go to **PMM Configuration > Inventory > Services** and verify that all monitored nodes and services are listed, their status is **Up**. +2. Go to **Inventory > Services** and verify that all monitored nodes and services are listed, their status is **Up**. 3. Test monitoring functionality to ensure data collection continues normally. diff --git a/documentation/docs/pmm-upgrade/upgrade_docker.md b/documentation/docs/pmm-upgrade/upgrade_docker.md index b22d354b2f1..cd019ebc8f0 100644 --- a/documentation/docs/pmm-upgrade/upgrade_docker.md +++ b/documentation/docs/pmm-upgrade/upgrade_docker.md @@ -7,7 +7,7 @@ Before starting the upgrade, complete these preparation steps to ensure you can 1. [Create a backup](../install-pmm/install-pmm-server/deployment-options/docker/backup_container.md) before upgrading, as downgrades are not possible. Therefore, reverting to a previous version requires an backup made prior to the upgrade. -2. Verify your current PMM version: Check your current PMM version by navigating to **PMM Configuration > Updates** or by running the following command: +2. Verify your current PMM version: Check your current PMM version by navigating to **Configuration > Updates** or by running the following command: ```sh docker exec -it pmm-server curl -ku admin:admin https://localhost:8443/v1/version @@ -48,5 +48,5 @@ Follow these steps to upgrade your PMM Server while preserving your monitoring d percona/pmm-server:3 ``` -5. After upgrading, verify that PMM Server is running correctly and all your data is accessible. You can always [rerestore your PMM Server](../install-pmm/install-pmm-server/deployment-options/docker/restore_container.md) using the backup you created above. +5. After upgrading, verify that PMM Server is running correctly and all your data is accessible. You can always [restore your PMM Server](../install-pmm/install-pmm-server/deployment-options/docker/restore_container.md) using the backup you created above. diff --git a/documentation/docs/reference/PMM_NUMA_Details.jpg b/documentation/docs/reference/PMM_NUMA_Details.jpg new file mode 100644 index 00000000000..0afe8e2941a Binary files /dev/null and b/documentation/docs/reference/PMM_NUMA_Details.jpg differ diff --git a/documentation/docs/reference/dashboards/dashboard-environment-summary.md b/documentation/docs/reference/dashboards/dashboard-environment-summary.md deleted file mode 100644 index 0429b6bbceb..00000000000 --- a/documentation/docs/reference/dashboards/dashboard-environment-summary.md +++ /dev/null @@ -1,8 +0,0 @@ -# Environment 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. - -![!image](../../images/PMM_Experimental_Environment_Summary_Dashboard.png) - -The Environment Summary Dashboard provides an at-a-glance view specific to the selected environment in PMM, including an overview of the services and nodes running in that environment. diff --git a/documentation/docs/reference/dashboards/dashboard-mongodb-experimental_collection_details.md b/documentation/docs/reference/dashboards/dashboard-mongodb-experimental_collection_details.md deleted file mode 100644 index 2e05b6891ef..00000000000 --- a/documentation/docs/reference/dashboards/dashboard-mongodb-experimental_collection_details.md +++ /dev/null @@ -1,8 +0,0 @@ -# Experimental MongoDB Collection Details - -!!! 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. - -This realtime experimental dashboard provides detailed information about the top collections by document count, size, and document read for MongoDB databases. - -![!image](../../images/PMM_Mongodb_Collections_Details_Experimental.png) diff --git a/documentation/docs/reference/dashboards/dashboard-mysql-tokudb-details.md b/documentation/docs/reference/dashboards/dashboard-mysql-tokudb-details.md deleted file mode 100644 index 7e886beb991..00000000000 --- a/documentation/docs/reference/dashboards/dashboard-mysql-tokudb-details.md +++ /dev/null @@ -1,3 +0,0 @@ -# MySQL TokuDB Details - -![!image](../../images/PMM_MySQL_TokuDB_Details.jpg) diff --git a/documentation/docs/reference/dashboards/dashboard-pxc-galera-cluster-summary.md b/documentation/docs/reference/dashboards/dashboard-pxc-galera-cluster-summary.md deleted file mode 100644 index 7a337bae34c..00000000000 --- a/documentation/docs/reference/dashboards/dashboard-pxc-galera-cluster-summary.md +++ /dev/null @@ -1,3 +0,0 @@ -# PXC/Galera Cluster Summary - -![!image](../../images/PMM_PXC_Galera_Cluster_Summary.jpg) diff --git a/documentation/docs/reference/dashboards/kubernetes_cluster_summary.md b/documentation/docs/reference/dashboards/kubernetes_cluster_summary.md index 916cca77c0b..f16bdf17cb4 100644 --- a/documentation/docs/reference/dashboards/kubernetes_cluster_summary.md +++ b/documentation/docs/reference/dashboards/kubernetes_cluster_summary.md @@ -1,21 +1,95 @@ -# Kubernetes Cluster Summary +# Kubernetes Cluster Overview !!! 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. +This dashboard provides a comprehensive view of your Kubernetes cluster's health, resource utilization, and workload status. + ![!image](../../images/PMM_K8s_volume.png) -*Kubernetes Volumes* dashboard provides a comprehensive overview of your Kubernetes cluster, including: +## Overview + +The overview section displays critical cluster metrics including node count, pod status, CPU and memory capacity, and resource utilization percentages. These metrics update in real-time to help you quickly assess cluster health and identify potential issues. + +### Total Nodes +Displays the total number of nodes in the Kubernetes cluster. This metric helps you track cluster size and capacity planning. + +### Not Ready Nodes +Shows the number of nodes that are not in Ready state. The gauge turns yellow when any node is not ready, alerting you to potential infrastructure problems that could affect workload availability. + +### Total Pods +Displays the total number of pods across all namespaces in the cluster. Use this to monitor overall workload deployment and cluster utilization. + +### Not Running Pods +Shows the count of pods not in Running or Succeeded status. The gauge turns yellow when pods are detected in Failed, Pending, or other non-healthy states, helping you quickly identify application deployment issues. + +### CPU Capacity +Displays the total CPU cores available across all nodes in the cluster. This helps you understand the maximum computational resources available for workload scheduling. + +### CPU Requests +Shows how many CPU cores have been requested by all containers. This metric indicates how much CPU capacity has been reserved by workloads, helping you assess resource allocation. + +### CPU Requests % +Visualizes the percentage of total CPU capacity that has been requested by containers. The gauge changes from green to yellow at 70% and red at 90%, warning you when CPU allocation is approaching cluster limits and new workloads may face scheduling difficulties. + +### CPU Limits +Displays the sum of CPU core limits set for all containers in the cluster. This shows the maximum CPU that containers can consume if available, which may exceed actual cluster capacity. + +### Percona Clusters +Shows the total number of Percona database clusters (Custom Resources) deployed in the cluster, including PXC, Percona Server for MongoDB, and Percona Distribution for PostgreSQL. Use this to monitor your database infrastructure at a glance. + +### Percona Clusters Not Ready +Displays the number of Percona clusters not in Ready state. The gauge turns yellow when any cluster is unhealthy, alerting you to database availability issues. + +### Memory Capacity +Displays the total memory (RAM) available across all nodes in the cluster, helping you understand the maximum memory resources available for workload scheduling. + +### Memory Requests +Shows how many memory bytes have been requested by all containers. This indicates how much memory capacity has been reserved by workloads. + +### Memory Requests % +Visualizes the percentage of total memory capacity that has been requested by containers. The gauge changes from green to yellow at 70% and red at 90%, warning when memory allocation is approaching cluster limits. + +### Memory Limits +Displays the sum of memory limits set for all containers. This shows the maximum memory that containers can consume if available, which may exceed actual cluster capacity. + +## Cluster + +### Node Status + +Tracks the health of all nodes in the cluster over time, displaying various node conditions. Green lines indicate healthy Ready nodes, while other colors represent different node conditions like MemoryPressure, DiskPressure, or NetworkUnavailable. Use this to monitor node stability, identify patterns in node failures, and track infrastructure issues over time. + +### Pod Status + +Shows the status of all pods in the cluster over time, categorized by phase. Green represents Running pods, while other colors indicate different states like Pending, Failed, or Succeeded. This helps you monitor overall application health, spot deployment issues, and track pod lifecycle patterns. + +### Percona Custom Resources - Clusters + +Monitors the health of Percona database clusters deployed via Custom Resources. Green lines indicate clusters in Ready state, while orange represents Error states. Use this to track database cluster availability, identify unhealthy clusters, and monitor database infrastructure stability. + +### Percona Custom Resources - Backups + +Tracks the status of Percona database backups over time, showing backup states across all deployed database types. Use this to monitor backup health, ensure backups are completing successfully, and identify backup failures that could affect disaster recovery capabilities. + +### Percona Custom Resources - Backups (Table) + +Lists all Percona database backups with their current state, namespace, and type. The table shows only active backups (state = 1) and displays "No backups were created for databases" when no backups exist. Use this for detailed backup inventory and troubleshooting specific backup issues. + +### PV and PVC Status + +Displays the status of Persistent Volumes (PV) and Persistent Volume Claims (PVC) over time. Shows volumes in different states like Bound, Pending, or Failed. Use this to monitor storage provisioning, identify storage issues, and ensure applications have access to required persistent storage. + +### Storage Class + +Lists all storage classes available in the cluster with their provisioners, reclaim policies, and binding modes. Shows "Can't find any storage classes" when none exist. Use this to understand available storage options, verify storage configuration, and troubleshoot persistent volume provisioning issues. + +## Custer - Compute Network -- 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 +### CPU and Memory % -With this dashboard, you can view all workloads running in the cluster and optimize their performance. +Tracks CPU and memory resource utilization as percentages of total cluster capacity over time. Displays both requests (reserved resources) and limits (maximum allowed) for CPU and memory. Use this to monitor resource consumption trends, identify capacity constraints, plan cluster scaling, and ensure efficient resource allocation across workloads. +## Cluster Network +Visualizes network traffic across the cluster, showing both received (incoming) and sent (outgoing) data rates in bytes per second. Use this to monitor network utilization, identify unusual traffic spikes, detect potential DDoS attacks or misconfigurations, and plan network capacity upgrades. \ No newline at end of file diff --git a/documentation/docs/reference/ui/timezone.md b/documentation/docs/reference/ui/timezone.md index 92917425334..229f2a1a400 100644 --- a/documentation/docs/reference/ui/timezone.md +++ b/documentation/docs/reference/ui/timezone.md @@ -5,6 +5,6 @@ By default Grafana uses the timezone from your web browser. However, you can cha To set the timezone: {.power-number} -1. On the left menu, hover your cursor over your avatar and then click **Preferences**. -2. Click to select an option in the **Timezone list**. +1. On the main menu, go to **Account > Profile > Preferences**. +2. Click to select an option in the **Timezone**. 3. Click **Save**. diff --git a/documentation/docs/reference/ui/ui_components.md b/documentation/docs/reference/ui/ui_components.md index 95e5da3cd27..8354941b1c1 100644 --- a/documentation/docs/reference/ui/ui_components.md +++ b/documentation/docs/reference/ui/ui_components.md @@ -6,11 +6,11 @@ Here's how the UI is laid out, and what the controls do: ![PMM Interface with numbered components](../../images/PMM_Home_Dashboard_Numbered.png) -1. [Main menu](#1-main-menu) (also called Grafana menu or side menu) +1. [Main menu](#1-main-menu) (also called the side menu) 2. [Top navigation bar](#2-top-navigation-bar) -3. [View controls](#3-view-controls) -4. [View selectors](#4-view-selectors) -5. [Shortcut menu](#5-shortcut-menu) +3. [Dashboard actions](#3-dashboard-actions) +4. [View controls](#4-view-controls) +5. [View selectors](#5-view-selectors) ## 1. Main menu @@ -18,22 +18,21 @@ You'll find these options in the left-side menu: | Icon | Name | What you can do | |:----:|------|-----------------| -| | Home | Access the main dashboard with overview panels for database connections, queries, anomaly detection, and upgrade status. | -| | Bookmarks | Create personal navigation shortcuts to any page in PMM. Bookmarks are private to your account and can include dashboards, settings pages, or any other PMM page for quick access. | -| | Starred | Mark important dashboards as favorites. Starred dashboards can be set as your home page and are visible to all users, helping teams identify important monitoring views. | -| | Dashboards | Create and organize dashboards, create [folders](../../use/dashboards-panels/manage-dashboards/create-folders.md), import dashboards, create playlists, and manage snapshots. | -| | Operating System (OS) | Monitor server-level metrics including CPU, memory, disk, and network performance. | +| :material-home-outline: | Home | Access the main dashboard with overview panels for database connections, queries, anomaly detection, and upgrade status. | | :simple-mysql: | MySQL | View specialized dashboards for MySQL database performance monitoring. | | :simple-postgresql: | PostgreSQL | Access PostgreSQL-specific monitoring dashboards and metrics. | -| | Query Analytics (QAN) | Analyze database queries over time, identify slow queries, optimize performance, and troubleshoot issues. | -| | Explore | Run ad-hoc queries with [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) to investigate specific metrics without creating dashboards. | -| | Drilldown | Run detailed analysis with specialized views for database metrics. This enables you to dive deeper into specific metrics by clicking through related data points and exploring underlying patterns. Learn more about drilling down into metrics in the [Grafana documentation](https://grafana.com/docs/grafana/latest/explore/simplified-exploration/metrics/drill-down-metrics/). | -| | Backup | Configure and manage your [database backups](../../backup/index.md) and storage locations. | -| | Advisors | Run health assessment checks on your databases and view recommendations for improving performance. | -| | Alerting | Create and manage [alerts](../../alert/index.md) that notify you when metrics exceed thresholds. | -| | PMM Configuration | Configure PMM-specific settings and manage your monitored database inventory. | -| | Connections | Set up and manage data sources to integrate additional metrics into PMM. | -| | Administration | Access Grafana-specific settings for users, permissions, plugins, and system maintenance. | +| :material-monitor-dashboard:| Operating System | Monitor server-level metrics including CPU, memory, disk, and network performance. | +| :material-view-grid-outline:| All Dashboards | Create and organize dashboards, create [folders](../../use/dashboards-panels/manage-dashboards/create-folders.md), import dashboards, create playlists, and manage snapshots. | +| :material-chart-timeline-variant: | Query Analytics (QAN) | Analyze database queries over time, identify slow queries, optimize performance, and troubleshoot issues. | +| :material-compass-outline: | Explore | Run ad-hoc queries with [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) to investigate specific metrics without creating dashboards. | +| :material-bell-outline: | | Alerts | Create and manage [alerts](../../alert/index.md) that notify you when metrics exceed thresholds. | +|:material-earth: | Advisors | Run automated health checks on your databases to identify configuration issues, security vulnerabilities, and performance problems. View recommendations for optimizing your database environment.| +| :material-flask-outline:| Inventory | Run health assessment checks on your databases and view recommendations for improving performance. | +|:material-backup-restore: | Backups | Configure and manage your [database backups](../../backup/index.md) and storage locations. | +| :material-cog-outline:| Configuration | Configure PMM-specific settings and manage your monitored database inventory. | +| :material-shield-lock-outline: | Users and Access | Access Grafana-specific settings for users, permissions, plugins, and system maintenance. | +| :material-account-circle-outline:| Account | Manage your user profile settings, change your password, set notification preferences, and configure your personal PMM experience. | +| :material-help-circle-outline:| Help | Access PMM documentation, community forums, and support resources. Export diagnostic logs for troubleshooting and view version information.| ## 2. Top navigation bar @@ -41,44 +40,31 @@ The top bar helps you navigate and understand your current location: - **Dashboard title and breadcrumbs**: Shows your current location and navigation path - **Search**: Quickly find any dashboard by name -- **Keyboard shortcuts**: Access frequently used commands -- **Help**: Find documentation and support resources -- **User profile**: Manage your account settings and preferences +- **Enable kiosk mode**: Displays the current dashboard in full-screen view, hiding the sidebar and navigation elements. Press Esc to exit. +- **View shortcuts**: Access frequently used commands +- **Quick actions menu** — Provides shortcuts to common tasks without navigating through the sidebar -## 3. View controls +## 3. Dashboard actions + +- **Star**: Mark the dashboard as a favorite for quick access. +- **Make editable**: Unlock the dashboard for editing. Built-in dashboards are read-only by default. +- **Export**: Download the dashboard as a JSON file for backup or import into another PMM instance. +- **Share**: Share dashboards or panels via direct or shortened links, or export panels as rendered PNG images. + +## 4. View controls Customize how you view your dashboard data: - **Time range selector**: Focus on specific time periods (last hour, day, week) - **Refresh button**: Manually update dashboard data or set automatic refresh intervals -- **View mode**: Toggle between different display modes (fullscreen, TV mode) -- **Dashboard settings**: Access configuration options for the current dashboard -## 4. View selectors +## 5. View selectors Filter your monitoring data using these contextual options: - **Interval**: Control the data granularity (Auto, 1m, 5m, etc.) - **Environment**: Focus on specific deployment environments - **Node Names**: Filter metrics to specific servers -- **Service Names**: View data for particular database instances - **PMM Annotations**: Toggle visibility of important events on your timelines These selectors change based on the dashboard you're viewing, showing only relevant options. - -## 5. Shortcut menu - -Quick links to related dashboards and features: - -- **Home**: Return to the main dashboard -- **Query Analytics**: Jump to query performance analysis -- **Services**: Access service-specific dashboards -- **Compare**: View side-by-side metrics for different nodes -- **Additional shortcuts**: Based on your current context - -!!! info alert alert-info "See also" - - [How to render dashboard images](../../use/dashboards-panels/share-dashboards/share_dashboard.md#render-panel-image) - - [How to annotate special events](../../use/dashboards-panels/annotate/annotate.md) - -[grafana]: https://grafana.com/docs/grafana/latest/ -[promql]: https://prometheus.io/docs/prometheus/latest/querying/basics/ \ No newline at end of file diff --git a/documentation/docs/release-notes/3.6.0.md b/documentation/docs/release-notes/3.6.0.md index 6b59845f1fb..21898747982 100644 --- a/documentation/docs/release-notes/3.6.0.md +++ b/documentation/docs/release-notes/3.6.0.md @@ -14,7 +14,31 @@ Percona Monitoring and Management (PMM) is an open source database monitoring, m ## ✨ Release highlights -### +### New native PMM navigation and revamped user interface +The first thing you'll notice with this update is the new look-and-feel of the PMM interface. We've moved away from Grafana's built-in menus to PMM's own navigation, organized around PMM's workflows to make it easier for you to move through PMM and find what you need faster. This brings: + +- A new, always-visible sidebar that provides consistent access to all PMM features without relying on Grafana’s native menus: + + ![New native sidebar](../images/native_sidebar.png) + +- Sticky time range and variables: Selected time ranges and dashboard variables now persist when switching between dashboards, so you no longer need to reapply filters. + +- A new theme switcher in the sidebar applies Light or Dark mode to both the PMM interface and embedded dashboards. + +- Query Analytics now fully supports the light theme + +- Centralized Help & Resources: Quick access to documentation, the community forum, support contact, and feedback tools. Admin users also see **Dump** and **Logs** options. + +- New interactive onboarding tour to help first-time users explore PMM’s key features. You can start it from the Help Center’s Welcome Card or from **Useful tips > Start PMM tour**. + +- Clearer update reminders: small badges and pop-up messages so you can easily see when updates are available. + +#### You should know that: + +- The new navigation is enabled by default, and you will not be able to revert to the previous Grafana-based menus. +- If you use a custom `grafana.ini` file, add [`allow_embedding = true`](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#allow_embedding) to the `[security]` section so that the new interface can display dashboards correctly. + +For details on navigating the new interface, see [Interface overview](../reference/ui/ui_components.md) and Help Center. ## 🔒 Security updates diff --git a/documentation/docs/release-notes/image.png b/documentation/docs/release-notes/image.png new file mode 100644 index 00000000000..5a08b9eded5 Binary files /dev/null and b/documentation/docs/release-notes/image.png differ diff --git a/documentation/docs/troubleshoot/alerting_issues.md b/documentation/docs/troubleshoot/alerting_issues.md index 9e198e7c997..f23488a7deb 100644 --- a/documentation/docs/troubleshoot/alerting_issues.md +++ b/documentation/docs/troubleshoot/alerting_issues.md @@ -5,22 +5,22 @@ Percona Alerting option isn't active. {.power-number} -1. Go to **PMM Configuration > Settings > Advanced Settings**. -2. Enable **Alerting**. +1. Go to **Configuration > Settings > Advanced Settings**. +2. Enable **Percona Alerting**. ## Custom alert rule templates not migrated to Percona Alerting -After upgrading from the latest PMM 2 version to PMM 3, you will find all your alert templates under **Alerting > Alert rule templates**. +After upgrading from the latest PMM 2 version to PMM 3, you will find all your alert templates under **Alerts > Alert templates**. -If you have any templates available in the `/srv/ia/templates` folder, make sure to transfer them to `/srv/alerting/templates` as PMM 3 will look for custom templates in this location. +If you have any templates available in the `/srv/ia/templates` folder, make sure to transfer them to `/srv/alerting/templates` as PMM 3 will look for custom templates in this location. ## Unreachable external IP addresses If you get an email or page from your system that the IP is not reachable from outside my organization, do the following: -To configure your PMM Server’s Public Address, select **PMM Configuration > Settings > Advanced Settings**, and supply an address to use in your alert notifications. +To configure your PMM Server’s Public Address, select **Configuration > Settings > Advanced Settings**, and supply an address to use in your alert notifications. -## Alert Rule Templates are disabled +## Alert templates are disabled Built-in alerts are not editable, but you can copy them and edit the copies. diff --git a/documentation/docs/troubleshoot/config_issues.md b/documentation/docs/troubleshoot/config_issues.md index 96390a01cf1..a9d44f05c9f 100644 --- a/documentation/docs/troubleshoot/config_issues.md +++ b/documentation/docs/troubleshoot/config_issues.md @@ -22,12 +22,13 @@ In a browser, visit `https:///logs.zip`. **From Help menu** -To obtain the logs from the **Help** menu: +To obtain the logs: + {.power-number} -1. Select **Help** → **PMM Logs**. +1. From the main menu, choose **Help > PMM Logs > Export logs**. -2. Click **PMM Logs** to retrieve PMM diagnostics data which can be examined and shared with our support team should you need help. +2. Save the downloaded file to share with our support team if needed. ## Connection difficulties @@ -59,7 +60,7 @@ In such a scenario, use [Service Accounts](../api/authentication.md#service-acco #### PMM Server inaccessible after Docker restart on macOS Sequoia -After restarting Docker, PMM dashboard returns *"500 Internal Server Error"*. +After restarting Docker, PMM dashboard returns *500 Internal Server Error*. ##### Root cause diff --git a/documentation/docs/troubleshoot/pmm_dump.md b/documentation/docs/troubleshoot/pmm_dump.md index 5855270c3ac..eeb520739c2 100644 --- a/documentation/docs/troubleshoot/pmm_dump.md +++ b/documentation/docs/troubleshoot/pmm_dump.md @@ -34,11 +34,11 @@ The **dump.tar.gz** dump file is a .TAR archive compressed via Gzip. Here's what To create a dump of your dataset: {.power-number} -1. From the top-right corner of the PMM home page, click the question mark icon and select **Help > PMM Dump**. If you don't see PMM Dump in the menu, your user account may not have sufficient permissions. +1. From the main menu, click **Help > PMM Dump > Manage datasets**. If you don't see PMM Dump in the menu, your user account may not have sufficient permissions. 2. Click **Create dataset** to go to the **Export new dataset** page. 3. Choose the service for which you want to create the dataset or leave it empty to export all data. 4. Define the time range for the dataset. -5. Enable **Export QAN** to include Query Analytics (QAN) metrics alongside the core metrics. +5. Toggle on **Export QAN** to include Query Analytics (QAN) metrics alongside the core metrics. 7. Click **Create dataset**. This will generate a data dump file and automatically record an entry in the PMM Dump table. From there, you can use the options available in the **Options** menu to send the dump file to Percona Support or download it locally for internal usage. ## Send a data dump to Percona Support @@ -46,9 +46,9 @@ To create a dump of your dataset: If you are a Percona Customer, you can securely share PMM data dumps with Percona Support via SFTP. {.power-number} -1. From the top-right corner of the PMM home page, go to **Help > PMM Dump**. +1. From the main menu, go to **Help > PMM Dump > Manage datasets**. 2. Select the PMM dump entry which you want to send to Support. -3. In the **Options** column, expand the table row to check the PMM Service associated with the dataset, click the ellipsis (three vertical dots) and select **Send to Support**. +3. In the **Options** column, expand the table row to check the PMM Service associated with the dataset, then click the ellipsis (three vertical dots) and select **Send to Support**. 4. Fill in the [details of the SFTP server](https://percona.service-now.com/percona?id=kb_article_view&sysparm_article=KB0010247&sys_kb_id=bebd04da87e329504035b8c9cebb35a7&spa=1), then click **Send**. 5. Update your Support ticket to let Percona know that you've uploaded the dataset on the SFTP server. diff --git a/documentation/docs/troubleshoot/upgrade_issues.md b/documentation/docs/troubleshoot/upgrade_issues.md index 58062d03568..87c816804dd 100644 --- a/documentation/docs/troubleshoot/upgrade_issues.md +++ b/documentation/docs/troubleshoot/upgrade_issues.md @@ -3,13 +3,37 @@ ## PMM Server not updating correctly If the automatic update process isn't working, you can force an update using the API: +{.power-number} 1. Open your terminal. -2. Run the update command, replacing : with your credentials and with your PMM server addressЖ - - ```curl -X POST \ - --user : \ - 'http:///v1/server/updates:start' \ - -H 'Content-Type: application/json' - ``` -3. Wait 2-5 minutes and refresh the PMM Home page to verify the update. \ No newline at end of file +2. Run the update command, replacing : with your credentials and with your PMM server address: +```sh +curl -X POST \ + --user : \ + 'http:///v1/server/updates:start' \ + -H 'Content-Type: application/json' +``` +3. Wait 2-5 minutes and refresh the PMM Home page to verify the update. + +## Watchtower fails with "client version is too old" error + +When upgrading PMM Server via the UI, Watchtower may fail with the following error: + +``` +client version X.XX is too old. Minimum supported API version is X.XX, please upgrade your client to a newer version +``` + +This occurs when your Docker installation requires a newer API version than Watchtower supports. + +**Solution** +To resolve this issue: +{.power-number} + +1. Update to the latest Watchtower image: +``` +docker pull percona/watchtower:latest +``` +2. If the error persists, add the `DOCKER_API_VERSION` environment variable matching your Docker's minimum API version: +``` +-e DOCKER_API_VERSION=1.45 +``` \ No newline at end of file diff --git a/documentation/docs/uninstall-pmm/uninstall_docker.md b/documentation/docs/uninstall-pmm/uninstall_docker.md index 7a586b6d5c4..22040e4f596 100644 --- a/documentation/docs/uninstall-pmm/uninstall_docker.md +++ b/documentation/docs/uninstall-pmm/uninstall_docker.md @@ -1,4 +1,4 @@ -# Uninstall PMM client using Docker container +# Uninstall PMM Client using Docker container Completely remove the PMM Client Docker container, image, and client services configuration data. diff --git a/documentation/docs/uninstall-pmm/uninstall_helm.md b/documentation/docs/uninstall-pmm/uninstall_helm.md index b7ca9c833b3..fab9f08284e 100644 --- a/documentation/docs/uninstall-pmm/uninstall_helm.md +++ b/documentation/docs/uninstall-pmm/uninstall_helm.md @@ -13,7 +13,7 @@ Remove PMM Server deployed via Helm in a Kubernetes cluster. ## Uninstall steps -Follow these steps to completely remove PMM Server from your Kubernetes cluster. While Helm handles most of the cleanup, some resources—such as persistent volumes and secrets—must be deleted manually. +Follow these steps to completely remove PMM Server from your Kubernetes cluster. Helm removes most components, but some resources such as persistent volumes and secrets must be deleted manually. {.power-number} 1. Uninstall the `pmm` Helm release and remove all resources associated with the PMM release and the release history: diff --git a/documentation/docs/use/dashboards-panels/index.md b/documentation/docs/use/dashboards-panels/index.md index 7fb88098e2c..d8ad95739a5 100644 --- a/documentation/docs/use/dashboards-panels/index.md +++ b/documentation/docs/use/dashboards-panels/index.md @@ -130,7 +130,6 @@ Performance Monitoring and Management (PMM) offers a range of dashboards you can [VictoriaMetrics Agents Overview]: ../../reference/dashboards/dashboard-victoriametrics-agents-overview.md [PMM Inventory]: ../../use/dashboard-inventory.md [Environment Overview]: ../../reference/dashboards/dashboard-env-overview.md -[Environment Summary]: ../../reference/dashboards/dashboard-environment-summary.md [CPU Utilization Details]: ../../reference/dashboards/dashboard-cpu-utilization-details.md [Disk Details]: ../../reference/dashboards/dashboard-disk-details.md [Network Details]: ../../reference/dashboards/dashboard-network-details.md @@ -159,9 +158,7 @@ Performance Monitoring and Management (PMM) offers a range of dashboards you can [MySQL Group Replication Summary]: ../../reference/dashboards/dashboard-mysql-group-replication-summary.md [MySQL Table Details]: ../../reference/dashboards/dashboard-mysql-table-details.md [MySQL User Details]: ../../reference/dashboards/dashboard-mysql-user-details.md -[MySQL TokuDB Details]: ../../reference/dashboards/dashboard-mysql-tokudb-details.md [Experimental MongoDB Collection Overview]: ../../reference/dashboards/dashboard-mongodb-experimental_collection_overview.md -[Experimental MongoDB Collection Details]: ../../reference/dashboards/dashboard-mongodb-experimental_collection_details.md [Experimental MongoDB Oplog Details]: ../../reference/dashboards/dashboard-mongodb-experimental_oplog.md [MongoDB Cluster Summary]: ../../reference/dashboards/dashboard-mongodb-cluster-summary.md [MongoDB Instance Summary]: ../../reference/dashboards/dashboard-mongodb-instance-summary.md @@ -187,7 +184,6 @@ Performance Monitoring and Management (PMM) offers a range of dashboards you can [Valkey/Redis Replication]: ../../reference/dashboards/dashboard-valkey-redis-replication.md [Valkey/Redis Slowlog]: ../../reference/dashboards/dashboard-valkey-redis-slowlog.md [PXC/Galera Node Summary]: ../../reference/dashboards/dashboard-pxc-galera-node-summary.md -[PXC/Galera Cluster Summary]: ../../reference/dashboards/dashboard-pxc-galera-cluster-summary.md [Experimental PXC/Galera Cluster Summary]: ../../reference/dashboards/dashboard-pxc-galera-cluster-summary-experimental.md [PXC/Galera Nodes Compare]: ../../reference/dashboards/dashboard-pxc-galera-nodes-compare.md [HAProxy Instance Summary]: ../../reference/dashboards/dashboard-haproxy-instance-summary.md diff --git a/documentation/mkdocs-base.yml b/documentation/mkdocs-base.yml index 57b4c3d2660..2c74970cb9a 100644 --- a/documentation/mkdocs-base.yml +++ b/documentation/mkdocs-base.yml @@ -415,7 +415,6 @@ nav: - Percona Platform: - configure-pmm/percona_platform/integrate_with_percona_platform.md - configure-pmm/percona_platform/check_percona_platform.md - - configure-pmm/percona_platform/account-info.md - Administer: - admin/index.md - Manage users: @@ -499,7 +498,6 @@ nav: - reference/dashboards/dashboard-victoriametrics-agents-overview.md - Environments: - reference/dashboards/dashboard-env-overview.md - - reference/dashboards/dashboard-environment-summary.md - Kubernetes: - reference/dashboards/kubernetes_cluster_summary.md - reference/dashboards/kubernetes_monitor_operators.md @@ -535,10 +533,8 @@ nav: - reference/dashboards/dashboard-mysql-group-replication-summary.md - reference/dashboards/dashboard-mysql-table-details.md - reference/dashboards/dashboard-mysql-user-details.md - - reference/dashboards/dashboard-mysql-tokudb-details.md - MongoDB dashboards: - reference/dashboards/dashboard-mongodb-experimental_collection_overview.md - - reference/dashboards/dashboard-mongodb-experimental_collection_details.md - reference/dashboards/dashboard-mongodb-experimental_oplog.md - reference/dashboards/dashboard-mongodb-cluster-summary.md - reference/dashboards/dashboard-mongodb-instance-summary.md @@ -574,7 +570,6 @@ nav: - Slowlog: reference/dashboards/dashboard-valkey-redis-slowlog.md - HA dashboards: - reference/dashboards/dashboard-pxc-galera-node-summary.md - - reference/dashboards/dashboard-pxc-galera-cluster-summary.md - reference/dashboards/dashboard-pxc-galera-cluster-summary-experimental.md - reference/dashboards/dashboard-pxc-galera-nodes-compare.md - reference/dashboards/dashboard-haproxy-instance-summary.md