docs(ansible): Document basic functionality

.gitignore

@@ -1,3 +1,4 @@
 # ---> Ansible
 *.retry
-
+ansible/hosts.yml
+ansible/group_vars/*/vars.yml

README.md

@@ -1,3 +1,16 @@
 # ansible-package-upgrades
 
 No-frills Ansible playbook to run ad-hoc package upgrades
+
+## Run it
+
+Run it like so:
+```
+ansible-playbook --inventory hosts.yml playbook.yml --limit <hostgroup>
+```
+
+## Vars
+
+* Create your inventory for example at `ansible/hosts.yml`, an exampe file is located at [ansible/hosts.yml.example](ansible/hosts.yml.example).
+
+* Set host group vars as needed, an example file for the `all` group is at [ansible/group_vars/all/vars.yml.example](ansible/group_vars/all/vars.yml.example).

ansible/group_vars/all/vars.yml.example

@@ -0,0 +1 @@
+ansible_user: 'root'

ansible/hosts.yml.example

@@ -0,0 +1,8 @@
+all:
+  children:
+    groupone:
+      hosts: 
+        fully.qualified.domain.name:
+    grouptwo:
+      hosts:
+        anotherfully.qualified.domain.name

ansible/playbook.yml

@@ -0,0 +1,4 @@
+- name: 'Upgrade packages and reboot where needed'
+  hosts: all
+  roles:
+    - '20-common-40-package-upgrades'

ansible/roles/20-common-40-package-upgrades/tasks/40-packages.yml

@@ -0,0 +1,17 @@
+- name: 'Upgrade the OS (apt-get dist-upgrade)'
+  ansible.builtin.apt:
+    update_cache: 'yes'
+    upgrade: 'dist'
+
+
+
+- name: 'Check if reboot required'
+  register: reboot_required_file
+  ansible.builtin.stat:
+    path: '/var/run/reboot-required'
+
+
+
+- name: 'Reboot if required'
+  when: '(reboot_required_file.stat.exists == true)'
+  ansible.builtin.reboot:

ansible/roles/20-common-40-package-upgrades/tasks/main.yml

@@ -0,0 +1 @@
+- import_tasks: '40-packages.yml'