From 43894a5b00a76ee7fc2b6194ac10ba82d33c0b0d Mon Sep 17 00:00:00 2001 From: Cian Hatton Date: Sat, 13 Aug 2022 18:37:31 +0100 Subject: [PATCH] adding roles for hosted services --- .gitignore | 1 + ansible/roles/setup_hosted_services/.yamllint | 33 ++++++++++++ ansible/roles/setup_hosted_services/README.md | 38 +++++++++++++ .../setup_hosted_services/defaults/main.yml | 10 ++++ .../files/linkding/docker-compose.yml | 14 +++++ .../files/mealie/docker-compose.yml | 26 +++++++++ .../files/nextcloud/docker-compose.yml | 19 +++++++ .../files/overseerr/docker-compose.yml | 18 +++++++ .../setup_hosted_services/handlers/main.yml | 2 + .../roles/setup_hosted_services/meta/main.yml | 53 +++++++++++++++++++ .../molecule/default/converge.yml | 7 +++ .../molecule/default/molecule.yml | 29 ++++++++++ .../molecule/default/verify.yml | 10 ++++ .../setup_hosted_services/tasks/main.yml | 29 ++++++++++ .../setup_hosted_services/tests/inventory | 2 + .../setup_hosted_services/tests/test.yml | 5 ++ .../roles/setup_hosted_services/vars/main.yml | 2 + ansible/setup-homelab.yml | 3 ++ secrets-example.yml | 2 + 19 files changed, 303 insertions(+) create mode 100644 ansible/roles/setup_hosted_services/.yamllint create mode 100644 ansible/roles/setup_hosted_services/README.md create mode 100644 ansible/roles/setup_hosted_services/defaults/main.yml create mode 100644 ansible/roles/setup_hosted_services/files/linkding/docker-compose.yml create mode 100644 ansible/roles/setup_hosted_services/files/mealie/docker-compose.yml create mode 100644 ansible/roles/setup_hosted_services/files/nextcloud/docker-compose.yml create mode 100644 ansible/roles/setup_hosted_services/files/overseerr/docker-compose.yml create mode 100644 ansible/roles/setup_hosted_services/handlers/main.yml create mode 100644 ansible/roles/setup_hosted_services/meta/main.yml create mode 100644 ansible/roles/setup_hosted_services/molecule/default/converge.yml create mode 100644 ansible/roles/setup_hosted_services/molecule/default/molecule.yml create mode 100644 ansible/roles/setup_hosted_services/molecule/default/verify.yml create mode 100644 ansible/roles/setup_hosted_services/tasks/main.yml create mode 100644 ansible/roles/setup_hosted_services/tests/inventory create mode 100644 ansible/roles/setup_hosted_services/tests/test.yml create mode 100644 ansible/roles/setup_hosted_services/vars/main.yml create mode 100644 secrets-example.yml diff --git a/.gitignore b/.gitignore index e04276f..b1b151e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .idea +secrets.yml venv diff --git a/ansible/roles/setup_hosted_services/.yamllint b/ansible/roles/setup_hosted_services/.yamllint new file mode 100644 index 0000000..8827676 --- /dev/null +++ b/ansible/roles/setup_hosted_services/.yamllint @@ -0,0 +1,33 @@ +--- +# Based on ansible-lint config +extends: default + +rules: + braces: + max-spaces-inside: 1 + level: error + brackets: + max-spaces-inside: 1 + level: error + colons: + max-spaces-after: -1 + level: error + commas: + max-spaces-after: -1 + level: error + comments: disable + comments-indentation: disable + document-start: disable + empty-lines: + max: 3 + level: error + hyphens: + level: error + indentation: disable + key-duplicates: enable + line-length: disable + new-line-at-end-of-file: disable + new-lines: + type: unix + trailing-spaces: disable + truthy: disable diff --git a/ansible/roles/setup_hosted_services/README.md b/ansible/roles/setup_hosted_services/README.md new file mode 100644 index 0000000..225dd44 --- /dev/null +++ b/ansible/roles/setup_hosted_services/README.md @@ -0,0 +1,38 @@ +Role Name +========= + +A brief description of the role goes here. + +Requirements +------------ + +Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. + +Role Variables +-------------- + +A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. + +Dependencies +------------ + +A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. + +Example Playbook +---------------- + +Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: + + - hosts: servers + roles: + - { role: username.rolename, x: 42 } + +License +------- + +BSD + +Author Information +------------------ + +An optional section for the role authors to include contact information, or a website (HTML is not allowed). diff --git a/ansible/roles/setup_hosted_services/defaults/main.yml b/ansible/roles/setup_hosted_services/defaults/main.yml new file mode 100644 index 0000000..034015a --- /dev/null +++ b/ansible/roles/setup_hosted_services/defaults/main.yml @@ -0,0 +1,10 @@ +--- +docker_compose_directory: /etc/docker-compose +services: + - mealie + - linkding + - overseerr + - nextcloud + +docker_networks: + - nextcloud_net \ No newline at end of file diff --git a/ansible/roles/setup_hosted_services/files/linkding/docker-compose.yml b/ansible/roles/setup_hosted_services/files/linkding/docker-compose.yml new file mode 100644 index 0000000..5de089c --- /dev/null +++ b/ansible/roles/setup_hosted_services/files/linkding/docker-compose.yml @@ -0,0 +1,14 @@ +version: '3' +services: + linkding: + labels: + ie.cianhatton.backup.enabled: "true" + container_name: "linkding" + image: sissbruecker/linkding:latest + ports: + - "9090:9090" + volumes: + - "data:/etc/linkding/data" + restart: unless-stopped +volumes: + data: diff --git a/ansible/roles/setup_hosted_services/files/mealie/docker-compose.yml b/ansible/roles/setup_hosted_services/files/mealie/docker-compose.yml new file mode 100644 index 0000000..aaa2ded --- /dev/null +++ b/ansible/roles/setup_hosted_services/files/mealie/docker-compose.yml @@ -0,0 +1,26 @@ +--- +version: "3.1" +services: + mealie: + labels: + ie.cianhatton.backup.enabled: "true" + container_name: mealie + image: hkotel/mealie:latest + restart: unless-stopped + ports: + - 9925:80 + environment: + PUID: 1000 + PGID: 1000 + + # Default Recipe Settings + RECIPE_PUBLIC: 'true' + RECIPE_SHOW_NUTRITION: 'true' + RECIPE_SHOW_ASSETS: 'true' + RECIPE_LANDSCAPE_VIEW: 'true' + RECIPE_DISABLE_COMMENTS: 'false' + RECIPE_DISABLE_AMOUNT: 'false' + volumes: + - data:/app/data +volumes: + data: diff --git a/ansible/roles/setup_hosted_services/files/nextcloud/docker-compose.yml b/ansible/roles/setup_hosted_services/files/nextcloud/docker-compose.yml new file mode 100644 index 0000000..abeba30 --- /dev/null +++ b/ansible/roles/setup_hosted_services/files/nextcloud/docker-compose.yml @@ -0,0 +1,19 @@ +version: '3.2' +services: + nextcloud: + labels: + ie.cianhatton.backup.enabled: "true" + image: nextcloud + container_name: nextcloud + restart: unless-stopped + ports: + - 8081:80 + volumes: + - data:/var/www/html +volumes: + data: + +networks: + default: + name: nextcloud_net + external: true diff --git a/ansible/roles/setup_hosted_services/files/overseerr/docker-compose.yml b/ansible/roles/setup_hosted_services/files/overseerr/docker-compose.yml new file mode 100644 index 0000000..57acec9 --- /dev/null +++ b/ansible/roles/setup_hosted_services/files/overseerr/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3" +services: + overseerr: + labels: + ie.cianhatton.backup.enabled: "true" + image: sctx/overseerr:latest + container_name: overseerr + ports: + - 5055:5055 + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/London + volumes: + - "config:/app/config" + restart: unless-stopped +volumes: + config: diff --git a/ansible/roles/setup_hosted_services/handlers/main.yml b/ansible/roles/setup_hosted_services/handlers/main.yml new file mode 100644 index 0000000..fc6bcd9 --- /dev/null +++ b/ansible/roles/setup_hosted_services/handlers/main.yml @@ -0,0 +1,2 @@ +--- +# handlers file for setup_hosted_services diff --git a/ansible/roles/setup_hosted_services/meta/main.yml b/ansible/roles/setup_hosted_services/meta/main.yml new file mode 100644 index 0000000..fe3deea --- /dev/null +++ b/ansible/roles/setup_hosted_services/meta/main.yml @@ -0,0 +1,53 @@ +galaxy_info: + author: your name + namespace: chatton + description: your role description + company: your company (optional) + + # If the issue tracker for your role is not on github, uncomment the + # next line and provide a value + # issue_tracker_url: http://example.com/issue/tracker + + # Choose a valid license ID from https://spdx.org - some suggested licenses: + # - BSD-3-Clause (default) + # - MIT + # - GPL-2.0-or-later + # - GPL-3.0-only + # - Apache-2.0 + # - CC-BY-4.0 + license: license (GPL-2.0-or-later, MIT, etc) + + min_ansible_version: 2.1 + + # If this a Container Enabled role, provide the minimum Ansible Container version. + # min_ansible_container_version: + + # + # Provide a list of supported platforms, and for each platform a list of versions. + # If you don't wish to enumerate all versions for a particular platform, use 'all'. + # To view available platforms and versions (or releases), visit: + # https://galaxy.ansible.com/api/v1/platforms/ + # + # platforms: + # - name: Fedora + # versions: + # - all + # - 25 + # - name: SomePlatform + # versions: + # - all + # - 1.0 + # - 7 + # - 99.99 + + galaxy_tags: [] + # List tags for your role here, one per line. A tag is a keyword that describes + # and categorizes the role. Users find roles by searching for tags. Be sure to + # remove the '[]' above, if you add tags to this list. + # + # NOTE: A tag is limited to a single word comprised of alphanumeric characters. + # Maximum 20 tags per role. + +dependencies: [] + # List your role dependencies here, one per line. Be sure to remove the '[]' above, + # if you add dependencies to this list. diff --git a/ansible/roles/setup_hosted_services/molecule/default/converge.yml b/ansible/roles/setup_hosted_services/molecule/default/converge.yml new file mode 100644 index 0000000..2b0e738 --- /dev/null +++ b/ansible/roles/setup_hosted_services/molecule/default/converge.yml @@ -0,0 +1,7 @@ +--- +- name: Converge + hosts: all + tasks: + - name: "Include chatton.setup_hosted_services" + include_role: + name: "chatton.setup_hosted_services" diff --git a/ansible/roles/setup_hosted_services/molecule/default/molecule.yml b/ansible/roles/setup_hosted_services/molecule/default/molecule.yml new file mode 100644 index 0000000..105a768 --- /dev/null +++ b/ansible/roles/setup_hosted_services/molecule/default/molecule.yml @@ -0,0 +1,29 @@ +--- +dependency: + name: galaxy +driver: + name: docker +platforms: + - name: instance + image: geerlingguy/docker-debian10-ansible:latest + privileged: true + pre_build_image: true +provisioner: + name: ansible +verifier: + name: ansible +scenario: + test_sequence: + # - dependency + # - lint + # - cleanup + - destroy + - syntax + - create + # - prepare + - converge + - idempotence + # - side_effect + - verify + # - cleanup + - destroy \ No newline at end of file diff --git a/ansible/roles/setup_hosted_services/molecule/default/verify.yml b/ansible/roles/setup_hosted_services/molecule/default/verify.yml new file mode 100644 index 0000000..e707420 --- /dev/null +++ b/ansible/roles/setup_hosted_services/molecule/default/verify.yml @@ -0,0 +1,10 @@ +--- +# This is an example playbook to execute Ansible tests. + +- name: Verify + hosts: all + gather_facts: false + tasks: + - name: Example assertion + ansible.builtin.assert: + that: true diff --git a/ansible/roles/setup_hosted_services/tasks/main.yml b/ansible/roles/setup_hosted_services/tasks/main.yml new file mode 100644 index 0000000..4a121b9 --- /dev/null +++ b/ansible/roles/setup_hosted_services/tasks/main.yml @@ -0,0 +1,29 @@ +- name: Create a directory if it does not exist + ansible.builtin.file: + path: "{{docker_compose_directory}}/{{item}}" + state: directory + mode: '0755' + with_items: "{{services}}" + +- name: Copy Docker Compose Files + copy: + src: "{{item}}/docker-compose.yml" + dest: "{{docker_compose_directory}}/{{item}}/docker-compose.yml" + with_items: "{{services}}" + +- name: Install python dependencies + ansible.builtin.pip: + name: requests + +- name: Create required docker networks + docker_network: + name: "{{item}}" + with_items: "{{ docker_networks }}" + +- name: Update Portainer Stack + portainer: + username: admin + password: "{{portainer.password}}" + docker_compose_file_path: "{{docker_compose_directory}}/{{item}}/docker-compose.yml" + stack_name: "{{item}}" + with_items: "{{services}}" diff --git a/ansible/roles/setup_hosted_services/tests/inventory b/ansible/roles/setup_hosted_services/tests/inventory new file mode 100644 index 0000000..878877b --- /dev/null +++ b/ansible/roles/setup_hosted_services/tests/inventory @@ -0,0 +1,2 @@ +localhost + diff --git a/ansible/roles/setup_hosted_services/tests/test.yml b/ansible/roles/setup_hosted_services/tests/test.yml new file mode 100644 index 0000000..3532260 --- /dev/null +++ b/ansible/roles/setup_hosted_services/tests/test.yml @@ -0,0 +1,5 @@ +--- +- hosts: localhost + remote_user: root + roles: + - setup_hosted_services diff --git a/ansible/roles/setup_hosted_services/vars/main.yml b/ansible/roles/setup_hosted_services/vars/main.yml new file mode 100644 index 0000000..caa9bc1 --- /dev/null +++ b/ansible/roles/setup_hosted_services/vars/main.yml @@ -0,0 +1,2 @@ +--- +# vars file for setup_hosted_services \ No newline at end of file diff --git a/ansible/setup-homelab.yml b/ansible/setup-homelab.yml index ce2cbe1..5ae7177 100644 --- a/ansible/setup-homelab.yml +++ b/ansible/setup-homelab.yml @@ -1,7 +1,10 @@ --- - hosts: servers become: true + vars_files: + - ../secrets.yml roles: - role: 'roles/setup_users' - role: 'roles/setup_docker' - role: 'roles/setup_portainer' + - role: 'roles/setup_hosted_services' diff --git a/secrets-example.yml b/secrets-example.yml new file mode 100644 index 0000000..be42b0f --- /dev/null +++ b/secrets-example.yml @@ -0,0 +1,2 @@ +portainer: + password: ""