Additional comments and docs

ansible/README.md

@@ -1,3 +1,5 @@
 # Ansible
 
 Ansible playbooks, roles, modules, etc will come here. Documentation to come soon.
+
+Each playbook should have comments or a name descripter that explains what the playbook does or how it is used. If not available, README-... files can be used in place.

ansible/adhoc-ipagroups.yml

@@ -1,8 +1,6 @@
 ---
 # This playbook is meant to be used with callable variables, like adhoc or AWX.
-# However, adhoc, it works fine as long as you mention all required variables.
+# What: Creates groups in the idm infrastructure based on the variables provided.
-#
-# What: Creates groups in the idm infrastructure
 
 - name: Create our initial users
   hosts: ipaserver

ansible/adhoc-ipausers.yml

@@ -1,8 +1,7 @@
 ---
 # This playbook is meant to be used with callable variables, like adhoc or AWX.
-# However, adhoc, it works fine as long as you mention all required variables.
 # 
-# What: Creates users in the idm infrastructure
+# What: Creates users in the idm infrastructure based on the variables provided.
 
 - name: Create a User
   hosts: ipaserver

ansible/import-rockygroups.yml

@@ -1,4 +1,5 @@
 ---
+# Creates the first set of groups for the IdM Infrastructure
 - name: "Creating Mandatory Groups"
   ipagroup:
     ipaadmin_password: "{{ ipaadmin_password }}"

ansible/import-rockysudo.yml

@@ -1,4 +1,6 @@
 ---
+# Currently only one SUDO role should be created, and that is for the
+# rocky linux admins
 - name: "Creating SUDO Role for Rocky Admins"
   ipasudorule:
     ipaadmin_password: "{{ ipaadmin_password }}"

ansible/import-rockyusers.yml

@@ -1,4 +1,7 @@
 ---
+# Creates the first set of users for the IdM Infrastructure. This
+# should create both regular and admin accounts for separation of
+# privilege.
 - name: "Creating Initial Accounts"
   ipauser:
     ipaadmin_password: "{{ ipaadmin_password }}"

ansible/role-rocky-ipa-client.yml

@@ -1,4 +1,6 @@
 ---
+# Configures an IPA client for the Rocky infrastructure
+# Variables are in inventory/ipainventory
 - name: Configure IPA client
   hosts: ipaclients
   become: true

ansible/role-rocky-ipa-replica.yml

@@ -1,4 +1,6 @@
 ---
+# Creates an IPA replica
+# Variables are in inventory/ipainventory
 - name: Configure IPA server
   hosts: ipareplicas
   become: true

ansible/role-rocky-ipa.yml

@@ -1,4 +1,6 @@
 ---
+# Creates the first server for an IPA infrastructure
+# Variables for the infrastructure are in inventory/ipainventory
 - name: Configure IPA server
   hosts: ipaserver
   become: true