aboutsummaryrefslogtreecommitdiffstats
path: root/roles/freeipa_system_account
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-12 21:43:57 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-12 21:43:57 -0500
commitf61a2579772f0e4d97f1b70cd8c0acd1d2aa7604 (patch)
tree1d3bb168a71c9b04bdf8b1b92b38ba3830b7e054 /roles/freeipa_system_account
parentcaf150f08515ebf89c89725e7881a9dfc5d9a50b (diff)
downloadselfhosted-f61a2579772f0e4d97f1b70cd8c0acd1d2aa7604.tar.gz
selfhosted-f61a2579772f0e4d97f1b70cd8c0acd1d2aa7604.zip
freeipa_system_account: add docs
Diffstat (limited to 'roles/freeipa_system_account')
-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` | &nbsp; | System account username
+`system_account_password` | &nbsp; | 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
+````