Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc changes for PMM3 Beta #1276

Merged
merged 88 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
cdcc830
PMM-13020
catalinaadam Jul 5, 2024
bd7cf1e
removed ID
catalinaadam Jul 5, 2024
591472a
Update 3.0.0_Beta.md
catalinaadam Jul 5, 2024
519801e
Update docs/install-pmm/install-pmm-client/connect-database/external.md
catalinaadam Jul 8, 2024
4a167a2
feedback from Alex
catalinaadam Jul 8, 2024
c41a829
Update haproxy.md
catalinaadam Jul 8, 2024
5f6416e
Update proxysql.md
catalinaadam Jul 8, 2024
064aa68
Update pmm-admin.md
catalinaadam Jul 8, 2024
796017b
Update pmm-agent.md
catalinaadam Jul 8, 2024
b946e37
Update pmm-admin.md
catalinaadam Jul 8, 2024
6136802
Update pmm-admin.md
catalinaadam Jul 8, 2024
edb3b87
Update labels.md
catalinaadam Jul 8, 2024
4604549
PMM-8019
catalinaadam Jul 9, 2024
62972fa
PMM-8019, 6722, 12646
catalinaadam Jul 10, 2024
1f37797
reworded
catalinaadam Jul 10, 2024
b20d299
PMM-12376
catalinaadam Jul 10, 2024
cceb8a2
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Jul 11, 2024
2cc2f78
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Jul 11, 2024
bd768b4
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Jul 12, 2024
c95e5f0
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Jul 12, 2024
0eb2f34
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Jul 12, 2024
e12306c
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Jul 12, 2024
68e63a2
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Jul 12, 2024
b4ddc8d
PMM-13159
catalinaadam Jul 12, 2024
2169fc8
Update 3.0.0_Beta.md
catalinaadam Jul 12, 2024
b9d52d6
updated link
catalinaadam Jul 15, 2024
086ad64
fixed link
catalinaadam Jul 15, 2024
0d52361
linked in ToC
catalinaadam Jul 15, 2024
223e299
chore: update the Beta doc related to API
ademidoff Aug 7, 2024
37f7e98
PMM-13053
catalinaadam Aug 15, 2024
d3b576b
PMM-13129
catalinaadam Aug 15, 2024
4e1c1a5
feedback from Nailya
catalinaadam Aug 16, 2024
f7543f8
Manage_Dashboard[PMM3Merge] (#1284)
catalinaadam Aug 19, 2024
3047b38
draft (#1287)
catalinaadam Aug 22, 2024
5e596cc
format
catalinaadam Sep 18, 2024
74523c4
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Oct 1, 2024
8af3f8a
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Oct 1, 2024
ac771b5
feedback from Alex D
catalinaadam Oct 1, 2024
c7bd2e5
Update quickstart.md
catalinaadam Oct 8, 2024
0f34095
Update package_manager.md
catalinaadam Oct 8, 2024
dad8b95
corrected install v3 command
catalinaadam Oct 8, 2024
e3f043f
transferred API info to API Rel Notes
catalinaadam Nov 6, 2024
20d7b89
wording
catalinaadam Nov 6, 2024
6cf1119
updated repo name
catalinaadam Nov 7, 2024
15ea525
PMM-13127 - Tabs navigation (#1328)
catalinaadam Nov 8, 2024
179725f
PMM-13449 Update grafana to 11.1.8 (#1329)
YashSartanpara1 Nov 8, 2024
1ad5424
Mergefrom pmm2releases (#1322)
catalinaadam Nov 8, 2024
1ad0db7
list
catalinaadam Nov 8, 2024
7fbb6ef
PMM-13373
catalinaadam Nov 8, 2024
31cf07f
MM-12820
catalinaadam Nov 8, 2024
06181ae
mentioned other db technologies
catalinaadam Nov 8, 2024
cc77f46
reworded
catalinaadam Nov 8, 2024
81ab70e
PMM-13315
catalinaadam Nov 11, 2024
eb847b7
components upgrade section
catalinaadam Nov 11, 2024
6ecaf1b
internal improvements
catalinaadam Nov 11, 2024
ed491a5
fixed issues part 1
catalinaadam Nov 12, 2024
cc91ac1
PMM-13025 - Upgrade changes (#1316)
catalinaadam Nov 12, 2024
1a6117f
Encryption_PMM_12831 (#1330)
catalinaadam Nov 12, 2024
61cb2d1
Monitor from different nodes (#1315)
catalinaadam Nov 12, 2024
8c618a8
remaining fixed issues
catalinaadam Nov 12, 2024
917b12a
wording
catalinaadam Nov 12, 2024
59bcf91
formatting
catalinaadam Nov 13, 2024
84677e4
DRAFT
catalinaadam Nov 16, 2024
3a6f7a0
feedback from Roma
catalinaadam Nov 18, 2024
5ca93b9
formatting
catalinaadam Nov 18, 2024
48dbafb
formatting
catalinaadam Nov 18, 2024
702c8e3
typos
catalinaadam Nov 18, 2024
10b0e8c
moved minor features to improvements
catalinaadam Nov 18, 2024
09c007f
feedback from Nailya
catalinaadam Nov 18, 2024
19afef8
removed irrelevant SS
catalinaadam Nov 18, 2024
e0eff1d
feedback from Ondrej
catalinaadam Nov 19, 2024
b2f2065
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Nov 19, 2024
286891a
feedback from Nurlan
catalinaadam Nov 19, 2024
dda4a07
Merge branch 'PMM3_Beta' of https://github.com/percona/pmm-doc into P…
catalinaadam Nov 19, 2024
15e03ae
typos
catalinaadam Nov 19, 2024
2408327
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Nov 20, 2024
d647b56
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Nov 20, 2024
1ebe329
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Nov 20, 2024
fee0e80
Update docs/release-notes/3.0.0_Beta.md
catalinaadam Nov 20, 2024
ab05ac9
feedback from Community
catalinaadam Nov 20, 2024
701c7d1
fix release variable reference
catalinaadam Nov 20, 2024
8b24fc5
switched AMD and ARM focus
catalinaadam Nov 20, 2024
5a53954
formatting
catalinaadam Nov 20, 2024
3225b23
Updated migration steps (#1331)
catalinaadam Nov 20, 2024
e4376c4
PMM-12573 - Upgrade Podman UI (#1326)
catalinaadam Nov 20, 2024
29c8a76
Merge remote-tracking branch 'origin/PMM3-branch' into PMM3_Beta
catalinaadam Nov 20, 2024
a3058dc
removed alpha topic
catalinaadam Nov 20, 2024
5ac73c5
updated dates and links
catalinaadam Nov 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ For more details see <https://prometheus.io/docs/instrumenting/writing_exporters
```sh
root@mysql1:~# pmm-admin add external --group=processes --listen-port=9256
External Service added.
Service ID : /service_id/6485f4fd-745b-4dfb-8b72-328e300f8b50
Service ID : /6485f4fd-745b-4dfb-8b72-328e300f8b50
catalinaadam marked this conversation as resolved.
Show resolved Hide resolved
Service name: mysql1-processes
Group : processes
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The output of this command should look as follows:

```txt
HAProxy Service added.
Service ID : /service_id/c481183f-70a2-443f-91e5-cae5cecd06a2
Service ID : /c481183f-70a2-443f-91e5-cae5cecd06a2
Service name: Ubuntu-haproxy
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pmm-admin add proxysql --username=pmm --password=pmm

```text
ProxySQL Service added.
Service ID : /service_id/f69df379-6584-4db5-a896-f35ae8c97573
Service ID : /f69df379-6584-4db5-a896-f35ae8c97573
Service name: ubuntu-proxysql
```

Expand Down
2 changes: 1 addition & 1 deletion docs/pmm-admin/roles/access-control/labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ PMM supports standard as well as custom labels. PMM automatically assigns standa

| **Label Type**| **Object**| **Label name **| **Example** |
|----------|--------|-------|------------------------------|
| **Standard** | Node | node_id |/node_id/123|
| **Standard** | Node | node_id |/123|
| | Service|service_type | - mysql, mongodb, postgresql etc.
| **Custom**| Node, Service, Agent| Any string matching regular expression: <br /> [a-zA-Z_][a-zA-Z0-9_]*. <br /> Also, it cannot start with two underscores.| owner="joe"<br/> _rack="12345"|

Expand Down
27 changes: 27 additions & 0 deletions docs/release-notes/3.0.0_Beta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Percona Monitoring and Management 3.0.0 Alpha

| **Release date** | September 16th, 2024 |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| **Installation** | [Installing Percona Monitoring and Management](https://www.percona.com/software/pmm/quickstart) |

Percona Monitoring and Management (PMM) is an open source database monitoring, management, and observability solution for MySQL, PostgreSQL, and MongoDB.

It enables you to observe the health of your database systems, explore new patterns in their behavior, troubleshoot them and execute database management operations—regardless of whether your databases are located on-premises or in the cloud.

## Release highlights

### Breaking API changes

#### Removed database ID prefixes

We have removed prefixes from database record identifiers (IDs) in PMM to improve REST API compatibility and simplify ID handling.
catalinaadam marked this conversation as resolved.
Show resolved Hide resolved

This change affects various components, including nodes, agents, services, and backup-related entities. As a result:
ademidoff marked this conversation as resolved.
Show resolved Hide resolved

- Database identifiers are now represented as plain UUIDs without prefixes (e.g., `/node_id/`, `/agent_id/`, `/service_id/`).
catalinaadam marked this conversation as resolved.
Show resolved Hide resolved
- API endpoints using IDs as path parameters now use a new format
- Exporter passwords (previously identical to the prefixed `agent_id`) have changed
- Metrics labels that used `agent_id` have been updated
catalinaadam marked this conversation as resolved.
Show resolved Hide resolved

**Impact**
Make sure to update any custom scripts, integrations, or alerts that rely on the old exporter ID format to ensure compatibility with this new structure.
3 changes: 2 additions & 1 deletion docs/release-notes/index.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# Release Notes
- [Percona Monitoring and Management 3.0.0 Alpha](3.0.0_Alpha.md)
- [Percona Monitoring and Management 3.0.0 Alpha](3.0.0_Alpha.md)
- [Percona Monitoring and Management 3.0.0 Beta](3.0.0_Beta.md)
10 changes: 5 additions & 5 deletions docs/use/commands/pmm-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ PMM communicates with the PMM Server via a PMM agent process.
`--server-url=server-url`
: PMM Server URL in `https://username:password@pmm-server-host/` format.

`--machine-id="/machine_id/9812826a1c45454a98ba45c56cc4f5b0"`
`--machine-id="/9812826a1c45454a98ba45c56cc4f5b0"`
: Node machine-id (default is auto-detected).

`--distro="linux"`
Expand Down Expand Up @@ -903,7 +903,7 @@ pmm-admin add mysql --query-source=slowlog --username=pmm --password=pmm sl-mysq

```txt
MySQL Service added.
Service ID : /service_id/a89191d4-7d75-44a9-b37f-a528e2c4550f
Service ID : /a89191d4-7d75-44a9-b37f-a528e2c4550f
Service name: sl-mysql
```

Expand All @@ -917,8 +917,8 @@ pmm-admin status --wait=30s
```

```txt
Agent ID: /agent_id/c2a55ac6-a12f-4172-8850-4101237a4236
Node ID : /node_id/29b2cc24-3b90-4892-8d7e-4b44258d9309
Agent ID: /c2a55ac6-a12f-4172-8850-4101237a4236
Node ID : /29b2cc24-3b90-4892-8d7e-4b44258d9309
PMM Server:
URL : https://x.x.x.x:443/
Version: 2.5.0
Expand All @@ -929,7 +929,7 @@ PMM Client:
pmm-admin version: 2.5.0
pmm-agent version: 2.5.0
Agents:
/agent_id/aeb42475-486c-4f48-a906-9546fc7859e8 mysql_slowlog_agent Running
/aeb42475-486c-4f48-a906-9546fc7859e8 mysql_slowlog_agent Running
```

### Disable collectors
Expand Down
6 changes: 3 additions & 3 deletions docs/use/commands/pmm-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Most options can be set via environment variables (shown in parentheses).
| `--debug` | `PMM_AGENT_DEBUG` | Enable debug output.
| `--distro=distro` | `PMM_AGENT_SETUP_DISTRO` | Node OS distribution (default is auto-detected).
| `--force` | `PMM_AGENT_SETUP_FORCE` | Remove Node with that name and all dependent Services and Agents (if existing).
| `--id=/agent_id/...` | `PMM_AGENT_ID` | ID of this pmm-agent.
| `--id=/...` | `PMM_AGENT_ID` | ID of this pmm-agent.
| `--listen-address=LISTEN-ADDRESS` | `PMM_AGENT_LISTEN_ADDRESS` | Agent local API address.
| `--listen-port=LISTEN-PORT` | `PMM_AGENT_LISTEN_PORT` | Agent local API port.
| `--machine-id=machine-id` | `PMM_AGENT_SETUP_MACHINE_ID` | Node machine ID (default is auto-detected).
Expand Down Expand Up @@ -87,7 +87,7 @@ Config output:
````
# Updated by `pmm-agent setup`.
---
id: /agent_id/be568008-b1b4-4bd9-98c7-392d1f4b724e
id: /be568008-b1b4-4bd9-98c7-392d1f4b724e
listen-address: 127.0.0.1
listen-port: 7777
server:
Expand Down Expand Up @@ -129,7 +129,7 @@ Config output:
````
# Updated by `pmm-agent setup`.
---
id: /agent_id/afce1917-8836-4857-b3e5-ad372c2ddbe5
id: /afce1917-8836-4857-b3e5-ad372c2ddbe5
listen-address: 127.0.0.1
listen-port: 7777
server:
Expand Down
6 changes: 3 additions & 3 deletions variables.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# PMM Version for HTML
# See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path

release: '3.0.0'
version: '3.0.0'
release_date: 2024-03-12
release: '3.0.0 Beta'
version: '3.0.0 Beta'
release_date: 2024-09-12
# SVG icons. Use in markdown as {{icon.<name>}}
# For the Percona image icon (encoded inline SVG), see https://css-tricks.com/using-svg/
icon:
Expand Down
Loading