adding some ansible-doc docs

roles/bootstrap/README.md

@@ -0,0 +1,25 @@
+# 
+
+Role to bootstrap a target host. This role will add an ansible user and allow paswordless sudo.
+
+## Table of content
+
+- [Dependencies](#dependencies)
+- [License](#license)
+- [Author](#author)
+
+---
+
+
+
+## Dependencies
+
+None.
+
+## License
+
+['MIT']
+
+## Author
+
+Cian Hatton

roles/bootstrap/tasks/main.yml

@@ -1,3 +1,9 @@
+# @meta author: Cian Hatton
+# @meta description: >
+# Role to bootstrap a target host. This role will add an ansible
+# user and allow paswordless sudo.
+# @end
+
 ---
 - name: Update Packages
   apt:

roles/setup_docker/README.md

@@ -0,0 +1,25 @@
+# setup_docker
+
+Role to install docker. It also installs the docker and docker compose python modules.
+
+## Table of content
+
+- [Dependencies](#dependencies)
+- [License](#license)
+- [Author](#author)
+
+---
+
+
+
+## Dependencies
+
+None.
+
+## License
+
+license (GPL-2.0-or-later, MIT, etc)
+
+## Author
+
+Cian Hatton

roles/setup_docker/meta/main.yml

@@ -1,5 +1,5 @@
 galaxy_info:
-  author: your name
+  author: Cian Hatton
   namespace: chatton
   description: your role description
   company: your company (optional)
@@ -15,7 +15,7 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
   min_ansible_version: 2.1
 

roles/setup_docker/tasks/main.yml

@@ -1,3 +1,10 @@
+# @meta author: Cian Hatton
+# @meta description: >
+# Role to install docker. It also installs the docker and docker compose python
+# modules.
+# @end
+
+
 # following official instructions here: https://docs.docker.com/engine/install/debian/
 - name: Install packages using apt
   apt:

roles/setup_hosted_services/meta/main.yml

@@ -3,7 +3,7 @@ galaxy_info:
   namespace: chatton
   description: your role description
   company: your company (optional)
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
   min_ansible_version: 2.1
   galaxy_tags: []
     # List tags for your role here, one per line. A tag is a keyword that describes

roles/setup_linode/meta/main.yml

@@ -1,5 +1,5 @@
 galaxy_info:
-  author: your name
+  author: Cian Hatton
   namespace: chatton
   description: your role description
   company: your company (optional)
@@ -15,7 +15,7 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
   min_ansible_version: 2.1
 

roles/setup_mergerfs/meta/main.yml

@@ -1,5 +1,5 @@
 galaxy_info:
-  author: your name
+  author: Cian Hatton
   namespace: chatton
   description: your role description
   company: your company (optional)
@@ -15,7 +15,7 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
   min_ansible_version: 2.1
 

roles/setup_portainer/README.md

@@ -0,0 +1,25 @@
+# setup_portainer
+
+Role to configure Portainer. This role copies the docker-compose.yml onto the host and starts portainer with docker compose. If there is a backup of the portainer volume stored in s3, it will be restored before portainer is started.
+
+## Table of content
+
+- [Dependencies](#dependencies)
+- [License](#license)
+- [Author](#author)
+
+---
+
+
+
+## Dependencies
+
+None.
+
+## License
+
+MIT
+
+## Author
+
+Cian Hatton

roles/setup_portainer/meta/main.yml

@@ -1,5 +1,5 @@
 galaxy_info:
-  author: your name
+  author: Cian Hatton
   namespace: chatton
   description: your role description
   company: your company (optional)
@@ -15,7 +15,7 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
   min_ansible_version: 2.1
 

roles/setup_portainer/tasks/main.yml

@@ -1,3 +1,11 @@
+# @meta author: Cian Hatton
+# @meta description: >
+# Role to configure Portainer. This role copies the docker-compose.yml
+# onto the host and starts portainer with docker compose.
+# If there is a backup of the portainer volume stored in s3, it will
+# be restored before portainer is started.
+# @end
+
 ---
 - name: Portainer | Create directory if it does not exist
   ansible.builtin.file:

roles/setup_samba/meta/main.yml

@@ -1,5 +1,5 @@
 galaxy_info:
-  author: your name
+  author: Cian Hatton
   namespace: chatton
   description: your role description
   company: your company (optional)
@@ -15,7 +15,7 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
   min_ansible_version: 2.1
 

roles/setup_users/meta/main.yml

@@ -1,5 +1,5 @@
 galaxy_info:
-  author: your name
+  author: Cian Hatton
   namespace: chatton
   description: your role description
   company: your company (optional)
@@ -15,7 +15,7 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
   min_ansible_version: 2.1