cookiecutter-ansible-role/{{cookiecutter.app_name}}_role/README.md

{{ cookiecutter.app_name | replace('_',' ') | title }} Ansible role

[](https://app.travis-ci.com/github/idealista/{{ cookiecutter.app_name }}_role) [](https://galaxy.ansible.com/idealista/{{ cookiecutter.app_name }}_role)

This ansible role installs {% if cookiecutter.documentation_URL != "" %}[{% endif %}{{ cookiecutter.app_name | replace('_',' ') | title }}{% if cookiecutter.documentation_URL != "" %}]({{ cookiecutter.documentation_URL }}){% endif %} in a Debian environment. It has been tested for the following Debian versions: {% if cookiecutter.debian_stretch_support == 'True' %}* Stretch{% endif %} {% if cookiecutter.debian_buster_support == 'True' %}* Buster{% endif %}

This role has been generated using the cookiecutter tool, you can generate a similar role that fits your needs using the this cookiecutter template.

• Getting Started
  • Prerequisities
  • Installing
• Usage
• Testing
• Built With
• Versioning
• Authors
• License
• Contributing

Getting Started

These instructions will get you a copy of the role for your Ansible playbook. Once launched, it will install {{ cookiecutter.app_name | replace('_',' ') | title }} in a Debian system.

Prerequisities

Ansible {{ cookiecutter.ansible_version }} version installed.

Molecule 3.x.x version installed.

For testing purposes, Molecule with Docker as driver and Goss as verifier.

Installing

Create or add to your roles dependency file (e.g requirements.yml):

- src: idealista.{{ cookiecutter.app_name }}_role
  version: 1.0.0
  name: {{ cookiecutter.app_name }}_role

Install the role with ansible-galaxy command:

ansible-galaxy install -p roles -r requirements.yml -f

Use in a playbook:

---
- hosts: someserver
  roles:
    - role: {{ cookiecutter.app_name }}_role

Usage

Look to the defaults properties file to see the possible configuration properties, it is very likely that you will not need to override any variables.

Testing

Install dependencies

$ pipenv sync

For more information read the pipenv docs.

Testing

$ pipenv run molecule test 

Built With

 

Versioning

For the versions available, see the [tags on this repository](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tags).

Additionaly you can see what change in each version in the CHANGELOG.md file.

Authors

• Idealista - Work with - idealista

See also the list of [contributors](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/contributors) who participated in this project.

License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.