github/prometheus-pve-sd
0
0
Fork 0
mirror of https://github.com/thegeeklab/prometheus-pve-sd.git synced 2024-11-26 11:20:39 +00:00
Code Issues Projects Releases Wiki Activity

docs: add Prometheus User section to getting started guide (#663)

Browse Source
This commit is contained in:
Alexandr Boltris 2024-11-22 00:42:50 +03:00 committed by GitHub
parent e76b9e79eb
commit c6bfb01805
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/content/usage/getting-started.md
View File

@ -4,6 +4,22 @@ title: Getting Started
{{< toc >}}
## Prometheus User
To allow prometheus-pve-sd to access the Proxmox API, we recommend creating a dedicated user.
The minimum set of privileges for the user is as follows:
- `VM.Audit`
- `VM.Monitor`
Below are the commands to create the new user `prometheus-pve-sd@pve` and assign the necessary privileges:
```Shell
pveum role add prometheus-pve-sd-role --privs 'VM.Audit,VM.Monitor'
pveum user add prometheus-pve-sd@pve --password <password>
pveum aclmod / -user prometheus-pve-sd@pve -role prometheus-pve-sd-role
```
## Available Labels
The following list of meta labels can be used to relabel your scrape results: