[SKIP CI] update readme

This commit is contained in:
Drone Shipper 2019-11-22 23:04:07 +00:00
parent b142454276
commit a5ad0516a6

120
README.md
View File

@ -8,25 +8,25 @@ Role to configure pve
## Table of content
* [Default Variables](#default-variables)
* [pve_nodes](#pve_nodes)
* [pve_tls_enabled](#pve_tls_enabled)
* [pve_tls_cert_source](#pve_tls_cert_source)
* [pve_tls_key_source](#pve_tls_key_source)
* [pve_pamd_motd_enabled](#pve_pamd_motd_enabled)
* [pve_disk_mount](#pve_disk_mount)
* [pve_auth_pam_is_default](#pve_auth_pam_is_default)
* [pve_auth_pam_description](#pve_auth_pam_description)
* [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_is_default](#pve_auth_pve_is_default)
* [pve_auth_pve_description](#pve_auth_pve_description)
* [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_auth_ldap_enabled](#pve_auth_ldap_enabled)
* [pve_auth_ldap_tfa_oath_enabled](#pve_auth_ldap_tfa_oath_enabled)
* [pve_auth_ldap_tfa_oath_timestep](#pve_auth_ldap_tfa_oath_timestep)
* [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)
@ -35,61 +35,44 @@ Role to configure pve
## Default Variables
### pve_nodes
### pve_auth_ldap_enabled
#### Default value
```YAML
pve_nodes:
- node1
pve_auth_ldap_enabled: false
```
### pve_tls_enabled
### pve_auth_ldap_tfa_oath_enabled
#### Default value
```YAML
pve_tls_enabled: false
pve_auth_ldap_tfa_oath_enabled: false
```
### pve_tls_cert_source
### pve_auth_ldap_tfa_oath_pwlength
#### Default value
```YAML
pve_tls_cert_source: mycert.pem
pve_auth_ldap_tfa_oath_pwlength: 6
```
### pve_tls_key_source
### pve_auth_ldap_tfa_oath_timestep
#### Default value
```YAML
pve_tls_key_source: mykey.pem
pve_auth_ldap_tfa_oath_timestep: 30
```
### pve_pamd_motd_enabled
### pve_auth_ldap_tfa_yubico_enabled
#### Default value
```YAML
pve_pamd_motd_enabled: true
```
### pve_disk_mount
#### Default value
```YAML
pve_disk_mount: []
```
### pve_auth_pam_is_default
#### Default value
```YAML
pve_auth_pam_is_default: true
pve_auth_ldap_tfa_yubico_enabled: false
```
### pve_auth_pam_description
@ -100,6 +83,14 @@ pve_auth_pam_is_default: true
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
@ -116,14 +107,6 @@ pve_auth_pam_tfa_oath_enabled: false
pve_auth_pam_tfa_yubico_enabled: false
```
### pve_auth_pve_is_default
#### Default value
```YAML
pve_auth_pve_is_default: false
```
### pve_auth_pve_description
#### Default value
@ -132,6 +115,14 @@ pve_auth_pve_is_default: false
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
@ -148,44 +139,53 @@ pve_auth_pve_tfa_oath_enabled: false
pve_auth_pve_tfa_yubico_enabled: false
```
### pve_auth_ldap_enabled
### pve_disk_mount
#### Default value
```YAML
pve_auth_ldap_enabled: false
pve_disk_mount: []
```
### pve_auth_ldap_tfa_oath_enabled
### pve_nodes
#### Default value
```YAML
pve_auth_ldap_tfa_oath_enabled: false
pve_nodes:
- node1
```
### pve_auth_ldap_tfa_oath_timestep
### pve_pamd_motd_enabled
#### Default value
```YAML
pve_auth_ldap_tfa_oath_timestep: 30
pve_pamd_motd_enabled: true
```
### pve_auth_ldap_tfa_oath_pwlength
### pve_tls_cert_source
#### Default value
```YAML
pve_auth_ldap_tfa_oath_pwlength: 6
pve_tls_cert_source: mycert.pem
```
### pve_auth_ldap_tfa_yubico_enabled
### pve_tls_enabled
#### Default value
```YAML
pve_auth_ldap_tfa_yubico_enabled: false
pve_tls_enabled: false
```
### pve_tls_key_source
#### Default value
```YAML
pve_tls_key_source: mykey.pem
```
## Dependencies