Skip to content

Commit

Permalink
docs: add Prometheus User section to getting started guide (#663)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexandrBoltris authored Nov 21, 2024
1 parent e76b9e7 commit c6bfb01
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/content/usage/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit c6bfb01

Please sign in to comment.