Merge branch 'release/0.2.4'

CHANGELOG

@@ -1,3 +1,7 @@
+0.2.4 13 January 2014 Matt Willsher <matt@willsher.systems>
+- Allow reload to be skipped
+- Test for OS support
+- Documentation improvements
 0.2.3 13 January 2014 Matt Willsher <matt@willsher.systems>
 - Fixed HostbasedAuthentication typo
 0.2.2 13 January 2014 Matt Willsher <matt@willsher.systems>

README.md

@@ -39,12 +39,24 @@ It will likely work on other flavours and more direct support via suitable
 Role variables
 ---------------
 
-* Unconfigured, this role will provide a sshd_config that matches the OS default,
+Unconfigured, this role will provide a sshd_config that matches the OS default,
 minus the comments and in a different order.
 
-* Defaults can be disabled by setting `sshd_skip_defaults: true`
+* sshd_skip_defaults
 
-* Supports use of a dict to configure items:
+If set to True, don't apply default values. This means that you must have a
+complete set of configuration defaults via either the sshd dict, or sshd_Key
+variables. Defaults to *False*.
+
+* sshd_allow_reload
+
+If set to False, a reload of sshd wont happen on change. This can help with 
+troubleshooting. You'll need to manually reload sshd if you want to apply the
+changed configuration. Defaults to *True*.
+
+* sshd
+
+A dict containing configuration.  e.g.
 
 ```yaml
 sshd:
@@ -53,15 +65,17 @@ sshd:
     - 0.0.0.0
 ```
 
-* Simple variables can be used rather than a dict. Simple values override dict
+* ssh_...
-values:
+
+Simple variables can be used rather than a dict. Simple values override dict
+values. e.g.:
 
 ```yaml
 sshd_Compression: off
 ```
 
-* Correctly interprets booleans as yes and no in sshd configuration
+In all cases, booleans correctly rendered as yes and no in sshd configuration.
-* Supports lists for multi line configuration items:
+Lists can be used for multiline configuration items. e.g.
 
 ```yaml
 sshd_ListenAddress:
@@ -69,7 +83,20 @@ sshd_ListenAddress:
   - '::'
 ```
 
-* Supports match section either via Match in the sshd dict, sshd_match and any of sshd_match_1 through sshd_match_9. Match items can either be a dict or an array.
+Renders as:
+
+```
+ListenAddress 0.0.0.0
+ListenAddress ::
+```
+
+* sshd_match
+
+A list of dicts for a match section. See the example playbook.
+
+* sshd_match_1 through sshd_match_9
+
+A list of dicts or just a dict for a Match section.
 
 Example Playbook
 ----------------

defaults/main.yml

@@ -2,6 +2,8 @@
 ### USER OPTIONS
 # Don't apply OS defaults when set to true
 sshd_skip_defaults: false
+# If the below is false, don't reload the ssh deamon on change
+sshd_allow_reload: yes
 # Empty dicts to avoid errors
 sshd: {}
 
@@ -18,3 +20,4 @@ sshd_binary: /usr/sbin/sshd
 sshd_service: sshd
 sshd_sftp_server: /usr/lib/openssh/sftp-server
 sshd_defaults: {}
+sshd_os_supported: no

handlers/main.yml

@@ -7,3 +7,4 @@
   service:
     name: "{{ sshd_service }}"
     state: reloaded
+  when: sshd_allow_reload == True

tasks/main.yml

@@ -6,10 +6,13 @@
    - "{{ ansible_distribution }}.yml"
    - "{{ ansible_os_family }}_{{ ansible_distribution_major_version }}.yml"
    - "{{ ansible_os_family }}.yml"
-   - default.yml
   tags:
     - sshd
 
+- name: OS is supported
+  assert:
+    that: sshd_os_supported == True
+
 - name: Installed
   action: >
     {{ ansible_pkg_mgr }}
@@ -37,4 +40,3 @@
     state: running
   tags:
     - sshd
-

vars/Amazon.yml

@@ -20,3 +20,4 @@ sshd:
     - LC_IDENTIFICATION LC_ALL LANGUAGE
     - XMODIFIERS
   Subsystem: "sftp {{ sshd_sftp_server }}"
+sshd_os_supported: yes

vars/Archlinux.yml

@@ -12,3 +12,4 @@ sshd_defaults:
   Subsystem: "sftp {{ sshd_sftp_server }}"
   UsePAM: yes
   UsePrivilegeSeparation: sandbox
+sshd_os_supported: yes

vars/Debian.yml

@@ -34,3 +34,4 @@ sshd_defaults:
   AcceptEnv: LANG LC_*
   Subsystem: "sftp {{ sshd_sftp_server }}"
   UsePAM: yes
+sshd_os_supported: yes

vars/Debian_8.yml

@@ -35,3 +35,4 @@ sshd_defaults:
   AcceptEnv: LANG LC_*
   Subsystem: "sftp {{ sshd_sftp_server }}"
   UsePAM: yes
+sshd_os_supported: yes

vars/FreeBSD.yml

@@ -2,3 +2,4 @@
 sshd_config_group: wheel
 sshd_config_mode: "0644"
 sshd_sftp_server: /usr/libexec/sftp-server
+sshd_os_supported: yes

vars/RedHat_6.yml

@@ -18,3 +18,4 @@ sshd_defaults:
     - XMODIFIERS
   X11Forwarding: yes
   Subsystem: "sftp {{ sshd_sftp_server }}"
+sshd_os_supported: yes

vars/RedHat_7.yml

@@ -22,3 +22,4 @@ sshd_defaults:
     - LC_IDENTIFICATION LC_ALL LANGUAGE
     - XMODIFIERS
   Subsystem: "sftp {{ sshd_sftp_server }}"
+sshd_os_supported: yes

vars/Ubuntu_12.yml

@@ -33,3 +33,4 @@ sshd_defaults:
   AcceptEnv: LANG LC_*
   Subsystem: "sftp {{ sshd_sftp_server }}"
   UsePAM: yes
+sshd_os_supported: yes

vars/Ubuntu_14.yml

@@ -35,3 +35,4 @@ sshd_defaults:
   AcceptEnv: LANG LC_*
   Subsystem: "sftp {{ sshd_sftp_server }}"
   UsePAM: yes
+sshd_os_supported: yes