From 04106905bb67472a619e7283a089b29326d817df Mon Sep 17 00:00:00 2001 From: Ivan Groenewold <9805809+igroene@users.noreply.github.com> Date: Mon, 12 Aug 2024 15:04:30 -0300 Subject: [PATCH] Update index.md (#1295) * Update index.md Add tabs for better readability. Fix typos. Add example of docker * fixed tabbed notes * formatting * fixed numbered lists * tabbed notes formatting --------- Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/index.md | 147 +++++++++++++++----------------- 1 file changed, 71 insertions(+), 76 deletions(-) diff --git a/docs/setting-up/client/index.md b/docs/setting-up/client/index.md index 48f7b8091c..0607cfbff3 100644 --- a/docs/setting-up/client/index.md +++ b/docs/setting-up/client/index.md @@ -75,8 +75,9 @@ The [PMM Client Docker image] is a convenient way to run PMM Client as a preconf --volumes-from pmm-client-data \ percona/pmm-client:2 ``` -!!! hint alert-success "Tips" - You can find a complete list of compatible environment variables [here](../../details/commands/pmm-agent.md). + + !!! hint alert-success "Tips" + You can find a complete list of compatible environment variables [here](../../details/commands/pmm-agent.md). 4. Check status. @@ -113,52 +114,46 @@ You can now add services with [`pmm-admin`](../../details/commands/pmm-admin.md) percona-release enable original release ``` -#### Debian-based - -1. Configure repositories. - - ```sh - wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb - dpkg -i percona-release_latest.generic_all.deb - ``` +=== "Debian-based" -2. Install the PMM Client package. + 1. Configure repositories: + ```sh + wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb + dpkg -i percona-release_latest.generic_all.deb + ``` - !!! hint "Root permissions" - ```sh - apt update - apt install -y pmm2-client - ``` + 2. Install the PMM Client package: + !!! hint "Root permissions" + ```sh + apt update + apt install -y pmm2-client + ``` -3. Check. + 3. Check: + ```sh + pmm-admin --version + ``` - ```sh - pmm-admin --version - ``` + 4. [Register the node](#register). -4. [Register the node](#register). +=== "Red Hat-based" -#### Red Hat-based + 1. Configure repositories: + ```sh + yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm + ``` -1. Configure repositories. + 2. Install the PMM Client package: + ```sh + yum install -y pmm2-client + ``` - ```sh - yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm - ``` + 3. Check: + ```sh + pmm-admin --version + ``` -2. Install the PMM Client package. - - ```sh - yum install -y pmm2-client - ``` - -3. Check. - - ```sh - pmm-admin --version - ``` - -4. [Register the node](#register). + 4. [Register the node](#register). ### Package manager -- manual download @@ -183,17 +178,17 @@ Here are the download page links for each supported platform. - [Ubuntu 20.04 (Focal Fossa)] - [Ubuntu 22.04 (Jammy Jellyfish)] -#### Debian-based +=== "Debian-based" -```sh -dpkg -i *.deb -``` + ```sh + dpkg -i *.deb + ``` -#### Red Hat-based +=== "Red Hat-based" -```sh -dnf localinstall *.rpm -``` + ```sh + dnf localinstall *.rpm + ``` ### Binary package @@ -259,8 +254,6 @@ dnf localinstall *.rpm pmm-agent setup --config-file=${PMM_DIR}/config/pmm-agent.yaml --server-address=192.168.1.123 --server-insecure-tls --server-username=admin --server-password=admin --paths-tempdir=${PMM_DIR}/tmp --paths-base=${PMM_DIR} ``` - - 9. Run the agent. ```sh @@ -273,13 +266,13 @@ dnf localinstall *.rpm pmm-admin status ``` - !!! hint PMM-Agent can be updated from tarball: + !!! hint "PMM-Agent can be updated from tarball" - 1. Download tar.gz with pmm2-client. - 2. Extract it. - 3. Run ./install_tarball script with the "-u" flag. + 1. Download tar.gz with pmm2-client. + 2. Extract it. + 3. Run ./install_tarball script with the "-u" flag. - The configuration file will be overwritten if you do not provide the "-u" flag while the pmm-agent is updated. + The configuration file will be overwritten if you do not provide the "-u" flag while the pmm-agent is updated. ## Register @@ -304,6 +297,12 @@ Register on PMM Server with IP address `192.168.33.14` using the default `admin/ pmm-admin config --server-insecure-tls --server-url=https://admin:admin@192.168.33.14:443 192.168.33.23 generic mynode ``` +Register your client node running on Docker with PMM Server. + +```sh +docker exec pmm-admin config --server-insecure-tls --server-url=https://admin:admin@X.X.X.X:443 +``` + ## Add services You must configure and adding services according to the service type. @@ -358,33 +357,29 @@ How to remove (uninstall) PMM Client. ### Package manager -#### Debian-based distributions +=== "Debian-based distributions" -1. Uninstall the PMM Client package. + 1. Uninstall the PMM Client package: + ```sh + apt remove -y pmm2-client + ``` - ```sh - apt remove -y pmm2-client - ``` - -2. Remove the Percona repository - - ```sh - dpkg -r percona-release - ``` + 2. Remove the Percona repository: + ```sh + dpkg -r percona-release + ``` -#### Red Hat-based distributions +=== "Red Hat-based distributions" -1. Uninstall the PMM Client package. + 1. Uninstall the PMM Client package: + ```sh + yum remove -y pmm2-client + ``` - ```sh - yum remove -y pmm2-client - ``` - -2. Remove the Percona repository - - ```sh - yum remove -y percona-release - ``` + 2. Remove the Percona repository: + ```sh + yum remove -y percona-release + ``` ## Unregister