Ansible Role: serdigital64.system.sys_sudo

Purpose

Manage provisioning of the SuDo tool.

Supported features in the current version:

  • Deploy application. Packages are defined in the variable sys_sudo_profiles.
  • Setup system wide sudoers
    • Add/Remove user rules

The sys_sudo Ansible-Role is part of the A:Platform64 project and is available in the system Ansible-Collection.

Usage

The following example is an Ansible Playbook that includes all the supported features:

use this link if viewing the doc on github

---
- name: "System / SuDo / Usage example"
  hosts: "localhost"
  gather_facts: true
  vars:
    test_user: "testusr64"

  pre_tasks:
    - name: "Create test users"
      vars:
        sys_user:
          setup: true
        sys_user_accounts:
          - name: "{{ test_user }}"
      ansible.builtin.include_role:
        name: "serdigital64.system.sys_user"

  tasks:
    - name: "Example: Add user rule to sudoers"
      vars:
        sys_sudo:
          resolve_prereq: true
          deploy: true
          setup: true
        sys_sudo_rules:
          user:
            - name: "{{ test_user }}"
              rule: "ALL=(ALL) NOPASSWD: ALL"
              present: true
      ansible.builtin.include_role:
        name: "serdigital64.system.sys_sudo"
...

The playbook can be run by executing:

# Set ANSIBLE_COLLECTIONS_PATHS to the default install location. Change as needed.
ANSIBLE_COLLECTIONS_PATHS="${HOME}/.ansible/collections"
ansible-playbook "${ANSIBLE_COLLECTIONS_PATHS}/ansible_collections/serdigital64/system/playbooks/sys_sudo.yml"

Role Parameters

Actions

  • Use action-parameters to control what tasks are enabled for the role to execute.
  • Parameters should be declared as task level vars as they are intented to be dynamic.
sys_sudo:
  resolve_prereq:
  deploy:
  setup:
Parameter Required? Type Default Purpose / Value
sys_sudo.resolve_prereq no boolean false Enable automatic resolution of prequisites
sys_sudo.deploy no boolean false Enable installation of application packages
sys_sudo.sudo no boolean false Enable application configuration

End State

  • Use end-state parameters to define the target state after role execution.
  • Parameters should be declared in host_vars or group_vars as they are intended to be permanent.
sys_sudo_application:
  name:
  type:
  version:
  installed:
sys_sudo_rules:
  user:
    - name:
      rule:
      present:
Parameter Required? Type Default Purpose / Value
sys_sudo_application no dictionary Set application package end state
sys_sudo_application.name no string "sudo" Select application package name
sys_sudo_application.type no string "distro" Select application package type
sys_sudo_application.version no string "latest" Select application package version
sys_sudo_application.installed no boolean true Set application package end state
sys_sudo_rules yes(setup) list Define what sudoers rules to process
sys_sudo_rules.user yes(setup) list Define user rules
sys_sudo_rules.user.0.name yes(setup) string Define user name
sys_sudo_rules.user.0.rule yes(setup) string Define sudoers rule
sys_sudo_rules.user.0.present no boolean true Set the rule end state

Deployment

OS Compatibility

The operating system compatibility list is defined in the variable: sys_sudo_platforms

Dependencies

  • Ansible Collections:
    • serdigital64.backup
      • bkp_archive
    • serdigital64.system
      • sys_package
      • sys_repository

Prerequisites

The Ansible engine must be already installed and configured for privileged access and remote execution.

In addition the following prerequisites can be automatically solved when running the playbook by setting the role action: resolve_prereq: true

  • Package manager for the target application is installed and enabled.

Installation Procedure

Manually install Ansible Collections from the Ansible Galaxy repository:

ansible-galaxy collection install --upgrade serdigital64.system

Automatic installation is also available by deploying A:Platform64

Contributing

Help on implementing new features and maintaining the code base is welcomed.

Please see the guidelines for further details.

Author

License

GPL-3.0-or-later