From d07670d7e2f6c7ac10c912907117399cb09c42fe Mon Sep 17 00:00:00 2001 From: nazunalika Date: Thu, 10 Dec 2020 00:42:05 -0700 Subject: [PATCH] Additional comments and docs --- ansible/README.md | 2 ++ ansible/adhoc-ipagroups.yml | 4 +--- ansible/adhoc-ipausers.yml | 3 +-- ansible/import-rockygroups.yml | 1 + ansible/import-rockysudo.yml | 2 ++ ansible/import-rockyusers.yml | 3 +++ ansible/role-rocky-ipa-client.yml | 2 ++ ansible/role-rocky-ipa-replica.yml | 2 ++ ansible/role-rocky-ipa.yml | 2 ++ 9 files changed, 16 insertions(+), 5 deletions(-) diff --git a/ansible/README.md b/ansible/README.md index 629a33b..bbee7f9 100644 --- a/ansible/README.md +++ b/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. diff --git a/ansible/adhoc-ipagroups.yml b/ansible/adhoc-ipagroups.yml index d651bc3..4217541 100644 --- a/ansible/adhoc-ipagroups.yml +++ b/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 +# What: Creates groups in the idm infrastructure based on the variables provided. - name: Create our initial users hosts: ipaserver diff --git a/ansible/adhoc-ipausers.yml b/ansible/adhoc-ipausers.yml index bfec2b1..36f8170 100644 --- a/ansible/adhoc-ipausers.yml +++ b/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 diff --git a/ansible/import-rockygroups.yml b/ansible/import-rockygroups.yml index d714417..f28e147 100644 --- a/ansible/import-rockygroups.yml +++ b/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 }}" diff --git a/ansible/import-rockysudo.yml b/ansible/import-rockysudo.yml index c4043dc..2463254 100644 --- a/ansible/import-rockysudo.yml +++ b/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 }}" diff --git a/ansible/import-rockyusers.yml b/ansible/import-rockyusers.yml index 3d5a3ea..6d4a4f9 100644 --- a/ansible/import-rockyusers.yml +++ b/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 }}" diff --git a/ansible/role-rocky-ipa-client.yml b/ansible/role-rocky-ipa-client.yml index f85a06d..696f062 100644 --- a/ansible/role-rocky-ipa-client.yml +++ b/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 diff --git a/ansible/role-rocky-ipa-replica.yml b/ansible/role-rocky-ipa-replica.yml index 70b01e9..6aa9986 100644 --- a/ansible/role-rocky-ipa-replica.yml +++ b/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 diff --git a/ansible/role-rocky-ipa.yml b/ansible/role-rocky-ipa.yml index 86fbc17..13f72c7 100644 --- a/ansible/role-rocky-ipa.yml +++ b/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