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

48 lines
1.1 KiB
Markdown
Raw Normal View History

2020-04-28 13:23:10 +02:00
# {{ cookiecutter.app_name | replace('_',' ') | title }} Ansible role
This role installs {{ cookiecutter.app_name | title }} via Docker compose.
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
## Requirements
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
None
2023-01-12 13:31:07 +01:00
## Role Variables
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
All variables are listed below (see also `defaults/main.yml`).
2020-04-28 13:23:10 +02:00
```yml
2023-01-12 13:31:07 +01:00
---
2020-04-28 13:23:10 +02:00
```
2023-01-12 13:31:07 +01:00
## Dependencies
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
You need a machine with docker and docker-compose installed.
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
## Example Playbook
2020-04-28 13:23:10 +02:00
```yml
2023-01-12 13:31:07 +01:00
- hosts: servers
2020-04-28 13:23:10 +02:00
roles:
2023-01-12 13:31:07 +01:00
- 'laurivan.{{ cookiecutter.app_name | replace('_',' ') | title }}'
2020-04-28 13:23:10 +02:00
```
2023-01-12 13:31:07 +01:00
## License
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
This project is licensed under the [MIT](https://opensource.org/licenses/MIT) license - see the [LICENSE](LICENSE) file for details.
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
![MIT License](https://img.shields.io/badge/license-MIT%20License-brightgreen)
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
## Author Information
2020-04-28 13:23:10 +02:00
2023-01-12 13:31:07 +01:00
This role was created in 2023 by [Laur Ivan](https://www.laurivan.com).
2020-04-28 13:23:10 +02:00
## Built With
2023-01-12 13:31:07 +01:00
![Ansible](https://img.shields.io/badge/ansible-5.2.0-green.svg)
![Molecule](https://img.shields.io/badge/molecule-3.4.0-green.svg)
2020-12-28 11:41:00 +01:00
![Goss](https://img.shields.io/badge/goss-0.3.16-green.svg)
2020-04-28 13:23:10 +02:00
## Contributing
2023-01-12 13:31:07 +01:00
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.