You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+64Lines changed: 64 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -218,6 +218,9 @@ of the `ops` group. Read the **User and ACL Management** section for more info.
218
218
The backend needs to be supported by [Proxmox][pvesm]. Read the **Storage
219
219
Management** section for more info.
220
220
221
+
`pve_metric_servers` allows you to configure a metric server for the PVE cluster.
222
+
This is useful if you want to use InfluxDB, Graphite or other (with telegraf).
223
+
221
224
`pve_ssh_port` allows you to change the SSH port. If your SSH is listening on
222
225
a port other than the default 22, please set this variable. If a new node is
223
226
joining the cluster, the PVE cluster needs to communicate once via SSH.
@@ -386,6 +389,7 @@ pve_check_for_kernel_update: true # Runs a script on the host to check kernel ve
386
389
pve_reboot_on_kernel_update: false # If set to true, will automatically reboot the machine on kernel updates
387
390
pve_reboot_on_kernel_update_delay: 60 # Number of seconds to wait before and after a reboot process to proceed with next task in cluster mode
388
391
pve_remove_old_kernels: true # Currently removes kernel from main Debian repository
392
+
# pve_default_kernel_version: # version to pin proxmox-default-kernel to (see https://pve.proxmox.com/wiki/Roadmap#Kernel_6.8)
389
393
pve_pcie_passthrough_enabled: false # Set this to true to enable PCIe passthrough.
390
394
pve_iommu_passthrough_mode: false # Set this to true to allow VMs to bypass the DMA translation. This might increase performance for IOMMU passthrough.
391
395
pve_iommu_unsafe_interrupts: false # Set this to true if your system doesn't support interrupt remapping.
@@ -420,6 +424,7 @@ pve_roles: [] # Added more roles with specific privileges. See section on User M
420
424
pve_groups: [] # List of group definitions to manage in PVE. See section on User Management.
421
425
pve_users: [] # List of user definitions to manage in PVE. See section on User Management.
422
426
pve_storages: [] # List of storages to manage in PVE. See section on Storage Management.
427
+
pve_metric_servers: [] # List of metric servers to configure in PVE.
423
428
pve_datacenter_cfg: {} # Dictionary to configure the PVE datacenter.cfg config file.
424
429
pve_domains_cfg: [] # List of realms to use as authentication sources in the PVE domains.cfg config file.
425
430
pve_no_log: false # Set this to true in production to prevent leaking of storage credentials in run logs. (may be used in other tasks in the future)
@@ -835,6 +840,64 @@ Then system interrupt remapping is supported and you do not need to enable unsaf
835
840
836
841
`pve_pcie_report_msrs`can be used to enable or disable logging messages of msrs warnings. If you see a lot of warning messages in your 'dmesg' system log, this value can be used to silence msrs warnings.
837
842
843
+
## Metrics Server Configuration
844
+
845
+
You can configure metric servers in Proxmox VE using the `pve_metric_servers` role variable. Below is an example configuration for different types of metric servers:
846
+
847
+
```yaml
848
+
pve_metric_servers:
849
+
- id: influxdb1
850
+
port: 8086
851
+
server: influxdb.example.com
852
+
type: influxdb
853
+
protocol: http
854
+
organization: myorg
855
+
bucket: mybucket
856
+
token: mytoken
857
+
timeout: 30
858
+
max_body_size: 25000000
859
+
verify_certificate: true
860
+
- id: graphite1
861
+
port: 2003
862
+
server: graphite.example.com
863
+
type: graphite
864
+
protocol: tcp
865
+
path: mygraphitepath
866
+
mtu: 1500
867
+
```
868
+
869
+
### Configuration Variables
870
+
871
+
- `id`: (required) Unique identifier for the metric server.
872
+
- `port`: (optional) Port of the metric server. Default is `8089`.
873
+
- `server`: (required) DNS name or IP address of the metric server.
874
+
- `type`: (optional) Type of metric server. Possible values: `influxdb`, `graphite`. Default is `influxdb`.
875
+
- `protocol`: (optional) Protocol used to send metrics. Possible values: `udp`, `tcp`, `http`, `https`. Default is `udp`.
876
+
- `disable`: (optional) Disable the metric server. Default is `false`.
877
+
- `organization`: (optional) Organization name. Available only for influxdb with the http v2 API.
878
+
- `bucket`: (optional) Bucket name for influxdb. Useful only with the http v2 API or compatible.
879
+
- `token`: (optional) InfluxDB access token. Required only when using the http v2 API.
880
+
- `path`: (optional) Graphite root path. Available only for graphite.
881
+
- `api_path_prefix`: (optional) API path prefix inserted between `<host>:<port>/` and `/api2/`. Useful if the InfluxDB service is running behind a reverse proxy. Available only for influxdb with the http v2 API.
882
+
- `timeout`: (optional) Timeout in seconds. Available only for influxdb with the http v2 API or Graphite TCP socket.
883
+
- `max_body_size`: (optional) Maximum body size in bytes. Available only for influxdb with the http v2 API. Default is `25000000`.
884
+
- `mtu`: (optional) MTU for UDP metric transmission.
885
+
- `verify_certificate`: (optional) Verify SSL certificate. Available only for influxdb with https.
886
+
887
+
## Non-default scenarios and other use cases
888
+
889
+
### Preventing upgrade to Linux kernel 6.8
890
+
891
+
Proxmox 8.2 introduces Linux 6.8, which may cause issues in some deployments.
892
+
To work around this, you can pin the kernel version used to 6.5 by adding the following role variable:
893
+
894
+
```yaml
895
+
pve_default_kernel_version: 1.0.1
896
+
```
897
+
898
+
This creates a pin on the `proxmox-default-kernel` package, which is [the method suggested by PVE](https://pve.proxmox.com/wiki/Roadmap#Kernel_6.8).
899
+
It can be later removed by unsetting this role variable.
900
+
838
901
## Developer Notes
839
902
840
903
When developing new features or fixing something in this role, you can test out
@@ -878,6 +941,7 @@ John Marion ([@jmariondev](https://github.com/jmariondev))
878
941
foerkede ([@foerkede](https://github.com/foerkede)) - ZFS storage support
879
942
Guiffo Joel ([@futuriste](https://github.com/futuriste)) - Pool configuration support
880
943
Adam Delo ([@ol3d](https://github.com/ol3d)) - PCIe Passthrough Support
944
+
Antoine Thys ([@thystips](https://github.com/thystips)) - Metric Servers Support
881
945
882
946
[Full list of contributors](https://github.com/lae/ansible-role-proxmox/graphs/contributors)
0 commit comments