aboutsummaryrefslogtreecommitdiffstats
path: root/roles/freeipa_client
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-12 19:45:18 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-12 19:45:18 -0500
commit35e6469d69f97a5c7ec399d8b318c693c6ddf681 (patch)
treeb621be12f64c1c7fa28bad07a85915cda097c141 /roles/freeipa_client
parenta6c5b918849a92c02f7b135a4d674b8640812f7d (diff)
downloadselfhosted-35e6469d69f97a5c7ec399d8b318c693c6ddf681.tar.gz
selfhosted-35e6469d69f97a5c7ec399d8b318c693c6ddf681.zip
freeipa_client: add docs
Diffstat (limited to 'roles/freeipa_client')
-rw-r--r--roles/freeipa_client/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/roles/freeipa_client/README.md b/roles/freeipa_client/README.md
new file mode 100644
index 0000000..0ecbe44
--- /dev/null
+++ b/roles/freeipa_client/README.md
@@ -0,0 +1,32 @@
+FreeIPA Client
+==============
+
+Description
+-----------
+
+The `freeipa_client` role installs FreeIPA packages, joins the host to the
+local FreeIPA domain, and optionally configures `autofs`.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+-----------------|---------|------------
+`freeipa_autofs` | yes | Configure FreeIPA automount client
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: all
+ roles:
+ - role: freeipa_client
+ vars:
+ freeipa_autofs: yes
+````