Ansible Role: serdigital64.storage.stg_autofs¶
Purpose¶
Manage the AutoFS service
Supported features in the current version:
- Prepare environment for application deployment:
- Create shared root path for mount points
- Deploy service. Packages are defined in the variable
stg_autofs_profiles
. - Control service subsystem services. Services are defined in the variable
stg_autofs_subsystems
. - Configure service subsystem server.
- Provision service components.
- Add autofs maps
The stg_autofs 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 / AutoFS / Usage example"
hosts: "localhost"
gather_facts: true
tasks:
- name: "Example: install AutoFS, configure service and provision map"
vars:
stg_autofs:
resolve_prereq: true
deploy: true
setup: true
control: true
provision: true
stg_autofs_maps:
- name: "test"
mount: "test"
shares:
- source: "test_source"
target: "test_target"
options: "ro"
ansible.builtin.include_role:
name: "serdigital64.storage.stg_autofs"
...
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_autofs.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_autofs:
resolve_prereq:
prepare:
deploy:
setup:
control:
provision:
Parameter | Required? | Type | Default | Purpose / Value |
---|---|---|---|---|
stg_autofs.resolve_prereq | no | boolean | false | Enable automatic resolution of prequisites |
stg_autofs.prepare | no | boolean | false | Enable environment preparation |
stg_autofs.deploy | no | boolean | false | Enable installation of service packages |
stg_autofs.setup | no | boolean | false | Enable service configuration |
stg_autofs.control | no | boolean | false | Enable service subsystem service control |
stg_autofs.provision | no | boolean | false | Enable provisioning of service components |
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_autofs_service:
name:
type:
version:
installed:
stg_autofs_subsystem:
enabled:
status:
stg_autofs_server_options:
root:
timeout:
logging:
stg_autofs_maps:
- name:
mount:
shares:
- source:
target:
options:
Parameter | Required? | Type | Default | Purpose / Value |
---|---|---|---|---|
stg_autofs_service | yes(deploy) | dictionary | Set service package end state | |
stg_autofs_service.name | yes(deploy) | string | "autofs" | Select service package name |
stg_autofs_service.type | yes(deploy) | string | "distro" | Select service package type |
stg_autofs_service.version | yes(deploy) | string | "latest" | Select service package version |
stg_autofs_service.installed | yes(deploy) | boolean | true | Set service package end state |
stg_autofs_subsystem | yes(control) | dictionary | Set service subsystem end state | |
stg_autofs_subsystem.enabled | yes(control) | boolean | false | Enable the subsystem? |
stg_autofs_subsystem.status | yes(control) | string | "stopped" | Set the service state |
stg_autofs_server_options | no | dictionary | Set subsystem server options | |
stg_autofs_server_options.root | no | string | "/autofs" | Base paths where map mount points will be created |
stg_autofs_server_options.logging | no | string | "none" | Logging level. Valid values defined in the variable stg_autofs_logging |
stg_autofs_server_options.timeout | no | string | "100" | Set autofs.timeout |
stg_autofs_maps | yes(provision) | list | Provision autofs maps | |
stg_autofs_maps.0.name | yes(provision) | string | Map name | |
stg_autofs_maps.0.mount | yes(provision) | string | Directory where shares will be created. Relative tostg_autofs_server_options.root | |
stg_autofs_maps.0.shares | yes(provision) | list | List of shares to be added to the map | |
stg_autofs_maps.0.shares.0.source | yes(provision) | string | Source share to mount | |
stg_autofs_maps.0.shares.0.target | yes(provision) | string | Target directory to monitor | |
stg_autofs_maps.0.shares.0.options | yes(provision) | string | Share specific mount options |
Deployment¶
OS Compatibility¶
The operating system compatibility list is defined in the variable: stg_autofs_platforms
Dependencies¶
- Ansible Collections:
- serdigital64.backup
- bkp_archive
- serdigital64.system
- sys_package
- sys_repository
- serdigital64.storage
- stg_nfs_client
- serdigital64.backup
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 service 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.