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

Improve table width #1321

Open
wants to merge 44 commits into
base: PMM3-branch
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 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
29c3c12
test
catalinaadam Oct 25, 2024
fa397b3
pdate the width of the first column
catalinaadam Oct 25, 2024
ce8acfe
tryhtml
catalinaadam Oct 25, 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
Binary file modified docs/_images/PMM_Move_dashboards-way2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Move_dashboards.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Permissions_dashboards_folder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_set_home_dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 16 additions & 18 deletions docs/install-pmm/HA.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,22 @@ Before you start with the setup, define the necessary environment variables on e

For all IP addresses, use the format `17.10.1.x`, and for all usernames and passwords, use a string format like `example`.


| **Variable** | **Description**
| ------------------------------------------------| -------------------------------------------------------------------------------------------------------------------------------
| `CH_HOST_IP` | The IP address of the instance where the ClickHouse service is running or the desired IP address for the ClickHouse container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.2`
| `VM_HOST_IP` | The IP address of the instance where the VictoriaMetrics service is running or the desired IP address for the VictoriaMetrics container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.3`
| `PG_HOST_IP` | The IP address of the instance where the PostgreSQL service is running or the desired IP address for the PostgreSQL container within the Docker network, depending on your setup.</br></br> Example: `17.10.1.4`
| `PG_USERNAME` | The username for your PostgreSQL server.</br></br> Example: `pmmuser`
| `PG_PASSWORD` | The password for your PostgreSQL server. </br></br>Example: `pgpassword`
| `GF_USERNAME` | The username for your Grafana database user.</br></br>Example: `gfuser`
| `GF_PASSWORD` | The password for your Grafana database user.</br></br>Example: `gfpassword`
| `PMM_ACTIVE_IP` | The IP address of the instance where the active PMM Server is running or the desired IP address for your active PMM Server container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.5`
| `PMM_ACTIVE_NODE_ID` | The unique ID for your active PMM Server node.</br></br>Example: `pmm-server-active`
| `PMM_PASSIVE_IP` | The IP address of the instance where the first passive PMM Server is running or the desired IP address for your first passive PMM Server container within the Docker network, depending on your setup. </br></br>Example: `17.10.1.6`
| `PMM_PASSIVE_NODE_ID` | The unique ID for your first passive PMM Server node.</br></br>Example: `pmm-server-passive`
| `PMM_PASSIVE2_IP` | The IP address of the instance where the second passive PMM Server is running or the desired IP address for your second passive PMM Server container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.7`
| `PMM_PASSIVE2_NODE_ID` | The unique ID for your second passive PMM Server node.</br></br>Example: `pmm-server-passive2`
| `PMM_DOCKER_IMAGE` &nbsp; &nbsp; &nbsp; &nbsp; | The specific PMM Server Docker image for this guide.</br></br>Example: `percona/pmm-server:2`

| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description |
|-------------------------------------------------|-------------|
| `CH_HOST_IP` | The IP address of the instance where the ClickHouse service is running or the desired IP address for the ClickHouse container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.2` |
| `VM_HOST_IP` | The IP address of the instance where the VictoriaMetrics service is running or the desired IP address for the VictoriaMetrics container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.3` |
| `PG_HOST_IP` | The IP address of the instance where the PostgreSQL service is running or the desired IP address for the PostgreSQL container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.4` |
| `PG_USERNAME` | The username for your PostgreSQL server.</br></br>Example: `pmmuser` |
| `PG_PASSWORD` | The password for your PostgreSQL server.</br></br>Example: `pgpassword` |
| `GF_USERNAME` | The username for your Grafana database user.</br></br>Example: `gfuser` |
| `GF_PASSWORD` | The password for your Grafana database user.</br></br>Example: `gfpassword` |
| `PMM_ACTIVE_IP` | The IP address of the instance where the active PMM Server is running or the desired IP address for your active PMM Server container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.5` |
| `PMM_ACTIVE_NODE_ID` | The unique ID for your active PMM Server node.</br></br>Example: `pmm-server-active` |
| `PMM_PASSIVE_IP` | The IP address of the instance where the first passive PMM Server is running or the desired IP address for your first passive PMM Server container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.6` |
| `PMM_PASSIVE_NODE_ID` | The unique ID for your first passive PMM Server node.</br></br>Example: `pmm-server-passive` |
| `PMM_PASSIVE2_IP` | The IP address of the instance where the second passive PMM Server is running or the desired IP address for your second passive PMM Server container within the Docker network, depending on your setup.</br></br>Example: `17.10.1.7` |
| `PMM_PASSIVE2_NODE_ID` | The unique ID for your second passive PMM Server node.</br></br>Example: `pmm-server-passive2` |
| `PMM_DOCKER_IMAGE` | The specific PMM Server Docker image for this guide.</br></br>Example: `percona/pmm-server:2` |

??? example "Expected output"

Expand Down
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
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
24 changes: 12 additions & 12 deletions docs/install-pmm/install-pmm-client/package_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ On Debian or Red Hat Linux, install `percona-release` and use a Linux package ma

```sh
percona-release disable all
percona-release enable original release
percona-release percona-release enable pmm-client
```

=== "Debian-based"
Expand All @@ -26,7 +26,7 @@ On Debian or Red Hat Linux, install `percona-release` and use a Linux package ma
!!! hint "Root permissions"
```sh
apt update
apt install -y pmm2-client
apt install -y pmm-client
```

3. Check.
Expand All @@ -48,7 +48,7 @@ On Debian or Red Hat Linux, install `percona-release` and use a Linux package ma
2. Install the PMM Client package.

```sh
yum install -y pmm2-client
yum install -y pmm-client
```

3. Check.
Expand All @@ -64,7 +64,7 @@ On Debian or Red Hat Linux, install `percona-release` and use a Linux package ma
To manually download package manager:
{.power-number}

1. Visit the [Percona Monitoring and Management 2 download](https://www.percona.com/downloads/pmm2/) page.
1. Visit the [Percona Monitoring and Management 3 download](https://www.percona.com/downloads//) page.
2. Under *Version:*, select the one you want (usually the latest).
3. Under *Software:*, select the item matching your software platform.
4. Click to download the package file:
Expand All @@ -89,12 +89,12 @@ To manually download package manager:

Here are the download page links for each supported platform.

- [Debian 9 (Stretch)](https://www.percona.com/downloads/pmm2/{{release}}/binary/debian/stretch/)
- [Debian 10 (Buster)](https://www.percona.com/downloads/pmm2/{{release}}/binary/debian/buster/)
- [Debian 11 (Bullseye)](https://www.percona.com/downloads/pmm2/{{release}}/binary/debian/bullseye/)
- [Red Hat/CentOS/Oracle 7](https://www.percona.com/downloads/pmm2/{{release}}/binary/redhat/7/)
- [Red Hat/CentOS/Oracle 8](https://www.percona.com/downloads/pmm2/{{release}}/binary/redhat/8/)
- [Ubuntu 18.04 (Bionic Beaver)](https://www.percona.com/downloads/pmm2/{{release}}/binary/debian/bionic/)
- [Ubuntu 20.04 (Focal Fossa)](https://www.percona.com/downloads/pmm2/{{release}}/binary/debian/focal/)
- [Ubuntu 22.04 (Jammy Jellyfish)](https://www.percona.com/downloads/pmm2/{{release}}/binary/debian/jammy/)
- [Debian 9 (Stretch)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/stretch/)
- [Debian 10 (Buster)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/buster/)
- [Debian 11 (Bullseye)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/bullseye/)
- [Red Hat/CentOS/Oracle 7](https://www.percona.com/downloads/pmm3/{{release}}/binary/redhat/7/)
- [Red Hat/CentOS/Oracle 8](https://www.percona.com/downloads/pmm3/{{release}}/binary/redhat/8/)
- [Ubuntu 18.04 (Bionic Beaver)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/bionic/)
- [Ubuntu 20.04 (Focal Fossa)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/focal/)
- [Ubuntu 22.04 (Jammy Jellyfish)](https://www.percona.com/downloads//{{release}}/binary/debian/jammy/)

4 changes: 2 additions & 2 deletions 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 All @@ -38,4 +38,4 @@ To set the labels using the user interface:

### Using pmm-admin

You can also assign labels using [pmm-admin](../../../use/commands/pmm-admin.md).
You can also assign labels using [pmm-admin](../../../use/commands/pmm-admin.md).
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Once PMM is set up, choose the database or the application that you want it to m

```sh
apt update
apt install -y pmm2-client
apt install -y pmm-client
```

=== ":material-redhat: Red Hat-based"
Expand Down
92 changes: 71 additions & 21 deletions docs/quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,12 @@ Once PMM is set up, choose the database or the application that you want it to m
dpkg -i percona-release_latest.generic_all.deb
```

2. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
apt update
Expand All @@ -92,16 +97,21 @@ Once PMM is set up, choose the database or the application that you want it to m
Install the following with `root` permission:
{ .power-number}

1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version.
4. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version.

```sh
yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm
```

2. Install the PMM Client package:
5. Enable the PMM client repository:

```sh
yum install -y pmm2-client
percona-release enable pmm-client release
```
6. Install the PMM Client package:

```sh
yum install -y pmm-client
```

3. Register PMM Client:
Expand Down Expand Up @@ -176,27 +186,37 @@ Once PMM is set up, choose the database or the application that you want it to m
dpkg -i percona-release_latest.generic_all.deb
```

2. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
apt update
apt install -y pmm2-client
apt install -y pmm-client
```

=== ":material-redhat: Red Hat-based"

Install the following with `root` permission:
{ .power-number}

3. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version:
1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version:

```sh
yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm
```
4. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
yum install -y pmm2-client
yum install -y pmm-client
```

8. Register PMM Client:
Expand Down Expand Up @@ -280,11 +300,16 @@ Once PMM is set up, choose the database or the application that you want it to m
dpkg -i percona-release_latest.generic_all.deb
```

2. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
apt update
apt install -y pmm2-client
apt install -y pmm-client
```

=== ":material-redhat: Red Hat-based"
Expand All @@ -297,10 +322,15 @@ Once PMM is set up, choose the database or the application that you want it to m
yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm
```

2. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
yum install -y pmm2-client
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
yum install -y pmm-client
```

4. Register PMM Client:
Expand Down Expand Up @@ -337,11 +367,16 @@ Once PMM is set up, choose the database or the application that you want it to m
dpkg -i percona-release_latest.generic_all.deb
```

2. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
apt update
apt install -y pmm2-client
apt install -y pmm-client
```

=== ":material-redhat: Red Hat-based"
Expand All @@ -354,10 +389,15 @@ Once PMM is set up, choose the database or the application that you want it to m
yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm
```

2. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
yum install -y pmm2-client
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
yum install -y pmm-client
```

3. Register PMM Client:
Expand Down Expand Up @@ -393,11 +433,16 @@ Once PMM is set up, choose the database or the application that you want it to m
dpkg -i percona-release_latest.generic_all.deb
```

2. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
apt update
apt install -y pmm2-client
apt install -y pmm-client
```

=== ":material-redhat: Red Hat-based"
Expand All @@ -410,10 +455,15 @@ Once PMM is set up, choose the database or the application that you want it to m
yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm
```

2. Install the PMM Client package:
2. Enable the PMM client repository:

```sh
percona-release enable pmm-client release
```
3. Install the PMM Client package:

```sh
yum install -y pmm2-client
yum install -y pmm-client
```

4. Register PMM Client:
Expand Down
Loading
Loading