Ansible Role: serdigital64.application.app_xmind

Purpose

Manage provisioning of the XMind application.

Supported features in the current version:

  • Deploy application. Packages are defined in the variable app_xmind_profiles.

The app_xmind Ansible-Role is part of the A:Platform64 project and is available in the application 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: "Application / XMind / Usage example"
  hosts: "localhost"
  gather_facts: true

  tasks:
    - name: "Example: Install XMind"
      vars:
        app_xmind:
          resolve_prereq: true
          deploy: true
      ansible.builtin.include_role:
        name: "serdigital64.application.app_xmind"
...

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/application/playbooks/app_xmind.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.
app_xmind:
  resolve_prereq:
  deploy: false
Parameter Required? Type Default Purpose / Value
app_xmind.resolve_prereq no boolean false Enable automatic resolution of prequisites
app_xmind.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.
app_xmind_application:
  name:
  type:
  version:
  installed:
Parameter Required? Type Default Purpose / Value
app_xmind_application no dictionary Set application package end state
app_xmind_application.name no string "xmind" Define application application
app_xmind_application.type no string "flatpak" Select application type from application
app_xmind_application.version no string "latest" Select application package version
app_xmind_application.installed no boolean true Set application package end application

Deployment

OS Compatibility

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

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

Apache-2.0