Document missing configuraiton variables & sort

as recommended by best practices:

> Every argument accepted from outside of the role should be given
> a default value in defaults/main.yml.

https://github.com/oasis-roles/meta_standards#vars-vs-defaults
This commit is contained in:
Jakub Jelen 2020-11-04 15:56:03 +01:00
parent 22ed476ab4
commit 7741a06714

View file

@ -10,6 +10,9 @@ sshd_skip_defaults: false
# daemon at all # daemon at all
sshd_manage_service: true sshd_manage_service: true
# If the below is false, don't reload the ssh daemon on change
sshd_allow_reload: true
# If the below is true, also install service files from the templates pointed # If the below is true, also install service files from the templates pointed
# to by the `sshd_service_template_*` variables # to by the `sshd_service_template_*` variables
sshd_install_service: false sshd_install_service: false
@ -17,9 +20,6 @@ sshd_service_template_service: sshd.service.j2
sshd_service_template_at_service: sshd@.service.j2 sshd_service_template_at_service: sshd@.service.j2
sshd_service_template_socket: sshd.socket.j2 sshd_service_template_socket: sshd.socket.j2
# If the below is false, don't reload the ssh daemon on change
sshd_allow_reload: true
# If the below is true, create a backup of the config file when the template is copied # If the below is true, create a backup of the config file when the template is copied
sshd_backup: true sshd_backup: true
@ -39,6 +39,10 @@ sshd_sysconfig_use_strong_rng: 0
# Empty dicts to avoid errors # Empty dicts to avoid errors
sshd: {} sshd: {}
# The path to sshd_config file. This is useful when creating an included
# configuration file snippet or configuring second sshd service
sshd_config_file: /etc/ssh/sshd_config
### VARS DEFAULTS ### VARS DEFAULTS
### The following are defaults for OS specific configuration in var files in ### The following are defaults for OS specific configuration in var files in
### this role. They should not be set directly by role users. ### this role. They should not be set directly by role users.