Experiment with ansible folder structure (#2)

.github/workflows/ci.yaml

@@ -7,12 +7,17 @@ on:
       - "master"
 
 jobs:
-  run-tests:
+  homelab-test:
     runs-on: ubuntu-latest
     steps:
-      - name: "Checkout Repository"
-        uses: actions/checkout@v3
-      - name: "Build and Run Test Image"
-        run : |
-          docker build . -t test
-          docker run test
+      - uses: actions/checkout@v2
+#      - name: "pull image"
+#        run: docker pull geerlingguy/docker-debian10-ansible:latest
+#      - name: Molecule
+#        uses: gofrolist/molecule-action@v2
+#        with:
+#          molecule_command: test
+#          molecule_working_dir: ansible/roles/setup_docker
+#        env:
+#          ANSIBLE_FORCE_COLOR: '1'
+#          PY_COLORS: "1"

_ansible/homelab/tasks/install-sudo-tasks.yml

@@ -24,4 +24,4 @@
     name: "{{homelab_user}}"
     comment: "{{homelab_user}} user"
     uid: 1000
-    group: "{{homelab_group}}"
+    group: "{{homelab_group}}"

ansible/hosts.ini

@@ -0,0 +1,2 @@
+[servers]
+cianhatton@qnap

ansible/roles/setup_docker/.travis.yml

@@ -0,0 +1,29 @@
+---
+language: python
+python: "2.7"
+
+# Use the new container infrastructure
+sudo: false
+
+# Install ansible
+addons:
+  apt:
+    packages:
+    - python-pip
+
+install:
+  # Install ansible
+  - pip install ansible
+
+  # Check ansible version
+  - ansible --version
+
+  # Create ansible.cfg with correct roles_path
+  - printf '[defaults]\nroles_path=../' >ansible.cfg
+
+script:
+  # Basic role syntax check
+  - ansible-playbook tests/test.yml -i tests/inventory --syntax-check
+
+notifications:
+  webhooks: https://galaxy.ansible.com/api/v1/notifications/

ansible/roles/setup_docker/.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

ansible/roles/setup_docker/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).

ansible/roles/setup_docker/defaults/main.yml

@@ -0,0 +1 @@
+---

ansible/roles/setup_docker/handlers/main.yml

@@ -0,0 +1,2 @@
+---
+# handlers file for setup_docker

ansible/roles/setup_docker/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.

ansible/roles/setup_docker/molecule/default/converge.yml

@@ -0,0 +1,7 @@
+---
+- name: Converge
+  hosts: all
+  tasks:
+    - name: "Include chatton.setup_docker"
+      include_role:
+        name: "chatton.setup_docker"

ansible/roles/setup_docker/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

ansible/roles/setup_docker/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

ansible/roles/setup_docker/tasks/main.yml

@@ -0,0 +1,44 @@
+# following official instructions here: https://docs.docker.com/engine/install/debian/
+- name: Install packages using apt
+  apt:
+    name:
+      - ca-certificates
+      - curl
+      - gnupg2
+      - lsb-release
+    state: present
+    update_cache: yes
+
+- name: Add Docker GPG apt Key
+  apt_key:
+    url: https://download.docker.com/linux/debian/gpg
+    state: present
+
+# TODO: paramaterize this
+- name: Add Docker Repository
+  apt_repository:
+    repo: deb https://download.docker.com/linux/debian buster stable
+    state: present
+
+- name: Install docker packages using apt
+  apt:
+    name:
+      - docker-ce
+      - docker-ce-cli
+      - containerd.io
+      - docker-compose-plugin
+    state: present
+    update_cache: yes
+
+- name: Install Docker Module for Python
+  pip:
+    name: docker
+
+- name: Install Docker Compose Module for Python
+  pip:
+    name: docker-compose
+
+- name: Ensure docker is started
+  service:
+    name: docker
+    state: started

ansible/roles/setup_docker/tests/inventory

@@ -0,0 +1,2 @@
+localhost
+

ansible/roles/setup_docker/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - setup_docker

ansible/roles/setup_docker/vars/main.yml

@@ -0,0 +1,2 @@
+---
+# vars file for setup_docker

ansible/roles/setup_portainer/.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

ansible/roles/setup_portainer/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).

ansible/roles/setup_portainer/defaults/main.yml

