Skip to content

Commit 6225b64

Browse files
Update k8s launch + register node instructions (#4485)
* Update index.md * chore: update service references and Helm install command * chore: disable PMM updates in Helm configuration * updated user permission * replicated PR4458 * feeback from Davi --------- Co-authored-by: Alex Demidoff <[email protected]>
1 parent a670a31 commit 6225b64

File tree

4 files changed

+17
-23
lines changed

4 files changed

+17
-23
lines changed

documentation/docs/install-pmm/install-pmm-client/binary_package.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ Registration requires authentication to verify that your PMM Client has permissi
227227
2. Navigate to **Administration > Users and access > Service Accounts**.
228228
3. Click **Add Service account**.
229229
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.
230-
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).
230+
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).
231231
6. Click **Create > Add service account token**.
232232
7. (Optional) Name your token or leave blank for auto-generated name.
233233
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
237237

238238
```bash
239239
pmm-admin config --server-insecure-tls \
240-
--server-url=https://YOUR_PMM_SERVER:443 \
241-
--server-username=service_token \
242-
--server-password=YOUR_GLSA_TOKEN \
240+
--server-url=https://service_token:YOUR_GLSA_TOKEN@YOUR_PMM_SERVER:443 \
243241
[NODE_ADDRESS] [NODE_TYPE] [NODE_NAME]
244-
245242
```
246243

247244
**Parameters explained:**
@@ -258,9 +255,7 @@ Registration requires authentication to verify that your PMM Client has permissi
258255
??? example "Full example with node details"
259256
```bash
260257
pmm-admin config --server-insecure-tls \
261-
--server-url=https://192.168.33.14:443 \
262-
--server-username=service_token \
263-
--server-password=glsa_aBc123XyZ456... \
258+
--server-url=https://service_token:[email protected]:443 \
264259
192.168.33.23 generic prod-db01
265260
```
266261
This registers node `192.168.33.23` with type `generic` and name `prod-db01`.

documentation/docs/install-pmm/install-pmm-client/docker.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Registration requires authentication to verify that your PMM Client has permissi
9292
2. Navigate to **Administration > Users and access > Service Accounts**.
9393
3. Click **Add Service account**.
9494
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.
95-
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).
95+
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).
9696
6. Click **Create > Add service account token**.
9797
7. (Optional) Name your token or leave blank for auto-generated name.
9898
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
102102
103103
```bash
104104
docker exec -it pmm-client pmm-admin config --server-insecure-tls \
105-
--server-url=https://YOUR_PMM_SERVER:443 \
106-
--server-username=service_token \
107-
--server-password=YOUR_GLSA_TOKEN \
105+
--server-url=https://service_token:YOUR_GLSA_TOKEN@YOUR_PMM_SERVER:443 \
108106
[NODE_ADDRESS] [NODE_TYPE] [NODE_NAME]
109107
```
110108
@@ -121,9 +119,7 @@ Registration requires authentication to verify that your PMM Client has permissi
121119
??? example "Full example with node details"
122120
```bash
123121
docker exec -it pmm-client pmm-admin config --server-insecure-tls \
124-
--server-url=https://192.168.33.14:443 \
125-
--server-username=service_token \
126-
--server-password=glsa_aBc123XyZ456... \
122+
--server-url=https://service_token:[email protected]:443 \
127123
192.168.33.23 generic prod-db01
128124
```
129125
This registers node `192.168.33.23` with type `generic` and name `prod-db01`.

documentation/docs/install-pmm/install-pmm-client/package_manager.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Registration requires authentication to verify that your PMM Client has permissi
118118
2. Navigate to **Administration > Users and access > Service Accounts**.
119119
3. Click **Add Service account**.
120120
4. Enter a descriptive name (e.g.: `pmm-client-prod-db01`). PMM automatically shortens names exceeding 200 characters using a `{prefix}_{hash}` pattern.
121-
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).
121+
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).
122122
6. Click **Create > Add service account token**.
123123
7. (Optional) Name your token or leave blank for auto-generated name.
124124
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
137137
- `YOUR_PMM_SERVER` - Your PMM Server's IP address or hostname
138138
- `service_token` - Use this exact string as the username (not a placeholder!)
139139
- `YOUR_GLSA_TOKEN` - The token you copied (starts with `glsa_`)
140-
140+
- `[NODE_TYPE]` - (Optional) Node type: `generic`, `container`, etc.
141+
- `[NODE_NAME]` - (Optional) Descriptive name for the node
142+
141143
??? example "Full example with node details"
142144
```bash
143145
pmm-admin config --server-insecure-tls \

documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Create the required Kubernetes secret and deploy PMM Server using Helm:
6262
3. Add the Percona repository and check available PMM versions:
6363
6464
```bash
65-
helm repo add percona [https://percona.github.io/percona-helm-charts/](https://percona.github.io/percona-helm-charts/)
65+
helm repo add percona https://percona.github.io/percona-helm-charts
6666
helm repo update
6767
```
6868
@@ -103,10 +103,10 @@ Create the required Kubernetes secret and deploy PMM Server using Helm:
103103
104104
```bash
105105
# If using ClusterIP (default)
106-
kubectl port-forward svc/pmm-service 443:443
106+
kubectl port-forward svc/monitoring-service 443:443
107107
108108
# If using NodePort
109-
kubectl get svc pmm-service -o jsonpath='{.spec.ports[0].nodePort}'
109+
kubectl get svc monitoring-service -o jsonpath='{.spec.ports[0].nodePort}'
110110
```
111111
112112
### Configure PMM Server
@@ -125,8 +125,9 @@ Configure PMM Server using either command-line arguments or a YAML file:
125125
- using command-line arguments:
126126
```sh
127127
helm install pmm \
128-
--set secret.create=false --set secret.name=pmm-secret \
129-
--set service.type="NodePort" \
128+
--set secret.create=false \
129+
--set secret.name=pmm-secret \
130+
--set service.type="NodePort" \
130131
percona/pmm
131132
```
132133
- using a .yaml configuration file:
@@ -147,7 +148,7 @@ Add [environment variables](../docker/env_var.md) for advanced operations (like
147148
148149
```yaml
149150
pmmEnv:
150-
PMM_ENABLE_UPDATES: "1"
151+
PMM_ENABLE_UPDATES: "0"
151152
```
152153
153154
### SSL certificates

0 commit comments

Comments
 (0)