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

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

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: ansible-role-{{ cookiecutter.app_name }}
  version: 1.0.0
  name: {{cookiecutter.namespace}}.{{ cookiecutter.app_name }}

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.namespace}}.{{ cookiecutter.app_name }}

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.

Run test

pipenv run molecule test 

Built With

 

Versioning

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

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

Authors

• Idealista
• Laur IVAN

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.