aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--roles/ssh/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/roles/ssh/README.md b/roles/ssh/README.md
new file mode 100644
index 0000000..1975b0b
--- /dev/null
+++ b/roles/ssh/README.md
@@ -0,0 +1,34 @@
+SSH
+===
+
+Description
+-----------
+
+The `ssh` role configures SSH clients to use GSSAPI authentication for hosts
+within the local FreeIPA domain.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+------------------------|----------------------------|------------
+`ssh_canonical_domains` | `['{{ ansible_domain }}']` | Host domains to canonicalize for Kerberos/GSSAPI
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: configure kerberized ssh
+ hosts: all
+ roles:
+ - role: ssh
+ vars:
+ ssh_canonical_domains:
+ - ipa.example.com
+````