From 65c5a6e081ce7174ecd36c89329aa77e7dd77a0b Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Sun, 19 Feb 2023 20:53:29 -0500
Subject: root_password: add docs

---
 roles/root_password/README.md         | 34 ++++++++++++++++++++++++++++++++++
 roles/root_password/defaults/main.yml |  1 -
 2 files changed, 34 insertions(+), 1 deletion(-)
 create mode 100644 roles/root_password/README.md

(limited to 'roles/root_password')

diff --git a/roles/root_password/README.md b/roles/root_password/README.md
new file mode 100644
index 0000000..cc18e77
--- /dev/null
+++ b/roles/root_password/README.md
@@ -0,0 +1,34 @@
+Root Password
+=============
+
+Description
+-----------
+
+The `root_password` role sets the password for the root user.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable             | Default | Description
+---------------------|---------|------------
+`root_password`      | &nbsp;  | Root password
+`root_password_salt` | `''`    | Salt for SHA-512 hash
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: set root password
+  hosts: all
+  roles:
+    - role: root_password
+      vars:
+        root_password: s3cret
+        root_password_salt: changeme
+````
diff --git a/roles/root_password/defaults/main.yml b/roles/root_password/defaults/main.yml
index 23f5768..ff1eb48 100644
--- a/roles/root_password/defaults/main.yml
+++ b/roles/root_password/defaults/main.yml
@@ -1,2 +1 @@
-root_password: changeme
 root_password_salt: ''
-- 
cgit