Added README.md file

README.md

@@ -0,0 +1,21 @@
+# microk8s playbook
+
+## Introduction
+
+This is the top level playbook for the 'microk8s' role, which will install a
+microk8s cluster to three or more target hosts.
+
+This role requires at least three target hosts, previously deployed. Each
+host should have at least 4GB of RAM and at least a 20GB disk. The hosts
+should also be running Ubuntu LTS, 16.04, 18.04 or 20.04.
+
+It is also assumed that the user running the playbook has SSH key access
+set up for the root user on the target hosts.
+
+This playbook can be run using the following command line;
+
+    ansible-playbook -i <inventory file> -e "username=<username>" microk8s.yml
+
+    ie,
+    ansible-playbook -i microk8s_inventory.yml -e "username=ubuntu" microk8s.yml
+

ansible.cfg

@@ -1,17 +0,0 @@
-###########################################################################
-#
-# This is a custom ansible configuration file with select config values set
-# as required.
-#
-###########################################################################
-
-[defaults]
-callback_whitelist = profile_tasks
-command_warnings = False
-deprecation_warnings = False
-display_skipped_hosts = False
-host_key_checking = False
-stdout_callback = default
-interpreter_python = auto
-
-# EOF

microk8s.yml

@@ -19,7 +19,7 @@
 # ansible-playbook -i <inventory file> -e "username=<username>" microk8s.yml
 #
 # ie,
-# ansible-playbook -i microk8s_inventory.yml -e "username=joe" microk8s.yml
+# ansible-playbook -i microk8s_inventory.yml -e "username=ubuntu" microk8s.yml
 #
 ###########################################################################
 
@@ -35,7 +35,7 @@
         numhosts: "{{ groups['all'] | length }}"
         # Set the following variable as required
         # ie,
-        #     username: joe
+        #     username: ubuntu
         #
         # Default is to apply the playbook against the root user
         username: "root"