Ansible Role: serdigital64.storage.stg_nfs_server¶

Purpose¶

Manage the Linux NFS server

Supported features in the current version:

• Deploy application. Packages are defined in the variable stg_nfs_server_profiles.
• Control application subsystem services. Services are defined in the variable stg_nfs_server_subsystems.
• Configure application subsystem server.
• Configure OS level firewall rules. Rules are defined in the varible stg_nfs_server_firewall_rules
• Provision application components:
  • Add/Remove shares from the NFS exports list

The stg_nfs_server Ansible-Role is part of the A:Platform64 project and is available in the storage 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: "Storage / NFS / Server / Usage example"
  hosts: "localhost"
  gather_facts: true

  tasks:
    - name: "Example: install nfs, configure and export share"
      vars:
        stg_nfs_server:
          resolve_prereq: true
          deploy: true
          setup: true
          provision: true
        stg_nfs_server_exports:
          - path: "/mnt"
            options: "ro"
            enabled: true
      ansible.builtin.include_role:
        name: "serdigital64.storage.stg_nfs_server"
...

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/storage/playbooks/stg_nfs_server.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.

stg_nfs_server:
  resolve_prereq:
  deploy:
  setup:
  control:
  provision:

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.

stg_nfs_server_application:
  name:
  type:
  version:
  installed:
stg_nfs_server_subsystem:
  enabled:
  status:
stg_nfs_server_firewall:
  zone:
stg_nfs_server_exports:
  - path:
    options:
    enabled:

Deployment¶

OS Compatibility¶

The operating system compatibility list is defined in the variable: stg_nfs_server_platforms

Dependencies¶

• Ansible Collections:
  • serdigital64.backup
    • bkp_archive
  • serdigital64.system
    • sys_package
    • sys_repository
  • serdigital64.security
    • sec_firewall_os

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.storage

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