Ansible Role: serdigital64.system.sys_fonts

Purpose

Manage optional OS fonts provisioning

Supported features in the current version:

  • Prepare environment for application deployment.
  • Deploy font configuration tools. Packages are defined in the variable sys_fonts_profiles.
  • Deploy fonts. Packages are defined in the variable sys_fonts_profiles.
    • Meslo
    • URW

The sys_fonts 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 / Fonts / Usage example"
  hosts: "localhost"
  gather_facts: true

  tasks:
    - name: "Example: Install external fonts Meslo and URW"
      vars:
        sys_fonts:
          resolve_prereq: true
          deploy: true
        sys_fonts_catalog:
          urw: true
          meslo: true
      ansible.builtin.include_role:
        name: "serdigital64.system.sys_fonts"
...

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_fonts.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_fonts:
  resolve_prereq:
  prepare:
  deploy:
Parameter Required? Type Default Purpose / Value
sys_fonts.resolve_prereq no boolean false Enable automatic resolution of prequisites
sys_fonts.prepare no boolean false Enable environment preparation
sys_fonts.deploy no boolean false Enable installation of application packages

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_fonts_catalog:
  urw:
  meslo:
Parameter Required? Type Default Purpose / Value
sys_fonts_catalog no dictionary Define catalog options
sys_fonts_catalog.urw no bool true Install the font?
sys_fonts_catalog.meslo no bool true Install the font?

Deployment

OS Compatibility

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