doc: add documentation to clarify context

README.md

@@ -13,7 +13,13 @@ To deploy this role to a managed host, the following software must be installed
 * Python3
 * SSHd
 
-## General usage
+## Quick start
+
+```
+        ansible-playbook site.yml -i <INVENTORY_FILE> --limit <HOSTNAME>
+```
+
+## General Ansible usage
 
 Most options already have sensible defaults in `ansible.cfg`. However, you can override these defaults using CLI options/flags if you want to.
 

tasks/configure_repos.yml

 ---
+# Systems have to be subscribed with RedHat in order to be able to use software
+# repositories, install software and receive updates/support.
 - name: subscribe system with RedHat
   redhat_subscription:
     state: present
     username: "{{ vault_rhel_username }}"
     password: "{{ vault_rhel_password }}"
     auto_attach: true
-
 - name: activate RHEL repos
   rhsm_repository:
     name: "{{ item }}"
@@ -15,6 +16,9 @@
     - "rhel-7-server-rh-common-rpms"
     - "rhel-7-server-extras-rpms"
 
+# Additional software is made available through the EPEL (Extra Packages for
+# Enterprise Linux) repository, which is managed by the Fedora Special Interest
+# Group of the same name.
 - name: activate EPEL repos
   yum:
     name: "https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm"

tasks/install_tsm_client.yml

@@ -5,7 +5,7 @@
     dest: "/tmp/"
     checksum: "{{ tsm_checksum | default(tsm_default_checksum) }}"
 
-- name: create extraction dir
+- name: create temporary extraction dir
   file:
     path: "/tmp/tsm/"
     state: directory
@@ -30,7 +30,7 @@
     ]
   become: true
 
-- name: manage service
+- name: make sure IBM Spectrum Protect backup service is active and running
   systemd:
     name: "dsmcad.service"
     enabled: true

tasks/main.yml

@@ -7,7 +7,7 @@
     - "users.vault"
   tags: [always]
 
-- name: prepare skel
+- name: prepare default skel configuration for new users
   import_tasks: configure_skel.yml
   tags: [skel]
 
@@ -19,7 +19,7 @@
   import_tasks: configure_ssh_client.yml
   tags: [ssh]
 
-- name: activate repos
+- name: activate software repositories
   import_tasks: configure_repos.yml
   tags: [repos]