cleanup readme

This commit is contained in:
Robert Kaussow 2020-01-30 22:58:49 +01:00
parent 62e1c2d7ab
commit 7076252c65

197
README.md
View File

@ -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
### License
* [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)
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
### Maintainers and Contributors
## 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.
## License
MIT
## Author
[xoxys](https://gitea.rknet.org/xoxys)
[Robert Kaussow](https://gitea.rknet.org/xoxys)