aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--roles/freeipa_system_account/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/roles/freeipa_system_account/README.md b/roles/freeipa_system_account/README.md
new file mode 100644
index 0000000..68e4341
--- /dev/null
+++ b/roles/freeipa_system_account/README.md
@@ -0,0 +1,37 @@
+FreeIPA System Account
+======================
+
+Description
+-----------
+
+The `freeipa_system_account` role creates a FreeIPA [system account](https://www.freeipa.org/page/HowTo/LDAP#System_Accounts)
+with the provided username and password.
+
+System accounts are limited to LDAP queries only; they have no POSIX attributes,
+cannot log into any systems, etc.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+--------------------------|---------|------------
+`system_account_username` |   | System account username
+`system_account_password` |   | System account password
+
+
+Usage
+-----
+
+Example tasks:
+
+````yaml
+- name: create system account for ldap binds
+ include_role:
+ name: freeipa_system_account
+ vars:
+ system_account_username: apache
+ system_account_password: s3cret
+````