fixing linting issues

playbooks/backup-docker-volumes.yml

@@ -8,9 +8,9 @@
     schedule: nightly
 
   pre_tasks:
-  - name: Include vault variables.
+    - name: Include vault variables.
-    include_vars: '../{{ vault_file }}'
+      ansible.builtin.include_vars: '../{{ vault_file }}'
-    tags: [always]
+      tags: [always]
 
   tasks:
     - name: Find Containers With Backup Label
@@ -18,20 +18,18 @@
         containers: true
         containers_filters:
           label:
-           - "ie.cianhatton.backup.enabled=true"
+            - "ie.cianhatton.backup.enabled=true"
-           - "ie.cianhatton.backup.schedule={{ schedule }}"
+            - "ie.cianhatton.backup.schedule={{ schedule }}"
       register: filter_output
 
     - name: Get Container Names
-      set_fact: container_names="{{ filter_output.containers  | map(attribute="Names")  | flatten }}"
+      ansible.builtin.set_fact: container_names="{{ filter_output.containers | map(attribute="Names") | flatten }}"
-
-    - debug: msg="{{ container_names }}"
 
     - name: Backup Containers with backup label
-      include_role:
+      ansible.builtin.include_role:
-          name: chatton.docker_backup.docker_s3_backup
+        name: chatton.docker_backup.docker_s3_backup
       vars:
-          container_backup: "{{ container_item | regex_replace('^\\/', '') }}"
+        container_backup: "{{ container_item | regex_replace('^\\/', '') }}"
       with_items: "{{ container_names }}"
       loop_control:
         loop_var: container_item

playbooks/bootstrap.yml

@@ -7,12 +7,13 @@
   hosts: localhost
   connection: local
   tasks:
-  - name: Generate an OpenSSH rsa keypair for ansible
+    - name: Generate an OpenSSH rsa keypair for ansible
-    community.crypto.openssh_keypair:
+      community.crypto.openssh_keypair:
-      path: ~/.ssh/ansible
+        path: ~/.ssh/ansible
-      passphrase: ''
+        passphrase: ''
 
-- hosts: all
+- name: Bootstrap Ansible hosts.
+  hosts: all
   become: true
   roles:
-  - role: bootstrap
+    - role: bootstrap

playbooks/restore-docker-volumes.yml

@@ -1,9 +1,10 @@
 ---
-- hosts: qnap
+- name: Restore a docker volume.
+  hosts: qnap
   become: true
   pre_tasks:
   - name: Include vault variables.
-    include_vars: '../{{vault_file}}'
+    ansible.builtin.include_vars: '../{{ vault_file }}'
     tags: [always]
   roles:
     - role: chatton.docker_backup.docker_s3_volume_restore

playbooks/setup-homelab.yml

@@ -4,51 +4,51 @@
   hosts: all
   become: true
   pre_tasks:
-  - name: Update Packages
+    - name: Update Packages
-    apt:
+      ansible.builtin.apt:
-      upgrade: dist
+        upgrade: dist
-      update_cache: true
+        update_cache: true
   roles:
-  - role: setup_users
+    - role: setup_users
 
 - name: Install docker on docker hosts
   hosts: dockerhosts
   become: true
   roles:
-  - role: setup_docker
+    - role: setup_docker
-    tags: [setup, docker]
+      tags: [setup, docker]
 
 - name: Setup and deploy services on the QNAP
   hosts: qnap
   become: true
   pre_tasks:
-  - name: Include vault variables.
+    - name: Include vault variables.
-    include_vars: '../{{ vault_file }}'
+      ansible.builtin.include_vars: '../{{ vault_file }}'
-    tags: [always]
+      tags: [always]
 
   roles:
-  - role: setup_mergerfs
+    - role: setup_mergerfs
-    tags: [mergerfs]
+      tags: [mergerfs]
-  - role: setup_samba
+    - role: setup_samba
-    tags: [samba]
+      tags: [samba]
-  - role: setup_portainer
+    - role: setup_portainer
-    tags: [services, portainer]
+      tags: [services, portainer]
-  - role: setup_hosted_services
+    - role: setup_hosted_services
-    tags: [services]
+      tags: [services]
 
 
-- hosts: linodes
+- name: Setup home lab on linode instances.
+  hosts: linodes
   become: true
-
   pre_tasks:
-  - name: Include vault variables.
+    - name: Include vault variables.
-    include_vars: '../{{ vault_file }}'
+      ansible.builtin.include_vars: '../{{ vault_file }}'
-    tags: [always]
+      tags: [always]
 
   roles:
-  - role: setup_samba
+    - role: setup_samba
-    tags: [samba]
+      tags: [samba]
-  - role: setup_docker
+    - role: setup_docker
-    tags: [docker]
+      tags: [docker]
-  - role: setup_hosted_services
+    - role: setup_hosted_services
-    tags: [services]
+      tags: [services]

playbooks/setup-linode.yml

@@ -1,7 +1,8 @@
 ---
