christianlempa-boilerplates/ansible/maintenance/maint-reboot-required.yaml

---
- name: check if system reboot is required
  hosts: "{{ my_hosts | d([]) }}"
  become: true

  tasks:
    - name: check if system reboot is required
      become: true
      ansible.builtin.stat:
        path: /var/run/reboot-required
      register: reboot_required

    - name: Report if reboot is required
      ansible.builtin.debug:
        msg: "Reboot is required"
      when: reboot_required.stat.exists
ansiblesemaphore-udpate 2023-05-25 13:48:38 +02:00			`---`
			`- name: check if system reboot is required`
fix: ensure the `hosts` definition is always defined Ensure that the `hosts` definition is always defined, defaulting to an empty set. Due to the lack of an Ansible inventory file this is most likely meant to be set as an Ansible extra variable [1]. We also rename the variable named `hosts` to `my_hosts` because `hosts` is a reserved name in Ansible. Reserved names in Ansible are for example all class variable names of plays, roles, blocks, and tasks [2], and `hosts` for example is used by plays [3]. [1] https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html#defining-variables-at-runtime [2] https://github.com/ansible/ansible/blob/v2.16.4/lib/ansible/vars/reserved.py#L39 [3] https://github.com/ansible/ansible/blob/v2.16.4/lib/ansible/playbook/play.py#L58 2024-02-23 12:19:48 +01:00			`hosts: "{{ my_hosts \| d([]) }}"`
fix: consistently use `true`/`false` as truthy values 2024-03-03 16:16:22 +01:00			`become: true`
fix: add and remove blank lines Add blank lines where it helps with readability (e.g., between each task) but also remove needless one. 2024-03-03 16:34:29 +01:00
ansiblesemaphore-udpate 2023-05-25 13:48:38 +02:00			`tasks:`
			`- name: check if system reboot is required`
			`become: true`
chore: consistently use Ansible FQCN in module calls In order to adhere to Ansible best practices, always use Fully Qualified Collection Names (FQCN) [1] when calling modules. Other than that, this commit doesn't apply any further changes except where needed as a module name has been updated. The module `ansible.builtin.systemd` has been renamed to `ansible.builtin.systemd_service` with `ansible.builtin.systemd` just being an alias [2] for reasons of backward compatibility. [1] https://docs.ansible.com/ansible/latest/tips_tricks/ansible_tips_tricks.html#use-fully-qualified-collection-names [2] https://docs.ansible.com/ansible/latest/collections/ansible/builtin/systemd_service_module.html#synopsis 2024-02-24 11:56:25 +01:00			`ansible.builtin.stat:`
ansiblesemaphore-udpate 2023-05-25 13:48:38 +02:00			`path: /var/run/reboot-required`
			`register: reboot_required`
fix: add and remove blank lines Add blank lines where it helps with readability (e.g., between each task) but also remove needless one. 2024-03-03 16:34:29 +01:00
fix: add missing names Any play or task should have a name. 2024-03-03 16:43:55 +01:00			`- name: Report if reboot is required`
			`ansible.builtin.debug:`
ansiblesemaphore-udpate 2023-05-25 13:48:38 +02:00			`msg: "Reboot is required"`
fix: add final newline character to text files This makes text files compliant to POSIX which requires every line of a text file to end with a newline character [1][2]. [1] https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_403 [2] https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206 2024-02-22 19:01:59 +01:00			`when: reboot_required.stat.exists`