Ansible Role: serdigital64.system.sys_mc

Purpose

Manage provisioning of the Midnight Commander tool

Supported features in the current version:

  • Deploy application. Packages are defined in the variable sys_mc_profiles.
  • Setup application:
    • Create default user configuration

The sys_mc 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 / MC / Usage example"
  hosts: "localhost"
  gather_facts: true
  vars:
    target_user: "{{ lookup('env','USER') }}"
    target_users:
      - name: "{{ target_user }}"
        group: "{{ target_user }}"
        home: "/home/{{ target_user }}"

  tasks:
    - name: "Example: Install MC tool and deploy default user configuration"
      vars:
        sys_mc:
          resolve_prereq: true
          deploy: true
          setup: true
        sys_mc_users: "{{ target_users }}"
      ansible.builtin.include_role:
        name: "serdigital64.system.sys_mc"
...

The playbook can be run by executing:

# Set ANSIBLE_COLLECTIONS_PATHS to the default location. Change as needed.
ANSIBLE_COLLECTIONS_PATHS="${HOME}/.ansible/collections"
ansible-playbook "${ANSIBLE_COLLECTIONS_PATHS}/ansible_collections/serdigital64/system/playbooks/sys_mc.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_mc:
  resolve_prereq:
  deploy:
  setup:
Parameter Required? Type Default Purpose / Value
sys_mc.resolve_prereq no boolean false Enable automatic resolution of prequisites
sys_mc.deploy no boolean false Enable installation of application packages
sys_mc.setup 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_mc_application:
  name:
  type:
  version:
  installed:
sys_mc_actions:
  setup:
    overwrite:
sys_mc_users:
  - name:
    group:
    home:
Parameter Required? Type Default Purpose / Value
sys_mc_application yes(deploy) dictionary Set application package end state
sys_mc_application.name yes(deploy) string "mc" Select application package name
sys_mc_application.type yes(deploy) string "distro"\|"brew" Select application package type
sys_mc_application.version yes(deploy) string "latest" Select application package version
sys_mc_application.installed yes(deploy) boolean true Set application package end state
sys_mc_actions no dictionary Set action options
sys_mc_actions.setup no dictionary Set setup action options
sys_mc_actions.setup.overwrite no boolean false Overwrite user configurations?
sys_mc_users yes(setup) list List of users that will use MC
sys_mc_users.0.name yes(setup) string User login name
sys_mc_users.0.group yes(setup) string User primary group
sys_mc_users.0.home yes(setup) string Home directory

Deployment

OS Compatibility

The operating system compatibility list is defined in the variable: sys_mc_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 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