-- hosts: localhost
+- name: Setup linode instance.
+  hosts: localhost
   become: true
   roles:
-  - role: roles/setup_linode
+    - role: roles/setup_linode
-    vars:
+      vars:
-      state: present
+        state: present

playbooks/verify-homelab.yml

@@ -1,48 +1,48 @@
 ---
-- hosts: all
+- name: Verify HomeLab has been correctly set up.
+  hosts: all
   become: true
   pre_tasks:
-  - name: Include vault variables.
+    - name: Include vault variables.
-    include_vars: ../{{vault_file}}
+      ansible.builtin.include_vars: ../{{ vault_file }}
-    tags:
+      tags:
-    - always
+        - always
   tasks:
-  - name: Docker Compose Files Exist
+    - name: Docker Compose Files Exist
-    command: stat {{directories.docker_compose_directory}}/{{ item.name }}/docker-compose.yml
+      ansible.builtin.command: stat {{ directories.docker_compose_directory }}/{{ item.name }}/docker-compose.yml
-    with_items: '{{services}}'
+      with_items: '{{ services }}'
-    changed_when: false
+      changed_when: false
-    register: docker_compose_stat
+      register: docker_compose_stat
 
-  - name: Assert all Docker Compose files were created
+    - name: Assert all Docker Compose files were created
-    assert:
+      ansible.builtin.assert:
-      that: item.rc == 0
+        that: item.rc == 0
-    with_items: '{{docker_compose_stat.results}}'
+      with_items: '{{ docker_compose_stat.results }}'
 
-  - name: Populate service facts
+    - name: Populate service facts
-    service_facts: {}
+      ansible.builtin.service_facts: {}
-  - name: Assert docker is installed and started
-    assert:
-      that:
-      - ansible_facts.services.docker.state == "running"
-      - ansible_facts.services['docker.service'].status == "enabled"
-  - name: Inspect all images
-    docker_image_info: {}
-    register: image_details
-  - name: Assert desired images exist
-    assert:
-      that: "{{ item in image_details.images | map(attribute='RepoTags') | flatten }}"
-    with_items: '{{desired_docker_images}}'
 
-  - name: Fetch Sudoers Files
+    - name: Assert docker is installed and started
-    command: stat /etc/sudoers.d/{{item.name}}
+      ansible.builtin.assert:
-    changed_when: false
+        that:
-    register: sudoers_stat
+          - ansible_facts.services.docker.state == "running"
-    with_items: '{{users}}'
+          - ansible_facts.services['docker.service'].status == "enabled"
-    when: item.passwordless_sudo == true
+    - name: Inspect all images
-
+      docker_image_info: {}
-  - name: Assert sudoers files are created
+      register: image_details
-    assert:
+    - name: Assert desired images exist
-      that: item.rc == 0
+      ansible.builtin.assert:
-    with_items: '{{sudoers_stat.results}}'
+        that: "{{ item in image_details.images | map(attribute='RepoTags') | flatten }}"
+      with_items: '{{ desired_docker_images }}'
 
+    - name: Fetch Sudoers Files
+      ansible.builtin.command: stat /etc/sudoers.d/{{ item.name }}
+      changed_when: false
+      register: sudoers_stat
+      with_items: '{{ users }}'
+      when: item.passwordless_sudo
 
+    - name: Assert sudoers files are created
+      ansible.builtin.assert:
+        that: item.rc == 0
+      with_items: '{{ sudoers_stat.results }}'

roles/bootstrap/meta/main.yml

@@ -1,53 +1,12 @@
 galaxy_info:
   author: Cian Hatton
   namespace: chatton
-  description: your role description
+  description: Bootstrap ansible
-  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: MIT
-
+  min_ansible_version: "2.1"
-  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
+  platforms:
-    # and categorizes the role. Users find roles by searching for tags. Be sure to
+    - name: Debian
-    # remove the '[]' above, if you add tags to this list.
+      versions:
-    #
+        - all
-    # 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.

roles/bootstrap/tasks/main.yml

@@ -1,10 +1,11 @@
+---
 - name: Update Packages
-  apt:
+  ansible.builtin.apt:
     upgrade: dist
     update_cache: true
 
 - name: Create ansible user
-  user:
+  ansible.builtin.user:
     name: ansible
     groups: root
     shell: /bin/bash
@@ -16,7 +17,7 @@
     key: "{{ lookup('file', '~/.ssh/ansible.pub') }}"
 
 - name: Add sudoers file for ansible
-  copy:
+  ansible.builtin.copy:
     src: sudoer_ansible
     dest: /etc/sudoers.d/ansible
     owner: root

roles/setup_docker/meta/main.yml

@@ -1,10 +1,12 @@
 galaxy_info:
   author: Cian Hatton
   namespace: chatton
-  description: Bootstrap ansible
+  description: Setup Docker
-  company: your company (optional)
   license: MIT
-  min_ansible_version: 2.1
+  min_ansible_version: "2.1"
   galaxy_tags: []
-
+  platforms:
+    - name: Debian
+      versions:
+        - all
 dependencies: []