From 7076252c653d10e8256c67d197b179e7f64d3fde Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Thu, 30 Jan 2020 22:58:49 +0100 Subject: [PATCH] cleanup readme --- README.md | 199 ++---------------------------------------------------- 1 file changed, 6 insertions(+), 193 deletions(-) diff --git a/README.md b/README.md index 40b527d..7c3d2ae 100644 --- a/README.md +++ b/README.md @@ -1,201 +1,14 @@ # xoxys.pve - -[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.pve/status.svg)](https://drone.rknet.org/ansible/xoxys.pve) +[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.pve?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.pve) -Role to configure pve - -## Table of content - -* [Default Variables](#default-variables) - * [pve_auth_ldap_enabled](#pve_auth_ldap_enabled) - * [pve_auth_ldap_tfa_oath_enabled](#pve_auth_ldap_tfa_oath_enabled) - * [pve_auth_ldap_tfa_oath_pwlength](#pve_auth_ldap_tfa_oath_pwlength) - * [pve_auth_ldap_tfa_oath_timestep](#pve_auth_ldap_tfa_oath_timestep) - * [pve_auth_ldap_tfa_yubico_enabled](#pve_auth_ldap_tfa_yubico_enabled) - * [pve_auth_pam_description](#pve_auth_pam_description) - * [pve_auth_pam_is_default](#pve_auth_pam_is_default) - * [pve_auth_pam_tfa_oath_enabled](#pve_auth_pam_tfa_oath_enabled) - * [pve_auth_pam_tfa_yubico_enabled](#pve_auth_pam_tfa_yubico_enabled) - * [pve_auth_pve_description](#pve_auth_pve_description) - * [pve_auth_pve_is_default](#pve_auth_pve_is_default) - * [pve_auth_pve_tfa_oath_enabled](#pve_auth_pve_tfa_oath_enabled) - * [pve_auth_pve_tfa_yubico_enabled](#pve_auth_pve_tfa_yubico_enabled) - * [pve_disk_mount](#pve_disk_mount) - * [pve_nodes](#pve_nodes) - * [pve_pamd_motd_enabled](#pve_pamd_motd_enabled) - * [pve_tls_cert_source](#pve_tls_cert_source) - * [pve_tls_enabled](#pve_tls_enabled) - * [pve_tls_key_source](#pve_tls_key_source) -* [Dependencies](#dependencies) -* [License](#license) -* [Author](#author) - ---- - -## Default Variables - -### pve_auth_ldap_enabled - -#### Default value - -```YAML -pve_auth_ldap_enabled: false -``` - -### pve_auth_ldap_tfa_oath_enabled - -#### Default value - -```YAML -pve_auth_ldap_tfa_oath_enabled: false -``` - -### pve_auth_ldap_tfa_oath_pwlength - -#### Default value - -```YAML -pve_auth_ldap_tfa_oath_pwlength: 6 -``` - -### pve_auth_ldap_tfa_oath_timestep - -#### Default value - -```YAML -pve_auth_ldap_tfa_oath_timestep: 30 -``` - -### pve_auth_ldap_tfa_yubico_enabled - -#### Default value - -```YAML -pve_auth_ldap_tfa_yubico_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_pam_tfa_oath_enabled - -#### Default value - -```YAML -pve_auth_pam_tfa_oath_enabled: false -``` - -### pve_auth_pam_tfa_yubico_enabled - -#### Default value - -```YAML -pve_auth_pam_tfa_yubico_enabled: false -``` -### 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_auth_pve_tfa_oath_enabled - -#### Default value - -```YAML -pve_auth_pve_tfa_oath_enabled: false -``` - -### pve_auth_pve_tfa_yubico_enabled - -#### Default value - -```YAML -pve_auth_pve_tfa_yubico_enabled: 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 -``` - -### pve_tls_cert_source - -#### Default value - -```YAML -pve_tls_cert_source: mycert.pem -``` - -### pve_tls_enabled - -#### Default value - -```YAML -pve_tls_enabled: false -``` - -### pve_tls_key_source - -#### Default value - -```YAML -pve_tls_key_source: mykey.pem -``` - -## Dependencies - -None. +Role to configure pve -## License +### License -MIT +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. -## Author +### Maintainers and Contributors -[xoxys](https://gitea.rknet.org/xoxys) +[Robert Kaussow](https://gitea.rknet.org/xoxys)