Skip to content

Commit

Permalink
Upd README
Browse files Browse the repository at this point in the history
  • Loading branch information
joente committed Jun 12, 2024
1 parent 46800a6 commit ac659d4
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,23 @@ Variable | Default | Description
docker build -t proxmoxnode-probe . --no-cache
```

## Config

Example config _(change the `username`, `token_id` and `secret` to your own values and if required choose another `realm`)_:

```yaml
proxmoxcluster:
config:
username: root
realm: pam
token_id: monitoring
secret: 12345678-1234-1234-1234-1234567890ab
proxmoxnode:
use: proxmoxcluster
proxmoxguest:
use: proxmoxcluster
```
## Dry run
Available checks:
Expand All @@ -36,14 +53,20 @@ Create a yaml file, for example _(test.yaml)_:
```yaml
asset:
name: "foo.local"
check: "guests"
check: "node"
config:
address: "192.168.1.2"
address: "10.0.0.1"
node: "pve"
port: 8006
ssl: false
```

Run the probe with the `DRY_RUN` environment variable set the the yaml file above.

```
DRY_RUN=test.yaml python main.py
```
```
## Proxmox API documentation
https://pve.proxmox.com/pve-docs/api-viewer

0 comments on commit ac659d4

Please sign in to comment.