diff --git a/README.md b/README.md index 64837d9..93733ad 100644 --- a/README.md +++ b/README.md @@ -1 +1,114 @@ # xoxys.pve + +[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.pve/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.pve) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.pve/src/branch/main/LICENSE) + +Basic role to configure a [Proxmox VE](https://www.proxmox.com/en/proxmox-ve) server. +Proxmox VE is a complete open-source platform for all-inclusive enterprise virtualization +that tightly integrates KVM hypervisor and LXC containers, software-defined storage and +networking functionality on a single platform. + +{{< hint type=important >}} +This role covers only some really basic configurations and should be considered as not production ready. +{{< /hint >}} + +## Table of content + +- [Requirements](#requirements) +- [Default Variables](#default-variables) + - [pve_auth_ldap_enabled](#pve_auth_ldap_enabled) + - [pve_auth_pam_description](#pve_auth_pam_description) + - [pve_auth_pam_is_default](#pve_auth_pam_is_default) + - [pve_auth_pve_description](#pve_auth_pve_description) + - [pve_auth_pve_is_default](#pve_auth_pve_is_default) + - [pve_disk_mount](#pve_disk_mount) + - [pve_nodes](#pve_nodes) + - [pve_pamd_motd_enabled](#pve_pamd_motd_enabled) +- [Dependencies](#dependencies) +- [License](#license) +- [Author](#author) + +--- + +## Requirements + +- Minimum Ansible version: `2.10` + +## Default Variables + +### pve_auth_ldap_enabled + +#### Default value + +```YAML +pve_auth_ldap_enabled: false +``` + +### pve_auth_pam_description + +#### Default value + +```YAML +pve_auth_pam_description: Linux PAM standard authentication +``` + +### pve_auth_pam_is_default + +#### Default value + +```YAML +pve_auth_pam_is_default: true +``` + +### pve_auth_pve_description + +#### Default value + +```YAML +pve_auth_pve_description: Linux pve standard authentication +``` + +### pve_auth_pve_is_default + +#### Default value + +```YAML +pve_auth_pve_is_default: false +``` + +### pve_disk_mount + +#### Default value + +```YAML +pve_disk_mount: [] +``` + +### pve_nodes + +#### Default value + +```YAML +pve_nodes: + - node1 +``` + +### pve_pamd_motd_enabled + +#### Default value + +```YAML +pve_pamd_motd_enabled: true +``` + +## Dependencies + +None. + +## License + +MIT + +## Author + +[Robert Kaussow](https://gitea.rknet.org/xoxys)