@@ -0,0 +1,2 @@
+---
+docker_compose_directory: /etc/docker-compose/portainer

ansible/roles/setup_portainer/files/docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3.2'
+services:
+  portainer:
+    labels:
+      ie.cianhatton.backup.enabled: "true"
+    image: portainer/portainer-ce
+    container_name: "portainer"
+    ports:
+      - "9000:9000"
+    volumes:
+      - portainer_data:/data
+      - /var/run/docker.sock:/var/run/docker.sock
+
+volumes:
+  portainer_data:

ansible/roles/setup_portainer/handlers/main.yml

@@ -0,0 +1,2 @@
+---
+# handlers file for setup_portainer

ansible/roles/setup_portainer/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.

ansible/roles/setup_portainer/molecule/default/converge.yml

@@ -0,0 +1,7 @@
+---
+- name: Converge
+  hosts: all
+  tasks:
+    - name: "Include chatton.setup_portainer"
+      include_role:
+        name: "chatton.setup_portainer"

ansible/roles/setup_portainer/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

ansible/roles/setup_portainer/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

ansible/roles/setup_portainer/tasks/main.yml

@@ -0,0 +1,14 @@
+- name: Create a directory if it does not exist
+  ansible.builtin.file:
+    path: "{{docker_compose_directory}}"
+    state: directory
+    mode: '0755'
+
+- name: Copy Portainer Docker Compose File
+  copy:
+    src: docker-compose.yml
+    dest: "{{docker_compose_directory}}/docker-compose.yml"
+
+- name: Create and Portainer
+  community.docker.docker_compose:
+    project_src: "{{docker_compose_directory}}"

ansible/roles/setup_portainer/tests/inventory

@@ -0,0 +1,2 @@
+localhost
+

ansible/roles/setup_portainer/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - setup_portainer

ansible/roles/setup_portainer/vars/main.yml

@@ -0,0 +1,2 @@
+---
+# vars file for setup_portainer

ansible/roles/setup_users/.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

ansible/roles/setup_users/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).

ansible/roles/setup_users/defaults/main.yml

@@ -0,0 +1,4 @@
+---
+# defaults file for setup_users
+homelab_group: cianhatton
+homelab_user: cianhatton

ansible/roles/setup_users/handlers/main.yml

@@ -0,0 +1,2 @@
+---
+# handlers file for setup_users

ansible/roles/setup_users/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.

ansible/roles/setup_users/molecule/default/converge.yml

@@ -0,0 +1,7 @@
+---
+- name: Converge
+  hosts: all
+  tasks:
+    - name: "Include chatton.setup_users"
+      include_role:
+        name: "chatton.setup_users"

ansible/roles/setup_users/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

ansible/roles/setup_users/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

ansible/roles/setup_users/tasks/main.yml

@@ -0,0 +1,26 @@
+# https://stackoverflow.com/questions/37333305/ansible-create-a-user-with-sudo-privileges
+- name: Install Sudo
+  apt:
+    pkg:
+      - sudo
+    state: latest
+    update_cache: true
+
+- name: Make sure we have a '{{homelab_group}}' group
+  group:
+    name: "{{homelab_group}}"
+    state: present
+- name: Allow '{{homelab_user}}' group to have passwordless sudo
+  lineinfile:
+    dest: /etc/sudoers
+    state: present
+    regexp: '^%{{homelab_user}}'
+    line: '%{{homelab_user}} ALL=(ALL) NOPASSWD: ALL'
+    validate: 'visudo -cf %s'
+
+- name: Add User
+  ansible.builtin.user:
+    name: "{{homelab_user}}"
+    comment: "{{homelab_user}} user"
+    uid: 1000
+    group: "{{homelab_group}}"

ansible/roles/setup_users/tests/inventory

@@ -0,0 +1,2 @@
+localhost
+

ansible/roles/setup_users/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - setup_users

ansible/roles/setup_users/vars/main.yml

@@ -0,0 +1,2 @@
+---
+# vars file for setup_users

ansible/setup-homelab.yml

@@ -0,0 +1,7 @@
+---
+- hosts: servers
+  become: true
+  roles:
+    - role: 'roles/setup_users'
+    - role: 'roles/setup_docker'
+    - role: 'roles/setup_portainer'