From d73ed64e82f4342ff11a8a28780aba89653eea2e Mon Sep 17 00:00:00 2001 From: Cian Hatton Date: Mon, 29 Aug 2022 22:16:15 +0100 Subject: [PATCH] adding some ansible-doc docs --- roles/bootstrap/README.md | 25 +++++++++++++++++++++++ roles/bootstrap/tasks/main.yml | 6 ++++++ roles/setup_docker/README.md | 25 +++++++++++++++++++++++ roles/setup_docker/meta/main.yml | 4 ++-- roles/setup_docker/tasks/main.yml | 7 +++++++ roles/setup_hosted_services/meta/main.yml | 2 +- roles/setup_linode/meta/main.yml | 4 ++-- roles/setup_mergerfs/meta/main.yml | 4 ++-- roles/setup_portainer/README.md | 25 +++++++++++++++++++++++ roles/setup_portainer/meta/main.yml | 4 ++-- roles/setup_portainer/tasks/main.yml | 8 ++++++++ roles/setup_samba/meta/main.yml | 4 ++-- roles/setup_users/meta/main.yml | 4 ++-- 13 files changed, 109 insertions(+), 13 deletions(-) create mode 100644 roles/bootstrap/README.md create mode 100644 roles/setup_docker/README.md create mode 100644 roles/setup_portainer/README.md diff --git a/roles/bootstrap/README.md b/roles/bootstrap/README.md new file mode 100644 index 0000000..56c035b --- /dev/null +++ b/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 diff --git a/roles/bootstrap/tasks/main.yml b/roles/bootstrap/tasks/main.yml index 8ffcfac..665971e 100644 --- a/roles/bootstrap/tasks/main.yml +++ b/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: diff --git a/roles/setup_docker/README.md b/roles/setup_docker/README.md new file mode 100644 index 0000000..0916d66 --- /dev/null +++ b/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 diff --git a/roles/setup_docker/meta/main.yml b/roles/setup_docker/meta/main.yml index fe3deea..6bfa85e 100644 --- a/roles/setup_docker/meta/main.yml +++ b/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 diff --git a/roles/setup_docker/tasks/main.yml b/roles/setup_docker/tasks/main.yml index c25b7d2..78cba8b 100644 --- a/roles/setup_docker/tasks/main.yml +++ b/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: diff --git a/roles/setup_hosted_services/meta/main.yml b/roles/setup_hosted_services/meta/main.yml index ad73214..c934c93 100644 --- a/roles/setup_hosted_services/meta/main.yml +++ b/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 diff --git a/roles/setup_linode/meta/main.yml b/roles/setup_linode/meta/main.yml index fe3deea..6bfa85e 100644 --- a/roles/setup_linode/meta/main.yml +++ b/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 diff --git a/roles/setup_mergerfs/meta/main.yml b/roles/setup_mergerfs/meta/main.yml index fe3deea..6bfa85e 100644 --- a/roles/setup_mergerfs/meta/main.yml +++ b/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 diff --git a/roles/setup_portainer/README.md b/roles/setup_portainer/README.md new file mode 100644 index 0000000..2867623 --- /dev/null +++ b/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 diff --git a/roles/setup_portainer/meta/main.yml b/roles/setup_portainer/meta/main.yml index fe3deea..6bfa85e 100644 --- a/roles/setup_portainer/meta/main.yml +++ b/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 diff --git a/roles/setup_portainer/tasks/main.yml b/roles/setup_portainer/tasks/main.yml index 9dc58ab..2aecbf5 100644 --- a/roles/setup_portainer/tasks/main.yml +++ b/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: diff --git a/roles/setup_samba/meta/main.yml b/roles/setup_samba/meta/main.yml index fe3deea..6bfa85e 100644 --- a/roles/setup_samba/meta/main.yml +++ b/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 diff --git a/roles/setup_users/meta/main.yml b/roles/setup_users/meta/main.yml index fe3deea..6bfa85e 100644 --- a/roles/setup_users/meta/main.yml +++ b/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