From e06c5e24efaf43c2d2580d5dec0dc481d05b4ecc Mon Sep 17 00:00:00 2001 From: Laur Ivan Date: Thu, 12 Jan 2023 13:31:07 +0100 Subject: [PATCH] fix: Update README --- .../README.md | 111 +++++------------- .../tasks/config.yml | 3 +- .../tasks/main.yml | 1 - 3 files changed, 32 insertions(+), 83 deletions(-) diff --git a/ansible-role-{{cookiecutter.app_name}}/README.md b/ansible-role-{{cookiecutter.app_name}}/README.md index 04059a9..f0aa106 100644 --- a/ansible-role-{{cookiecutter.app_name}}/README.md +++ b/ansible-role-{{cookiecutter.app_name}}/README.md @@ -1,100 +1,49 @@ # {{ cookiecutter.app_name | replace('_',' ') | title }} Ansible role -![Logo](logo.gif) +# {{ cookiecutter.namespace }}.{{ cookiecutter.app_name | replace('_',' ') | title }} -This role has been generated using the [cookiecutter](https://github.com/cookiecutter/cookiecutter) tool, you can generate a similar role that fits your needs using the this [cookiecutter template](https://github.com/idealista/cookiecutter-ansible-role). +This role installs Mealie via Docker compose. -- [Getting Started](#getting-started) - - [Prerequisities](#prerequisities) - - [Installing](#installing) -- [Usage](#usage) -- [Testing](#testing) -- [Built With](#built-with) -- [Versioning](#versioning) -- [Authors](#authors) -- [License](#license) -- [Contributing](#contributing) +## Requirements -## Getting Started +None -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. +## Role Variables -### Prerequisities - -Ansible {{ cookiecutter.ansible_version }} version installed. - -Molecule 3.x.x version installed. - -For testing purposes, [Molecule](https://molecule.readthedocs.io/) with [Docker](https://www.docker.com/) as driver and [Goss](https://github.com/aelsabbahy/goss) as verifier. - -### Installing - -Create or add to your roles dependency file (e.g requirements.yml): - -```yml -- src: ansible-role-{{ cookiecutter.app_name }} - version: 1.0.0 - name: {{cookiecutter.namespace}}.{{ cookiecutter.app_name }} -``` - -Install the role with ansible-galaxy command: - -```sh -ansible-galaxy install -p roles -r requirements.yml -f -``` - -Use in a playbook: +All variables are listed below (see also `defaults/main.yml`). ```yml --- -- hosts: someserver +``` + +## Dependencies + +You need a machine with docker and docker-compose installed. + +## Example Playbook + +```yml +- hosts: servers roles: - - role: {{cookiecutter.namespace}}.{{ cookiecutter.app_name }} + - 'laurivan.{{ cookiecutter.app_name | replace('_',' ') | title }}' ``` -## Usage - -Look to the [defaults](defaults/main.yml) properties file to see the possible configuration properties, it is very likely that you will not need to override any variables. - -## Testing - -### Install dependencies - -```sh -pipenv sync -``` - -For more information read the [pipenv docs](https://pipenv-fork.readthedocs.io/en/latest/). - -### Run test - -```sh -pipenv run molecule test -``` - -## Built With - -![Ansible](https://img.shields.io/badge/ansible-{{ cookiecutter.ansible_version }}-green.svg) -![Molecule](https://img.shields.io/badge/molecule-{{ cookiecutter.molecule_version }}-green.svg) -![Goss](https://img.shields.io/badge/goss-0.3.16-green.svg) - -## 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](CHANGELOG.md) file. - -## Authors - -- **Idealista** -- **Laur IVAN** - ## License -![Apache 2.0 License](https://img.shields.io/hexpm/l/plug.svg) +This project is licensed under the [MIT](https://opensource.org/licenses/MIT) license - see the [LICENSE](LICENSE) file for details. -This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details. +![MIT License](https://img.shields.io/badge/license-MIT%20License-brightgreen) + +## Author Information + +This role was created in 2023 by [Laur Ivan](https://www.laurivan.com). + +## Built With + +![Ansible](https://img.shields.io/badge/ansible-5.2.0-green.svg) +![Molecule](https://img.shields.io/badge/molecule-3.4.0-green.svg) +![Goss](https://img.shields.io/badge/goss-0.3.16-green.svg) ## Contributing -Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. diff --git a/ansible-role-{{cookiecutter.app_name}}/tasks/config.yml b/ansible-role-{{cookiecutter.app_name}}/tasks/config.yml index 4ff15c7..274c51b 100644 --- a/ansible-role-{{cookiecutter.app_name}}/tasks/config.yml +++ b/ansible-role-{{cookiecutter.app_name}}/tasks/config.yml @@ -20,4 +20,5 @@ loop: - "docker-compose.yml" tags: - - {{ cookiecutter.app_name }}_configure \ No newline at end of file + - {{ cookiecutter.app_name }}_configure + \ No newline at end of file diff --git a/ansible-role-{{cookiecutter.app_name}}/tasks/main.yml b/ansible-role-{{cookiecutter.app_name}}/tasks/main.yml index 5a36d6e..436afee 100644 --- a/ansible-role-{{cookiecutter.app_name}}/tasks/main.yml +++ b/ansible-role-{{cookiecutter.app_name}}/tasks/main.yml @@ -9,4 +9,3 @@ import_tasks: install.yml tags: - {{ cookiecutter.app_name }}_install -