No description
| defaults | ||
| handlers | ||
| meta | ||
| tasks | ||
| vars | ||
| AGENTS.md.example | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
WARNING: Before the release of version 1.0.0, backwards compatibility is not guaranteed. If you use this role in production, pin it to a specific version or commit.
your_role_name
An Ansible role template.
Currently implemented features:
- Define role defaults and operator-facing variables.
- Split role logic into focused task files.
- Expose execution scopes through role tags.
Dependencies
None.
Requirements
None.
Variables
For the complete list of variables and defaults, see defaults/main.yaml. The table below summarizes commonly customized values.
| Variable | Description | Type | Default |
|---|---|---|---|
your_role_name_enabled |
Enable or disable the role's managed configuration. | bool | true |
your_role_name_packages |
Packages to install for this role. | list[string] | [] |
your_role_name_config |
Role-specific configuration map rendered into templates/tasks. | dict | {} |
your_role_name_state |
Desired state for managed resources. | string | "present" |
Tags
The following tags are available to fine-tune execution:
| Tag | Description |
|---|---|
your_role_name |
Covers the entire role. |
your_role_name:install |
Covers installation tasks. |
your_role_name:configure |
Covers configuration tasks. |
Examples
Basic standalone playbook
- name: Apply your role
hosts: all
become: true
roles:
- role: your_role_name
your_role_name_enabled: true
your_role_name_packages:
- vim
- curl