Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robertdebock/ansible-role-skeleton

A template to easily create a new role.
https://github.com/robertdebock/ansible-role-skeleton

ansible ansible-galaxy ansible-role ansible-role-skeleton template

Last synced: 4 days ago
JSON representation

A template to easily create a new role.

Host: GitHub
URL: https://github.com/robertdebock/ansible-role-skeleton
Owner: robertdebock
License: apache-2.0
Created: 2018-08-14T19:29:34.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-04-15T09:31:26.000Z (7 months ago)
Last Synced: 2024-05-02T02:19:53.847Z (7 months ago)
Topics: ansible, ansible-galaxy, ansible-role, ansible-role-skeleton, template
Language: Jinja
Homepage: https://robertdebock.nl/
Size: 156 KB
Stars: 25
Watchers: 5
Forks: 10
Open Issues: 1
Metadata Files:
- Readme: README.md.j2
- Contributing: CONTRIBUTING.md.j2
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md.j2

Awesome Lists containing this project

README

        # [{{ role_name }}](#{{ role_name }})

Install and configure {{ role_name }} on your system.

|GitHub|GitLab|Downloads|Version|

|------|------|---------|-------|

|[![github](https://github.com/robertdebock/ansible-role-{{ role_name }}/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-{{ role_name }}/actions)|[![gitlab](https://gitlab.com/robertdebock-iac/ansible-role-{{ role_name }}/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-{{ role_name }})|[![downloads](https://img.shields.io/ansible/role/d/)](https://galaxy.ansible.com/robertdebock/{{ role_name }})|[![Version](https://img.shields.io/github/release/robertdebock/ansible-role-{{ role_name }}.svg)](https://github.com/robertdebock/ansible-role-{{ role_name }}/releases/)|

## [Example Playbook](#example-playbook)

This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-{{ role_name }}/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.

```yaml

---

- name: Converge

  hosts: all

  become: true

  gather_facts: true

  roles:

    - role: robertdebock.{{ role_name }}

```

The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-{{ role_name }}/blob/master/molecule/default/prepare.yml):

```yaml

---

- name: Prepare

  hosts: all

  become: true

  gather_facts: false

  roles:

    - role: robertdebock.bootstrap

```

Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.

## [Role Variables](#role-variables)

The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-{{ role_name }}/blob/master/defaults/main.yml):

```yaml

---

# defaults file for {{ role_name }}

```

## [Requirements](#requirements)

- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-{{ role_name }}/blob/master/requirements.txt).

## [State of used roles](#state-of-used-roles)

The following roles are used to prepare a system. You can prepare your system in another way.

| Requirement | GitHub | GitLab |

|-------------|--------|--------|

|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-bootstrap/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|

## [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:

![dependencies](https://raw.githubusercontent.com/robertdebock/ansible-role-{{ role_name }}/png/requirements.png "Dependencies")

## [Compatibility](#compatibility)

This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):

|container|tags|

|---------|----|

|[Alpine](https://hub.docker.com/r/robertdebock/alpine)|all|

|[Amazon](https://hub.docker.com/r/robertdebock/amazonlinux)|all|

|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|

|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|all|

|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|

|[opensuse](https://hub.docker.com/r/robertdebock/opensuse)|all|

|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|all|

The minimum version of Ansible required is 2.12, tests have been done to:

- The previous version.

- The current version.

- The development version.

If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-{{ role_name }}/issues).

## [License](#license)

[Apache-2.0](https://github.com/robertdebock/ansible-role-{{ role_name }}/blob/master/LICENSE).

## [Author Information](#author-information)

[robertdebock](https://robertdebock.nl/)

Please consider [sponsoring me](https://github.com/sponsors/robertdebock).