feat: set feature flags to opt in or out of tasks

users/tasks/main.yml functions as a thin dispatcher with logical steps imported from their own files gated by a variable

README.md

@@ -1,3 +1,5 @@
-Opinionated set of roles to configure reasonable defaults for newly provisioned virtual machines. The repository provides a ready-to-use Ansible Collection (`studiovitali.ansible`) containing reusable roles.
+# Ansible Collection
+
+Opinionated set of roles to configure reasonable defaults for newly provisioned virtual machines. The repository provides a ready-to-use Ansible Collection (`studio.ansible`) containing reusable roles.
 
 Currently only supports Debian-based systems.

galaxy.yml

@@ -1,9 +1,9 @@
 ## galaxy.yml
 
-namespace: studiovitali
+namespace: studio
 name: ansible
 readme: README.md
-version: 0.1.1
+version: 0.0.1
 authors:
   - Studio Vitali
 description: Studio Ansible collection containing common roles

roles/base/defaults/main.yml

@@ -9,6 +9,6 @@ base_packages:
   - rsync
   - unzip
   - unattended-upgrades
-  # - acl ## needed for ansible to become unprivileged user
+  # - acl ## needed for Ansible to become unprivileged user
   # - python3-pip
   # - wget

roles/base/handlers/main.yml

@@ -1,13 +0,0 @@
----
-- name: Reboot system
-  block:
-    - name: Check if reboot is required
-      ansible.builtin.stat:
-        path: /var/run/reboot-required
-      register: reboot_required_file
-
-    - name: Reboot host if necessary
-      become: true
-      ansible.builtin.reboot:
-        post_reboot_delay: 10
-      when: reboot_required_file.stat.exists

roles/base/tasks/main.yml

@@ -1,20 +1,18 @@
 ---
 - name: Set system timezone
-  become: true
   community.general.timezone:
     # name: "{{ base_timezone }}"
     name: Europe/Zurich
+  become: true
 
 - name: Fully upgrade system
-  become: true
   ansible.builtin.apt:
     update_cache: true
     upgrade: dist
     cache_valid_time: 3600
-  notify: Reboot system
+  become: true
 
 - name: Install essential system utilities
-  become: true
   ansible.builtin.apt:
     # name: "{{ base_packages }}"
     name:
@@ -27,7 +25,8 @@
       - unattended-upgrades
     state: present
     update_cache: true
-
+  become: true
+#
 # - name: Enable unattended-upgrades
 #   ansible.builtin.copy:
 #     dest: /etc/apt/apt.conf.d/20auto-upgrades
@@ -35,4 +34,4 @@
 #       APT::Periodic::Update-Package-Lists "1";
 #       APT::Periodic::Unattended-Upgrade "1";
 #     mode: "0644"
-#   when: ansible_facts['os_family'] == "Debian"
+#   when: ansible_facts['os_family'] == "Debian"

roles/docker/tasks/main.yml

@@ -39,10 +39,9 @@
         enabled: true
 
 - name: Configure deployment user for Docker
-  when: deployment_public_ssh_key is defined
   become: true
   block:
-    - name: Add deployment user to docker group
+    - name: Add user to docker group
       ansible.builtin.user:
         name: deployment
         groups: docker
@@ -65,7 +64,7 @@
         state: present
         gid: 9999
 
-    - name: Create appuser
+    - name: Create user
       ansible.builtin.user:
         name: appuser
         state: present

roles/security/handlers/main.yml

@@ -1,6 +1,5 @@
 ---
 - name: Restart sshd
-  become: true
   ansible.builtin.service:
     name: ssh
     state: restarted

roles/security/tasks/main.yml

@@ -17,7 +17,6 @@
         owner: root
         group: root
         mode: "0644"
-        validate: /usr/sbin/sshd -t -f %s
       notify: Restart sshd
 
 - name: Enable fail2ban
@@ -33,4 +32,4 @@
       ansible.builtin.service:
         name: fail2ban
         state: started
-        enabled: true
+        enabled: yes

roles/users/defaults/main.yml

@@ -0,0 +1,3 @@
+---
+users_setup_sysadmin: true
+users_setup_deployment: false   # opt-in: enable explicitly to use

roles/users/tasks/deployment.yml

@@ -0,0 +1,14 @@
+---
+- name: Create deployment user for CI/CD
+  ansible.builtin.user:
+    name: deployment
+    shell: /bin/bash
+    create_home: yes
+  become: true
+
+- name: Add SSH public key for deployment user
+  ansible.posix.authorized_key:
+    user: deployment
+    state: present
+    key: "{{ deployment_public_ssh_key }}"
+  become: true

roles/users/tasks/main.yml

@@ -1,42 +1,14 @@
 ---
-- name: Set up primary sysadmin user
-  when: sysadmin_public_ssh_key is defined
-  become: true
-  block:
-    - name: Create sysadmin user
-      ansible.builtin.user:
-        name: "{{ sysadmin_user }}"
-        groups: sudo
-        append: yes
-        shell: /bin/bash
-        create_home: yes
+- name: Configure sysadmin user
+  ansible.builtin.import_tasks: sysadmin.yml
+  when: users_setup_sysadmin | bool
 
-    - name: Add SSH public key
-      ansible.posix.authorized_key:
-        user: "{{ sysadmin_user }}"
-        state: present
-        key: "{{ sysadmin_public_ssh_key }}"
+- name: Configure deployment user
+  ansible.builtin.import_tasks: deployment.yml
+  when: users_setup_deployment | bool
 
-    - name: Allow passwordless sudo
-      ansible.builtin.copy:
-        dest: /etc/sudoers.d/sudo-nopasswd
-        content: "%sudo ALL=(ALL) NOPASSWD: ALL"
-        mode: "0440"
-        validate: /usr/sbin/visudo -cf %s
-
-
-- name: Set up deployment user for CI/CD
-  when: deployment_public_ssh_key is defined
-  become: true
-  block:
-    - name: Create deployment user
-      ansible.builtin.user:
-        name: deployment
-        shell: /bin/bash
-        create_home: yes
-
-    - name: Add SSH public key
-      ansible.posix.authorized_key:
-        user: deployment
-        state: present
-        key: "{{ deployment_public_ssh_key }}"
+# opt in to feature flags / tasks with:
+# roles:
+#   - role: studio.ansible.users
+#     vars:
+#       users_setup_deployment: true

roles/users/tasks/sysadmin.yml

@@ -0,0 +1,24 @@
+---
+- name: Create primary sysadmin user
+  ansible.builtin.user:
+    name: "{{ sysadmin_user }}"
+    groups: sudo
+    append: yes
+    shell: /bin/bash
+    create_home: yes
+  become: true
+
+- name: Add SSH public key for sysadmin
+  ansible.posix.authorized_key:
+    user: "{{ sysadmin_user }}"
+    state: present
+    key: "{{ sysadmin_public_ssh_key }}"
+  become: true
+
+- name: Allow passwordless sudo for sudo group
+  ansible.builtin.copy:
+    dest: /etc/sudoers.d/sudo-nopasswd
+    content: "%sudo ALL=(ALL) NOPASSWD: ALL"
+    mode: "0440"
+    validate: /usr/sbin/visudo -cf %s
+  become: true