diff --git a/documentation/docs/install-pmm/install-pmm-client/binary_package.md b/documentation/docs/install-pmm/install-pmm-client/binary_package.md index 6362c961442..6ab2d02e32c 100644 --- a/documentation/docs/install-pmm/install-pmm-client/binary_package.md +++ b/documentation/docs/install-pmm/install-pmm-client/binary_package.md @@ -227,7 +227,7 @@ Registration requires authentication to verify that your PMM Client has permissi 2. Navigate to **Administration > Users and access > Service Accounts**. 3. Click **Add Service account**. 4. Enter a descriptive name (e.g.: `pmm-client-prod-db01`). Keep in mind that PMM automatically shortens names exceeding 200 characters using a `{prefix}_{hash}` pattern. - 5. Select the **Editor** role from the drop-down. For detailed information about what each role can do, see [Role types in PMM](../../admin/roles/index.md). + 5. Select the **Admin** role from the drop-down. For detailed information about what each role can do, see [Role types in PMM](../../admin/roles/index.md). 6. Click **Create > Add service account token**. 7. (Optional) Name your token or leave blank for auto-generated name. 8. (Optional) Set expiration date for enhanced security. Expired tokens require manual rotation. Permanent tokens remain valid until revoked. @@ -237,11 +237,8 @@ Registration requires authentication to verify that your PMM Client has permissi ```bash pmm-admin config --server-insecure-tls \ - --server-url=https://YOUR_PMM_SERVER:443 \ - --server-username=service_token \ - --server-password=YOUR_GLSA_TOKEN \ + --server-url=https://service_token:YOUR_GLSA_TOKEN@YOUR_PMM_SERVER:443 \ [NODE_ADDRESS] [NODE_TYPE] [NODE_NAME] - ``` **Parameters explained:** @@ -258,9 +255,7 @@ Registration requires authentication to verify that your PMM Client has permissi ??? example "Full example with node details" ```bash pmm-admin config --server-insecure-tls \ - --server-url=https://192.168.33.14:443 \ - --server-username=service_token \ - --server-password=glsa_aBc123XyZ456... \ + --server-url=https://service_token:glsa_aBc123XyZ456...@192.168.33.14:443 \ 192.168.33.23 generic prod-db01 ``` This registers node `192.168.33.23` with type `generic` and name `prod-db01`. diff --git a/documentation/docs/install-pmm/install-pmm-client/docker.md b/documentation/docs/install-pmm/install-pmm-client/docker.md index 425d0316a13..af7e31dd42e 100644 --- a/documentation/docs/install-pmm/install-pmm-client/docker.md +++ b/documentation/docs/install-pmm/install-pmm-client/docker.md @@ -92,7 +92,7 @@ Registration requires authentication to verify that your PMM Client has permissi 2. Navigate to **Administration > Users and access > Service Accounts**. 3. Click **Add Service account**. 4. Enter a descriptive name (e.g.: `pmm-client-prod-db01`). Keep in mind that PMM automatically shortens names exceeding 200 characters using a `{prefix}_{hash}` pattern. - 5. Select the **Editor** role from the drop-down. For detailed information about what each role can do, see [Role types in PMM](../../admin/roles/index.md). + 5. Select the **Admin** role from the drop-down. For detailed information about what each role can do, see [Role types in PMM](../../admin/roles/index.md). 6. Click **Create > Add service account token**. 7. (Optional) Name your token or leave blank for auto-generated name. 8. (Optional) Set expiration date for enhanced security. Expired tokens require manual rotation. Permanent tokens remain valid until revoked. @@ -102,9 +102,7 @@ Registration requires authentication to verify that your PMM Client has permissi ```bash docker exec -it pmm-client pmm-admin config --server-insecure-tls \ - --server-url=https://YOUR_PMM_SERVER:443 \ - --server-username=service_token \ - --server-password=YOUR_GLSA_TOKEN \ + --server-url=https://service_token:YOUR_GLSA_TOKEN@YOUR_PMM_SERVER:443 \ [NODE_ADDRESS] [NODE_TYPE] [NODE_NAME] ``` @@ -121,9 +119,7 @@ Registration requires authentication to verify that your PMM Client has permissi ??? example "Full example with node details" ```bash docker exec -it pmm-client pmm-admin config --server-insecure-tls \ - --server-url=https://192.168.33.14:443 \ - --server-username=service_token \ - --server-password=glsa_aBc123XyZ456... \ + --server-url=https://service_token:glsa_aBc123XyZ456...@192.168.33.14:443 \ 192.168.33.23 generic prod-db01 ``` This registers node `192.168.33.23` with type `generic` and name `prod-db01`. diff --git a/documentation/docs/install-pmm/install-pmm-client/package_manager.md b/documentation/docs/install-pmm/install-pmm-client/package_manager.md index 778a235dedb..5d05e47e097 100644 --- a/documentation/docs/install-pmm/install-pmm-client/package_manager.md +++ b/documentation/docs/install-pmm/install-pmm-client/package_manager.md @@ -118,7 +118,7 @@ Registration requires authentication to verify that your PMM Client has permissi 2. Navigate to **Administration > Users and access > Service Accounts**. 3. Click **Add Service account**. 4. Enter a descriptive name (e.g.: `pmm-client-prod-db01`). PMM automatically shortens names exceeding 200 characters using a `{prefix}_{hash}` pattern. - 5. Select the **Editor** role from the drop-down. For detailed information about what each role can do, see [Role types in PMM](../../admin/roles/index.md). + 5. Select the **Admin** role from the drop-down. For detailed information about what each role can do, see [Role types in PMM](../../admin/roles/index.md). 6. Click **Create > Add service account token**. 7. (Optional) Name your token or leave blank for auto-generated name. 8. (Optional) Set expiration date for enhanced security. Expired tokens require manual rotation. Permanent tokens remain valid until revoked. @@ -137,7 +137,9 @@ Registration requires authentication to verify that your PMM Client has permissi - `YOUR_PMM_SERVER` - Your PMM Server's IP address or hostname - `service_token` - Use this exact string as the username (not a placeholder!) - `YOUR_GLSA_TOKEN` - The token you copied (starts with `glsa_`) - + - `[NODE_TYPE]` - (Optional) Node type: `generic`, `container`, etc. + - `[NODE_NAME]` - (Optional) Descriptive name for the node + ??? example "Full example with node details" ```bash pmm-admin config --server-insecure-tls \ diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md index c45a59a0a0b..a08498eb81b 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md @@ -62,7 +62,7 @@ Create the required Kubernetes secret and deploy PMM Server using Helm: 3. Add the Percona repository and check available PMM versions: ```bash - helm repo add percona [https://percona.github.io/percona-helm-charts/](https://percona.github.io/percona-helm-charts/) + helm repo add percona https://percona.github.io/percona-helm-charts helm repo update ``` @@ -103,10 +103,10 @@ Create the required Kubernetes secret and deploy PMM Server using Helm: ```bash # If using ClusterIP (default) - kubectl port-forward svc/pmm-service 443:443 + kubectl port-forward svc/monitoring-service 443:443 # If using NodePort - kubectl get svc pmm-service -o jsonpath='{.spec.ports[0].nodePort}' + kubectl get svc monitoring-service -o jsonpath='{.spec.ports[0].nodePort}' ``` ### Configure PMM Server @@ -125,8 +125,9 @@ Configure PMM Server using either command-line arguments or a YAML file: - using command-line arguments: ```sh helm install pmm \ - --set secret.create=false --set secret.name=pmm-secret \ - --set service.type="NodePort" \ + --set secret.create=false \ + --set secret.name=pmm-secret \ + --set service.type="NodePort" \ percona/pmm ``` - using a .yaml configuration file: @@ -147,7 +148,7 @@ Add [environment variables](../docker/env_var.md) for advanced operations (like ```yaml pmmEnv: -PMM_ENABLE_UPDATES: "1" + PMM_ENABLE_UPDATES: "0" ``` ### SSL certificates