147 lines
5.8 KiB
Django/Jinja
147 lines
5.8 KiB
Django/Jinja
# [{{ role_name }}](#{{ role_name }})
|
|
|
|
{{ meta.galaxy_info.description }}
|
|
|
|
|Travis|GitHub|Quality|Downloads|
|
|
|------|------|-------|---------|
|
|
|[](https://travis-ci.com/{{ travis_namespace }}/ansible-role-{{ role_name }})|[](https://github.com/{{ github_namespace }}/ansible-role-{{ role_name }}/actions)|[](https://galaxy.ansible.com/{{ github_namespace }}/{{ role_name }})|[](https://galaxy.ansible.com/{{ github_namespace }}/{{ role_name }})|
|
|
|
|
## [Example Playbook](#example-playbook)
|
|
|
|
This example is taken from `molecule/resources/converge.yml` and is tested on each push, pull request and release.
|
|
```yaml
|
|
{{ example.content | b64decode | regex_replace('ansible-role-', galaxy_namespace ~ '.') }}```
|
|
|
|
The machine may need to be prepared using `molecule/resources/prepare.yml`:
|
|
```yaml
|
|
{% if prepare.content is defined %}
|
|
{{ prepare.content | b64decode | regex_replace('ansible-role-', galaxy_namespace ~ '.') }}```
|
|
{% else %}
|
|
No preparation required.
|
|
```
|
|
{% endif %}
|
|
|
|
{% if verifyyml.content is defined %}
|
|
For verification `molecule/resources/verify.yml` run after the role has been applied.
|
|
```yaml
|
|
{{ verifyyml.content | b64decode | regex_replace('ansible-role-', galaxy_namespace ~ '.') }}```
|
|
{% endif %}
|
|
|
|
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
|
|
|
|
{% if variables.content is defined %}
|
|
## [Role Variables](#role-variables)
|
|
|
|
These variables are set in `defaults/main.yml`:
|
|
```yaml
|
|
{{ variables.content | b64decode }}```
|
|
{% endif %}
|
|
|
|
## [Requirements](#requirements)
|
|
|
|
- Access to a repository containing packages, likely on the internet.
|
|
- A recent version of Ansible. (Tests run on the current, previous and next release of Ansible.)
|
|
|
|
The following roles can be installed to ensure all requirements are met, using `ansible-galaxy install -r requirements.yml`:
|
|
|
|
```yaml
|
|
{{ requirements.content | b64decode }}
|
|
```
|
|
|
|
{% if meta.dependencies %}
|
|
## [Dependencies](#dependencies)
|
|
|
|
Most roles require some kind of preparation, this is done in `molecule/default/prepare.yml`. This role has a "hard" dependency on the following roles:
|
|
|
|
{% for dependency in meta.dependencies %}
|
|
- {{ dependency }}
|
|
{% endfor %}
|
|
{% endif %}
|
|
## [Context](#context)
|
|
|
|
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.
|
|
|
|
Here is an overview of related roles:
|
|
|
|
|
|
## [Compatibility](#compatibility)
|
|
|
|
This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):
|
|
|
|
|container|tags|
|
|
|---------|----|
|
|
{% for platform in meta.galaxy_info.platforms %}
|
|
|{{ platform.name | lower }}|{% for version in platform.versions %}{{ version }}{% if not loop.last %}, {% endif %}{% endfor %}|
|
|
{% endfor %}
|
|
|
|
The minimum version of Ansible required is {{ meta.galaxy_info.min_ansible_version }} but tests have been done to:
|
|
|
|
- The previous version, on version lower.
|
|
- The current version.
|
|
- The development version.
|
|
|
|
{% if exceptions is defined %}
|
|
## [Exceptions](#exceptions)
|
|
|
|
Some variarations of the build matrix do not work. These are the variations and reasons why the build won't work:
|
|
|
|
| variation | reason |
|
|
|---------------------------|------------------------|
|
|
{% for exception in exceptions %}| {{ exception.variation }} | {{ exception.reason }} |
|
|
{% endfor %}{% endif %}
|
|
|
|
{% if versions is defined %}
|
|
## [Included version(s)](#included-versions)
|
|
|
|
This role [refers to a version]({{ reference }}) released by {{ project_name }}. Check the released version(s) here:
|
|
{% for version in versions %}
|
|
- [{{ version.name }}]({{ version.url }}).
|
|
{% endfor %}
|
|
|
|
This version reference means a role may get outdated. Monthly tests occur to see if [bit-rot](https://en.wikipedia.org/wiki/Software_rot) occured. If you however find a problem, please create an issue, I'll get on it as soon as possible.{% endif %}
|
|
|
|
## [Testing](#testing)
|
|
|
|
[Unit tests](https://travis-ci.com/{{ travis_namespace }}/ansible-role-{{ role_name }}) are done on every commit, pull request, release and periodically.
|
|
|
|
If you find issues, please register them in [GitHub](https://github.com/{{ github_namespace }}/ansible-role-{{ role_name }}/issues)
|
|
|
|
Testing is done using [Tox](https://tox.readthedocs.io/en/latest/) and [Molecule](https://github.com/ansible/molecule):
|
|
|
|
[Tox](https://tox.readthedocs.io/en/latest/) tests multiple ansible versions.
|
|
[Molecule](https://github.com/ansible/molecule) tests multiple distributions.
|
|
|
|
To test using the defaults (any installed ansible version, namespace: `{{ docker_namespace }}`, image: `{{ docker_image }}`, tag: `{{ docker_tag }}`):
|
|
|
|
```
|
|
molecule test
|
|
|
|
# Or select a specific image:
|
|
image=ubuntu molecule test
|
|
# Or select a specific image and a specific tag:
|
|
image="debian" tag="stable" tox
|
|
```
|
|
|
|
Or you can test multiple versions of Ansible, and select images:
|
|
Tox allows multiple versions of Ansible to be tested. To run the default (namespace: `{{ docker_namespace }}`, image: `{{ docker_image }}`, tag: `{{ docker_tag }}`) tests:
|
|
|
|
```
|
|
tox
|
|
|
|
# To run CentOS (namespace: `{{ docker_namespace }}`, tag: `{{ docker_tag }}`)
|
|
image="centos" tox
|
|
# Or customize more:
|
|
image="debian" tag="stable" tox
|
|
```
|
|
|
|
## [License](#license)
|
|
|
|
{{ meta.galaxy_info.license }}
|
|
|
|
|
|
## [Author Information](#author-information)
|
|
|
|
[{{ meta.galaxy_info.author }}]({{ author_website }})
|
|
|
|
Please consider [sponsoring me](https://github.com/sponsors/robertdebock).
|