Ansible Role: serdigital64.web.web_mkdocs¶

Purpose¶

Manage provisioning of the MkDocs tool.

Supported features in the current version:

• Deploy application. Packages are defined in the variable web_mkdocs_profiles.
  • Create dedicated python venv location: /opt/mkdocs (defined in the variable web_mkdocs_base).
  • Create loader script to activate the venv and run the python script.
  • Create dedicate user and group for owning the application.

The web_mkdocs Ansible-Role is part of the A:Platform64 project and is available in the web 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: "Web / MkDocs / Usage example"
  hosts: "localhost"
  gather_facts: true

  tasks:
    - name: "Example: install application"
      vars:
        web_mkdocs:
          resolve_prereq: true
          deploy: true
      ansible.builtin.include_role:
        name: "serdigital64.web.web_mkdocs"
...

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/web/playbooks/web_mkdocs.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.

web_mkdocs:
  resolve_prereq:
  deploy:

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.

web_mkdocs_application:
  name:
  type:
  version:
  installed:

Deployment¶

OS Compatibility¶

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

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¶

• SerDigital64

License¶

Apache-2.0