Ansible Role: serdigital64.system.sys_dconf

Purpose

Manage provisioning of the DConf service.

Supported features in the current version:

  • Prepare environment for application deployment.
  • Deploy application. Packages are defined in the variable sys_dconf_profiles.
  • Configure application:
    • Create user profile definition
  • Provision default local DBs for the user profile

The sys_dconf 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 / DConf / Usage example"
  hosts: "localhost"
  gather_facts: true
  vars:
    test_source: {{ "/dev/null" }}  # Replace this path with a valid dconf dump file

  tasks:
    - name: "Example: Install dconf and configure default user profiles"
      vars:
        sys_dconf:
          resolve_prereq: true
          prepare: true
          setup: true
          deploy: true
          provision: true
        sys_dconf_db_local:
          - source: "{{ test_source }}"
            name: "test_db"
      ansible.builtin.include_role:
        name: "serdigital64.system.sys_dconf"
...

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_dconf.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_dconf:
  resolve_prereq:
  prepare:
  deploy:
  setup:
  provision:
sys_dconf_db_local:
  - source:
    name:
Parameter Required? Type Default Purpose / Value
sys_dconf.resolve_prereq no boolean false Enable automatic resolution of prequisites
sys_dconf.prepare no boolean false Enable environment preparation
sys_dconf.deploy no boolean false Enable installation of application packages
sys_dconf.setup no boolean false Enable application configuration
sys_dconf.provision no boolean false Enable provisioning of application components
sys_dconf_db_local yes(provision) list List of local dbs
sys_dconf_db_local.0.source yes string Full path to the source db
sys_dconf_db_local.0.name yes string DB name

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.

Parameter Required? Type Default Purpose / Value

Deployment

OS Compatibility

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