Compare commits

...

23 Commits

Author SHA1 Message Date
d7ab4f5155 chore(release): 1.1.1 2023-04-30 13:34:32 +02:00
f03ca6d168 Fix docker-compose template. 2023-04-30 13:34:22 +02:00
f417e1828d chore: Better lint compliance 2023-04-30 13:07:53 +02:00
a412940e75 chore(release): 1.1.0 2023-04-27 22:05:51 +02:00
bda1f187c5 feat: Better default configuration.
Add multiple files copy via variables.
Add service skeleton.
Add image and port versions.
2023-04-27 22:05:41 +02:00
8adf037392 chore: Updates and cleanups
- Update ansible lint version
- Add default doc link
- Support for 4.x molecule version
2023-04-11 22:16:41 +02:00
842d7c7826 chore(release): 1.0.3 2023-02-16 11:39:06 +01:00
77dcf468c3 chore: Update python dependencies. 2023-02-16 11:38:33 +01:00
5e1bbb4e0c chore: Remove logo. 2023-02-16 11:36:40 +01:00
7ac404854a chore: Add MIT License. 2023-02-16 11:35:25 +01:00
88e1088d17 fix: Correct closing brackets. 2023-02-15 10:47:57 +01:00
c8a6df17c6 fix: add .venv to gitignore. 2023-01-19 21:48:54 +01:00
17ec2c4152 chore: Lint YML 2023-01-12 13:54:14 +01:00
8a3994cd38 chore(release): 1.0.2 2023-01-12 13:35:59 +01:00
fa2d5b9d8d fix: More fix to README. 2023-01-12 13:35:54 +01:00
5068645964 chore(release): 1.0.1 2023-01-12 13:31:15 +01:00
e06c5e24ef fix: Update README 2023-01-12 13:31:07 +01:00
40ff2301fe fix: Fix main.yml. 2023-01-12 13:25:25 +01:00
f7ead2d3c6 chore: Clean up changelog 2023-01-11 21:34:53 +01:00
5413342847 chore(release): 1.0.0 2023-01-11 21:30:43 +01:00
fe7df1f907 fix: meta container version. 2023-01-11 21:29:59 +01:00
dea1634b98 fix: accolades 2023-01-11 21:29:23 +01:00
b44e69ad7e feat: Refactor the template for docker-compose. 2023-01-09 15:25:45 +01:00
53 changed files with 385 additions and 737 deletions

1
.gitignore vendored
View File

@ -8,6 +8,7 @@ __pycache__
*.iml *.iml
.idea .idea
.project .project
.venv
*.pyc *.pyc

View File

@ -1,218 +1,46 @@
# Change Log # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a changelog](https://github.com/olivierlacan/keep-a-changelog).
## Unreleased ### [1.1.1](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/compare/v1.1.0...v1.1.1) (2023-04-30)
## [2.10.1](https://github.com/idealista/cookiecutter-ansible-role/tree/2.10.) ## [1.1.0](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/compare/v1.0.3...v1.1.0) (2023-04-27)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.10.0...2.10.1)
### Fixed ### Features
- *[95](https://github.com/idealista/cookiecutter-ansible-role/issues/95)* Failing travis test builds due to pipenv @ultraheroe * Better default configuration. ([bda1f18](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/bda1f187c5b2c02042c8d34ddde5bec5b77a13f9))
## [2.10.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.10.0) ### [1.0.3](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/compare/v1.0.2...v1.0.3) (2023-02-16)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.9.0...2.10.0)
### Changed ### Bug Fixes
- *Improve README init scrips to avoid errors when create two roles on same path because already pipenv exists.* @adrian-arapiles * add .venv to gitignore. ([c8a6df1](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/c8a6df17c6e8d286169a41067612ed4c0bedc687))
- *Change travis.yml order of email notification as documentation explains.* @adrian-arapiles * Correct closing brackets. ([88e1088](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/88e1088d178842e41ff545d23286dabcf8e675de))
- *Add first line `---` to ansible-lint file because it's a yml.* @adrian-arapiles
### Fixed ### [1.0.2](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/compare/v1.0.1...v1.0.2) (2023-01-12)
- *[92](https://github.com/idealista/cookiecutter-ansible-role/issues/92) Fix meta.yml lint warning from `galaxy-tags` to `galaxy_tags`.* @adrian-arapiles
## [2.9.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.9.0) ### Bug Fixes
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.8.1...2.9.0) * More fix to README. ([fa2d5b9](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/fa2d5b9d8de10cd127797f7e1705c2e0b1ce98e0))
### Changed ### [1.0.1](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/compare/v1.0.0...v1.0.1) (2023-01-12)
- *[#86](https://github.com/idealista/cookiecutter-ansible-role/issues/86) Upgrade molecule config to test under debian bullseye* @santi-eidu
- *[#86](https://github.com/idealista/cookiecutter-ansible-role/issues/86) Upgrade ansible to v5.2.0 and ansible lint to v5.3.2 to avoid lint error* @santi-eidu
## [2.8.1](https://github.com/idealista/cookiecutter-ansible-role/tree/2.8.1) ### Bug Fixes
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.8.0...2.8.1) * Fix main.yml. ([40ff230](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/40ff2301feb283894a71cca57a1d2679443b131b))
* Update README ([e06c5e2](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/e06c5e24efaf43c2d2580d5dec0dc481d05b4ecc))
### Fixed ## 1.0.0 (2023-01-11)
- *[#87](https://github.com/idealista/cookiecutter-ansible-role/issues/87) Travis build image and link are broken in the README template* @emepege ### Features
## [2.8.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.8.0) * Refactor the template for docker-compose. ([b44e69a](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/b44e69ad7eaf1b3a0e284ac403c94c60c016a4ae))
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.7.0...2.8.0) ### Bug Fixes
### Added * accolades ([dea1634](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/dea1634b98c99230166d00ab5451adad9d004ddf))
* meta container version. ([fe7df1f](https://git.laurivan.com/Dev/cookiecutter-ansible-role-docker/commit/fe7df1f9073322a074489dcc5bfeb2397085dda7))
- *[#81](https://github.com/idealista/cookiecutter-ansible-role/issues/81) Add log path variable in defaults* @blalop
- *[#79](https://github.com/idealista/cookiecutter-ansible-role/issues/79) Add molecule-docker support* @blalop
- *[#79](https://github.com/idealista/cookiecutter-ansible-role/issues/79) Add default versions for Python packages* @blalop
- *[#83](https://github.com/idealista/cookiecutter-ansible-role/issues/83) Don't leave empty lines when using jinja* @blalop
## [2.7.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.7.0)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.6.1...2.7.0)
### Added
- *[#76](https://github.com/idealista/cookiecutter-ansible-role/issues/76) Create shell user variable* @emepege
## [2.6.1](https://github.com/idealista/cookiecutter-ansible-role/tree/2.6.1)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.6.0...2.6.1)
### Changed
- *[#73](https://github.com/idealista/cookiecutter-ansible-role/issues/73) Add document start to .yml files* @blalop
## [2.6.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.6.0)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.5.1...2.6.0)
### Added
- *[#69](https://github.com/idealista/cookiecutter-ansible-role/issues/69) Email notifications in travis.* @vicsufer
### Changed
### Fixed
- *[#67](https://github.com/idealista/cookiecutter-ansible-role/issues/67) fix needed task in check_mode- @vicsufer
### Removed
## [2.5.1](https://github.com/idealista/cookiecutter-ansible-role/tree/2.5.1)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.5.0...2.5.1)
### Changed
- *[#63](https://github.com/idealista/cookiecutter-ansible-role/issues/63) Ignore html in gitattributes file* @blalop
### Fixed
- *[#62](https://github.com/idealista/cookiecutter-ansible-role/issues/62) molecule verify fails and breaks the run when at least one test fail* @ultraheroe
- *[#60](https://github.com/idealista/cookiecutter-ansible-role/issues/60) [BUG] Wrong state option in "Ensure skeleton log paths" task* @emepege
## [2.5.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.5.0)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.4.1...2.5.0)
### Added
- *[#57](https://github.com/idealista/cookiecutter-ansible-role/issues/57) Added gitattributes file* @blalop
### Changed
- *[#55](https://github.com/idealista/cookiecutter-ansible-role/issues/55) Excluded non-role files from linting* @blalop
## [2.4.1](https://github.com/idealista/cookiecutter-ansible-role/tree/2.4.1)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.4.0...2.4.1)
### Fixed
- *[#50](https://github.com/idealista/cookiecutter-ansible-role/issues/50) Tags not applied properly from playbook* @vicsufer
## [2.4.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.4.0)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.3.0...2.4.0)
### Added
- *[#45](https://github.com/idealista/cookiecutter-ansible-role/issues/45) Documentation link provided on role generation* @xtianae7
### Changed
- *[#47](https://github.com/idealista/cookiecutter-ansible-role/pull/47) Bump goss version from 0.3.14 to 0.3.16* @vicsufer
- *[#46](https://github.com/idealista/cookiecutter-ansible-role/issues/46) Static tests instead of parameters* @xtianae7
## [2.3.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.3.0)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.2.0...2.3.0)
### Fixed
- *[#40](https://github.com/idealista/cookiecutter-ansible-role/issues/40) Updated yamllint configuration* @frantsao
### Changed
- *[#38](https://github.com/idealista/cookiecutter-ansible-role/pull/38) Bump goss version from 0.3.11 to 0.3.14* @vicsufer
- *[#30](https://github.com/idealista/cookiecutter-ansible-role/issues/30) Using a new version for issue template* @xtianae7
### Removed
- *[#39](https://github.com/idealista/cookiecutter-ansible-role/pull/39) Community health files* @vicsufer
- *[#30](https://github.com/idealista/cookiecutter-ansible-role/issues/30) PULL_REQUEST_TEMPLATE removed, replaced with default community health file* @xtianae7
## [2.2.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.2.0) (2020-11-10)
### [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.1.0...2.2.0)
### Fixed
- *[#27](https://github.com/idealista/cookiecutter-ansible-role/issues/27) Adding Probot configuration to Ansible Role template* @dortegau
### Changed
- *[#27](https://github.com/idealista/cookiecutter-ansible-role/issues/27) Increase to 90 days the minimum days to declare a PR/Issue as `staled`* @dortegau
- *[#32](https://github.com/idealista/cookiecutter-ansible-role/pull/32) Avoid closing automatically good first issues* @vicsufer
### Removed
- *[#29](https://github.com/idealista/cookiecutter-ansible-role/issues/29) Removing redudant script in .travis.yml* @xtianae7
## [2.1.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.1.0) (2020-10-19)
## [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/2.0.0...2.1.0)
### Added
- *[#20](https://github.com/idealista/cookiecutter-ansible-role/issues/20) Add basic configuration in order to enable Probot to delete automatically abandoned PRs/issues* @dortegau
### Fixed
- *[#23](https://github.com/idealista/cookiecutter-ansible-role/issues/23) Change references to branch master to main* @pgomezcaldito
## [2.0.0](https://github.com/idealista/cookiecutter-ansible-role/tree/2.0.0) (2020-10-13)
## [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/1.0.1...2.0.0)
### Removed
- *[#16](https://github.com/idealista/cookiecutter-ansible-role/issues/16) Remove debian jessie support* @pablogcaldito
### Added
- *[#15](https://github.com/idealista/cookiecutter-ansible-role/issues/15) Add pipenv wrapper* @pablogcaldito
- *Add boilerplate README.md* @vicsufer
## [1.0.1](https://github.com/idealista/cookiecutter-ansible-role/tree/1.0.1) (2020-09-17)
## [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/1.0.0...1.0.1)
### Removed
- *[#9](https://github.com/idealista/cookiecutter-ansible-role/issues/9) Remove Vagrant pattern from role gitignore file* @vicsufer
### Added
- *[#4](https://github.com/idealista/cookiecutter-ansible-role/issues/4) Upgrade to Goss v0.3.11* @pablogcaldito
### Fixed
- *[#11](https://github.com/idealista/cookiecutter-ansible-role/issues/11) Fix parameterization of PrivateTmp* @pablogcaldito
- *[#7](https://github.com/idealista/cookiecutter-ansible-role/issues/7) Fix bug in in the check version task in install.yml* @pablogcaldito
- *[#3](https://github.com/idealista/cookiecutter-ansible-role/issues/3) Fix typo in both contributing files* @pablogcaldito
## [1.0.0](https://github.com/idealista/cookiecutter-ansible-role/tree/1.0.0) (2020-04-28)
### Added
- *First release* @pablogcaldito

View File

@ -0,0 +1,2 @@
github: {{ cookiecutter.github_user }}
patreon: {{ cookiecutter.patreon_user }}

View File

@ -4,6 +4,7 @@ extends: default
ignore: | ignore: |
molecule/**/tests/ molecule/**/tests/
.venv
.github .github
.travis.yml .travis.yml

View File

@ -3,16 +3,16 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a changelog](https://github.com/olivierlacan/keep-a-changelog). This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a changelog](https://github.com/olivierlacan/keep-a-changelog).
## [Unreleased](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tree/develop) ## [Unreleased](https://github.com/{{ cookiecutter.github_user }}/ansible-role-{{ cookiecutter.app_name }}/tree/develop)
### Changed ### Changed
### Added ### Added
### Removed ### Removed
### Fixed ### Fixed
## [X.Y.Z](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tree/X.Y.Z) ## [X.Y.Z](https://github.com/{{ cookiecutter.github_user }}/ansible-role-{{ cookiecutter.app_name }}/tree/X.Y.Z)
### [Full Changelog](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/compare/1.0.0...X.Y.Z) ### [Full Changelog](https://github.com/{{ cookiecutter.github_user }}/ansible-role-{{ cookiecutter.app_name }}/compare/1.0.0...X.Y.Z)
### Changed ### Changed
*[#<issue_number>](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/issues/<issue_number>) \<Change description\>* @\<author\> *[#<issue_number>](https://github.com/{{ cookiecutter.github_user }}/ansible-role-{{ cookiecutter.app_name }}/issues/<issue_number>) \<Change description\>* @\<author\>
## [1.0.0](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tree/1.0.0) ## [1.0.0](https://github.com/{{ cookiecutter.github_user }}/ansible-role-{{ cookiecutter.app_name }}/tree/1.0.0)
- Initial release - Initial release

View File

@ -0,0 +1,10 @@
The MIT License (MIT)
=====================
Copyright © 2023 Laur IVAN
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -0,0 +1,47 @@
# {{ cookiecutter.app_name | replace('_',' ') | title }} Ansible role
This role installs {{ cookiecutter.app_name | title }} via Docker compose.
## Requirements
None
## Role Variables
All variables are listed below (see also `defaults/main.yml`).
```yml
---
```
## Dependencies
You need a machine with docker and docker-compose installed.
## Example Playbook
```yml
- hosts: servers
roles:
- 'laurivan.{{ cookiecutter.app_name | replace('_',' ') }}'
```
## License
This project is licensed under the [MIT](https://opensource.org/licenses/MIT) 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](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

View File

@ -0,0 +1,24 @@
---
## General
{{ cookiecutter.app_name }}_image: {{ cookiecutter.app_name }}:latest
{{ cookiecutter.app_name }}_http_port: {{ cookiecutter.http_port }}
# {{ cookiecutter.app_name | title }} paths
{{ cookiecutter.app_name }}_root_path: /var/local
{{ cookiecutter.app_name }}_data_base: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_root_path {% raw %}}}{% endraw %}/{{ cookiecutter.app_name }}"
{{ cookiecutter.app_name }}_config_path: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_root_path {% raw %}}}{% endraw %}/conf/{{ cookiecutter.app_name }}"
# Add other paths here to make sure they're created automatically
#
{{ cookiecutter.app_name }}_skeleton_paths:
- "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_config_path {% raw %}}}{% endraw %}"
# Add more templates to be copied into the config
{{ cookiecutter.app_name }}_configuration_files:
- "{% raw %}docker-compose.yml{% endraw %}"
- "env.{{ cookiecutter.app_name }}.conf"
# Documentation
{{ cookiecutter.app_name }}_documentation_link: "{{ cookiecutter.documentation_URL }}"

View File

@ -0,0 +1,2 @@
---
# Handlers for {{ cookiecutter.app_name }}

View File

@ -0,0 +1,24 @@
---
galaxy_info:
author: {{ cookiecutter.author }}
namespace: {{ cookiecutter.namespace }}
{% if cookiecutter.company != "" %} company: {{ cookiecutter.company }}{% endif %}
role_name: {{ cookiecutter.app_name }}
description: {{ cookiecutter.app_name | replace('_',' ') | title }} Role
min_ansible_version: "{{ cookiecutter.min_ansible_version }}"
min_ansible_container_version: "{{ cookiecutter.min_ansible_container_version }}"
license: {{ cookiecutter.license }}
galaxy_tags:
- {{ cookiecutter.galaxy_tag_1 }}
- {{ cookiecutter.galaxy_tag_2 }}
- {{ cookiecutter.galaxy_tag_3 }}
platforms:{% if cookiecutter.platforms.debian_list %}
- name: Debian
versions:{% for ver in cookiecutter.platforms.debian_list %}
- {{ ver }}{% endfor %}
{% endif %}{% if cookiecutter.platforms.ubuntu_list %}
- name: Ubuntu
versions:{% for ver in cookiecutter.platforms.ubuntu_list %}
- {{ ver }}{% endfor %}
{% endif %}

View File

@ -0,0 +1,27 @@
---
- name: Clean up
hosts: all
gather_facts: true
tasks:
- name: "{{ cookiecutter.app_name | upper }} | Load the defaults."
ansible.builtin.include_vars:
dir: "../../defaults"
- name: "{{ cookiecutter.app_name | upper }} | Check if the docker-compose file exists."
ansible.builtin.stat:
path: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_config_path | expanduser | realpath {% raw %}}}{% endraw %}/docker-compose.yml"
register: "docker_compose_file"
- name: "{{ cookiecutter.app_name | upper }} | Remove docker-compose."
community.docker.docker_compose:
project_src: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_config_path | expanduser | realpath {% raw %}}}{% endraw %}/"
build: false
state: absent
when: "docker_compose_file.stat.exists"
become: false
- name: "{{ cookiecutter.app_name | upper }} | Remove the docker-compose file"
ansible.builtin.file:
path: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_config_path | expanduser | realpath {% raw %}}}{% endraw %}/docker-compose.yml"
state: "absent"
when: "docker_compose_file.stat.exists"

View File

@ -0,0 +1,5 @@
---
- name: "{{ cookiecutter.app_name | upper }} | Converge"
hosts: "{{ cookiecutter.app_name }}_group"
roles:
- role: "{{cookiecutter.namespace}}.{{ cookiecutter.app_name }}"

View File

@ -0,0 +1,27 @@
---
- name: "{{ cookiecutter.app_name | upper }} | Destroy"
hosts: "localhost"
connection: "local"
gather_facts: false
no_log: "{% raw %}{{ molecule_no_log }}{% endraw %}"
tasks:
# Developer must implement.
- name: "{{ cookiecutter.app_name | upper }} | Remove the docker image"
community.docker.docker_container:
name: "{{ cookiecutter.app_name }}"
state: "absent"
# Mandatory configuration for Molecule to function.
- name: "{{ cookiecutter.app_name | upper }} | Populate instance config"
ansible.builtin.set_fact:
instance_conf: {}
- name: "{{ cookiecutter.app_name | upper }} | Dump instance config"
ansible.builtin.copy:
content: |
# Molecule managed
{% raw %}{{ instance_conf | to_json | from_json | to_yaml }}{% endraw %}
dest: "{% raw %}{{ molecule_instance_config }}{% endraw %}"
mode: 0600
when: "server.changed | default(false) | bool"

View File

@ -1,6 +1,11 @@
--- ---
dependency: dependency:
name: galaxy name: galaxy
options:
ignore-certs: true
ignore-errors: true
role-file: molecule/requirements.yml
requirements-file: molecule/requirements.yml
driver: driver:
name: docker name: docker
lint: | lint: |
@ -10,8 +15,9 @@ platforms:
- name: {{ cookiecutter.app_name }} - name: {{ cookiecutter.app_name }}
groups: groups:
- {{ cookiecutter.app_name }}_group - {{ cookiecutter.app_name }}_group
image: ${MOLECULE_DISTRO:-debian:bullseye-slim} image: "geerlingguy/docker-${MOLECULE_DISTRO:-centos8}-ansible:latest"
privileged: false privileged: true
pre_build_image: true
capabilities: capabilities:
- SYS_ADMIN - SYS_ADMIN
tmpfs: tmpfs:
@ -20,9 +26,12 @@ platforms:
- /run/lock - /run/lock
volumes: volumes:
- '/sys/fs/cgroup:/sys/fs/cgroup:ro' - '/sys/fs/cgroup:/sys/fs/cgroup:ro'
- '/var/run/docker.sock:/tmp/docker_mounted.sock'
command: '/lib/systemd/systemd' command: '/lib/systemd/systemd'
stop_signal: 'RTMIN+3' stop_signal: 'RTMIN+3'
provisioner: provisioner:
name: ansible name: ansible
playbooks:
converge: ${MOLECULE_PLAYBOOK:-converge.yml}
verifier: verifier:
name: ansible name: ansible

View File

@ -0,0 +1,38 @@
---
- name: "{{ cookiecutter.app_name | upper }} | Setup the test machine"
hosts: "{{ cookiecutter.app_name }}"
tasks:
- name: "{{ cookiecutter.app_name | upper }} | Check if /var/run/docker.sock already exists"
ansible.builtin.stat:
path: "/var/run/docker.sock"
register: "docker_sock_stat"
- name: "{{ cookiecutter.app_name | upper }} | Create docker.sock"
ansible.builtin.raw: touch /var/run/docker.sock
become: true
changed_when: false
when: "not docker_sock_stat.stat.exists"
- name: "{{ cookiecutter.app_name | upper }} | Move docker.sock from tmp"
ansible.builtin.raw: >
mount --move /tmp/docker_mounted.sock /var/run/docker.sock
become: true
changed_when: false
when: "not docker_sock_stat.stat.exists"
- name: "{{ cookiecutter.app_name | upper }} | Update apt cache."
ansible.builtin.apt: update_cache=yes cache_valid_time=600
when: "ansible_os_family == 'Debian'"
- name: "{{ cookiecutter.app_name | upper }} | Install python requests"
ansible.builtin.pip:
name:
- "requests"
- "docker"
- "docker-compose"
- name: "{{ cookiecutter.app_name | upper }} | Install docker"
vars:
docker_service_manage: false
ansible.builtin.include_role:
name: "geerlingguy.docker"

View File

@ -0,0 +1,4 @@
---
roles:
- "geerlingguy.docker"
collections: []

View File

@ -0,0 +1,12 @@
---
## TODO: Remember to adapt goss tests to your convenience
## Check if ports are really exposed
# port:
# # Check port at IPv6
# # https://github.com/aelsabbahy/goss/issues/177
# tcp6:<port>:
# listening: true
# ip:
# - '::'

View File

@ -5,54 +5,54 @@
- name: Verify {{ cookiecutter.app_name | replace('_',' ') }} - name: Verify {{ cookiecutter.app_name | replace('_',' ') }}
hosts: hosts:
- {{ cookiecutter.app_name }} - "{{ cookiecutter.app_name }}"
become: true become: true
vars: vars:
goss_version: v0.3.16 goss_version: "v0.3.16"
goss_arch: amd64 goss_arch: "amd64"
goss_dst: /usr/local/bin/goss goss_dst: "/usr/local/bin/goss"
goss_sha256sum: 827e354b48f93bce933f5efcd1f00dc82569c42a179cf2d384b040d8a80bfbfb goss_sha256sum: "827e354b48f93bce933f5efcd1f00dc82569c42a179cf2d384b040d8a80bfbfb"
goss_url: "https://github.com/aelsabbahy/goss/releases/download/{% raw %}{{{% endraw %} goss_version {% raw %}}}{% endraw %}/goss-linux-{% raw %}{{{% endraw %} goss_arch {% raw %}}}{% endraw %}" goss_url: "https://github.com/aelsabbahy/goss/releases/download/{% raw %}{{{% endraw %} goss_version {% raw %}}}{% endraw %}/goss-linux-{% raw %}{{{% endraw %} goss_arch {% raw %}}}{% endraw %}"
goss_test_directory: /tmp goss_test_directory:" /tmp"
goss_format: documentation goss_format: "documentation"
vars_files: vars_files:
- ../../defaults/main.yml - ../../defaults/main.yml
tasks: tasks:
- name: Download and install Goss - name: "{{ cookiecutter.app_name | upper }} | Download and install Goss"
get_url: get_url:
url: "{% raw %}{{{% endraw %} goss_url {% raw %}}}{% endraw %}" url: "{% raw %}{{{% endraw %} goss_url {% raw %}}}{% endraw %}"
dest: "{% raw %}{{{% endraw %} goss_dst {% raw %}}}{% endraw %}" dest: "{% raw %}{{{% endraw %} goss_dst {% raw %}}}{% endraw %}"
checksum: "sha256{% raw %}:{{{% endraw %} goss_sha256sum {% raw %}}}{% endraw %}" checksum: "sha256{% raw %}:{{{% endraw %} goss_sha256sum {% raw %}}}{% endraw %}"
mode: 0755 mode: 0755
register: download_goss register: "download_goss"
until: download_goss is succeeded until: "download_goss is succeeded"
retries: 3 retries: 3
- name: Copy Goss tests to remote - name: "{{ cookiecutter.app_name | upper }} | Copy Goss tests to remote"
template: template:
src: "{% raw %}{{{% endraw %} item {% raw %}}}{% endraw %}" src: "{% raw %}{{{% endraw %} item {% raw %}}}{% endraw %}"
dest: "{% raw %}{{{% endraw %} goss_test_directory {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} item | basename {% raw %}}}{% endraw %}" dest: "{% raw %}{{{% endraw %} goss_test_directory {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} item | basename {% raw %}}}{% endraw %}"
with_fileglob: with_fileglob:
- "tests/test_*.yml" - "tests/test_*.yml"
- name: Register test files - name: "{{ cookiecutter.app_name | upper }} | Register test files"
shell: "ls {% raw %}{{{% endraw %} goss_test_directory {% raw %}}}{% endraw %}/test_*.yml" shell: "ls {% raw %}{{{% endraw %} goss_test_directory {% raw %}}}{% endraw %}/test_*.yml"
register: test_files register: "test_files"
- name: Execute Goss tests - name: "{{ cookiecutter.app_name | upper }} | Execute Goss tests"
command: "{% raw %}{{{% endraw %} goss_dst {% raw %}}}{% endraw %} -g {% raw %}{{{% endraw %} item {% raw %}}}{% endraw %} validate --format {% raw %}{{{% endraw %} goss_format {% raw %}}}{% endraw %}" command: "{% raw %}{{{% endraw %} goss_dst {% raw %}}}{% endraw %} -g {% raw %}{{{% endraw %} item {% raw %}}}{% endraw %} validate --format {% raw %}{{{% endraw %} goss_format {% raw %}}}{% endraw %}"
register: test_results register: "test_results"
with_items: "{% raw %}{{{% endraw %} test_files.stdout_lines {% raw %}}}{% endraw %}" with_items: "{% raw %}{{{% endraw %} test_files.stdout_lines {% raw %}}}{% endraw %}"
ignore_errors: true ignore_errors: true
- name: Display details about the Goss results - name: "{{ cookiecutter.app_name | upper }} | Display details about the Goss results"
debug: debug:
msg: "{% raw %}{{{% endraw %} item.stdout_lines {% raw %}}}{% endraw %}" msg: "{% raw %}{{{% endraw %} item.stdout_lines {% raw %}}}{% endraw %}"
with_items: "{% raw %}{{{% endraw %} test_results.results {% raw %}}}{% endraw %}" with_items: "{% raw %}{{{% endraw %} test_results.results {% raw %}}}{% endraw %}"
- name: Fail when tests fail - name: "{{ cookiecutter.app_name | upper }} | Fail when tests fail"
fail: fail:
msg: "Goss failed to validate" msg: "Goss failed to validate"
when: item.rc != 0 when: item.rc != 0

View File

@ -0,0 +1,24 @@
---
- name: "{{ cookiecutter.app_name | upper }} | Set up directories"
ansible.builtin.file:
state: directory
path: "{%raw%}{{{%endraw%} item }}"
owner: "{%raw%}{{{%endraw%} ansible_effective_user_id {%raw%}}}{%endraw%}"
group: "{%raw%}{{{%endraw%} ansible_effective_group_id {%raw%}}}{%endraw%}"
mode: "0750"
with_items:
- "{%raw%}{{{%endraw%} {{ cookiecutter.app_name }}_skeleton_paths {%raw%}}}{%endraw%}"
tags:
- {{ cookiecutter.app_name }}_configure
become: true
- name: "{{ cookiecutter.app_name | upper }} | Write configuration files"
ansible.builtin.template:
src: "{%raw%}{{{%endraw%} item {%raw%}}}{%endraw%}.j2"
dest: "{%raw%}{{{%endraw%} {{ cookiecutter.app_name }}_config_path | expanduser | realpath {%raw%}}}{%endraw%}/{%raw%}{{{%endraw%} item {%raw%}}}{%endraw%}"
mode: '0640'
with_items:
- "{%raw%}{{{%endraw%} {{ cookiecutter.app_name }}_configuration_files {%raw%}}}{%endraw%}"
tags:
- {{ cookiecutter.app_name }}_configure

View File

@ -0,0 +1,7 @@
---
- name: "{{ cookiecutter.app_name | upper }} | Ensure {{ cookiecutter.app_name }} is running"
community.docker.docker_compose:
project_src: "{%raw%}{{{%endraw%} {{ cookiecutter.app_name }}_config_path | expanduser | realpath {%raw%}}}{%endraw%}"
build: false
tags:
- {{ cookiecutter.app_name }}_install

View File

@ -0,0 +1,11 @@
---
- name: "{{ cookiecutter.app_name | upper }} | Configure"
import_tasks: config.yml
tags:
- {{ cookiecutter.app_name }}_configure
- name: "{{ cookiecutter.app_name | upper }} | Install"
import_tasks: install.yml
tags:
- {{ cookiecutter.app_name }}_install

View File

@ -0,0 +1,26 @@
# {{ cookiecutter.app_name }} docker compose
version: '3.9'
services:
{{ cookiecutter.app_name}}:
image: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_image {% raw %}}}{% endraw %}"
container_name: {{ cookiecutter.app_name }}-service
restart: always
env_file:
- "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_config_path | expanduser {% raw %}}}{% endraw %}/env.{{ cookiecutter.app_name }}.conf"
ports:
- "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_http_port {% raw %}}}{% endraw %}"
# Add more ports if necessary
networks:
- {{ cookiecutter.app_name }}-net
# optional
volumes:
- "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_volume {% raw %}}}{% endraw %}"
depends_on:
- other
- services
volumes:
- "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_volume {% raw %}}}{% endraw %}"
networks:
{{ cookiecutter.app_name }}-net: {}

View File

@ -0,0 +1,2 @@
# Add environment variables for {{ cookiecutter.app_name }} here
# Note: This is a .ini file format

View File

@ -5,6 +5,7 @@ __pycache__
.pytest_cache .pytest_cache
.molecule .molecule
.cache .cache
.venv
*.iml *.iml
.idea .idea

View File

@ -10,8 +10,8 @@ install:
- pipenv sync - pipenv sync
env: env:
jobs: jobs:
{% if cookiecutter.debian_buster_support == 'True' %}- MOLECULE_DISTRO=debian:buster-slim{% endif %} {% if "buster" in cookiecutter.platforms.debian_list %}- MOLECULE_DISTRO=debian:buster-slim{% endif %}
{% if cookiecutter.debian_bullseye_support == 'True' %}- MOLECULE_DISTRO=debian:bullseye-slim{% endif %} {% if "bullseye" in cookiecutter.platforms.debian_list %}- MOLECULE_DISTRO=debian:bullseye-slim{% endif %}
script: script:
- pipenv run molecule test --all - pipenv run molecule test --all
@ -22,4 +22,4 @@ notifications:
on_success: change on_success: change
on_failure: always on_failure: always
recipients: recipients:
- desarrollo.benders@idealista.com - laur.ivan@gmail.com

View File

@ -2,27 +2,30 @@
"comment_0":"The role name will be the value you assign to app_name with _role appended", "comment_0":"The role name will be the value you assign to app_name with _role appended",
"comment_1":"Introduce in exec_name the executable file name, you can change it later in the defaults/main.yml if you don't know it", "comment_1":"Introduce in exec_name the executable file name, you can change it later in the defaults/main.yml if you don't know it",
"app_name": "", "app_name": "",
"exec_name":"", "http_port": "3000",
"github_user": "idealista", "github_user": "equinoxel",
"company": "Idealista S.A.U.", "patreon_user": "laurivan",
"author": "", "company": "",
"min_ansible_version": "", "author": "Laur Ivan (laur.ivan@gmail.com)",
"ansible_version": "5.2.0", "namespace": "laurivan",
"molecule_version": "3.4.0", "min_ansible_version": "2.4",
"python_docker_version": "5.0.0", "min_ansible_container_version": "2.4",
"molecule_docker_version": "0.2.4", "ansible_version": "7.2.0",
"ansible_lint_version":"5.3.2", "molecule_version": "4.0.4",
"yamllint_version": "1.28.0", "python_docker_version": "6.0.1",
"license":"Apache 2.0", "molecule_docker_version": "2.1.0",
"ansible_lint_version":"6.14.4",
"yamllint_version": "1.30.0",
"license":"MIT",
"galaxy_tag_1":"tag1", "galaxy_tag_1":"tag1",
"galaxy_tag_2":"tag2", "galaxy_tag_2":"tag2",
"galaxy_tag_3":"tag3", "galaxy_tag_3":"tag3",
"debian_bullseye_support":["True", "False"], "platforms": {
"debian_buster_support":["True", "False"], "debian_list": ["bullseye", "buster"],
"has_service":["True", "False"], "ubuntu_list": ["bionic", "focal", "jammy"]
},
"has_files":["True", "False"], "has_files":["True", "False"],
"comment_2":"If there is service the following options will not have any effect",
"has_handlers":["True", "False"], "has_handlers":["True", "False"],
"has_templates":["True", "False"], "has_templates":["True", "False"],
"documentation_URL":"" "documentation_URL":"https://www.laurivan.com"
} }

View File

@ -12,23 +12,21 @@ def checkInput():
print("Error: app_name should not have _role or -role at the end, try again without it") print("Error: app_name should not have _role or -role at the end, try again without it")
print(" The name of the role will the value you introduce in app_name plus _role appended") print(" The name of the role will the value you introduce in app_name plus _role appended")
sys.exit(1) sys.exit(1)
if not moleculeVersion.startswith("3"): if not (moleculeVersion.startswith("3") or moleculeVersion.startswith("4")):
print("Error: Only supported molecule version 3.x.x, please change it and try again") print("Error: Only supported molecule version 3.x.x or 4.x.x, please change it and try again")
sys.exit(1) sys.exit(1)
def configureRole(): def configureRole():
# Remove or not the service # Remove or not the service
if not {{ cookiecutter.has_service }}:
# Delete the service and things that reference the service shutil.rmtree("molecule/default/group_vars")
os.remove("tasks/service.yml") # Remove or not the handlers folder
os.remove("templates/{{ cookiecutter.app_name }}.service.j2") if not {{ cookiecutter.has_handlers }}:
shutil.rmtree("molecule/default/group_vars") shutil.rmtree("handlers")
# Remove or not the handlers folder # Remove or not the templates folder
if not {{ cookiecutter.has_handlers }}: if not {{ cookiecutter.has_templates }}:
shutil.rmtree("handlers") shutil.rmtree("templates")
# Remove or not the templates folder
if not {{ cookiecutter.has_templates }}:
shutil.rmtree("templates")
# Remove or not the files folder # Remove or not the files folder
if not {{ cookiecutter.has_files }}: if not {{ cookiecutter.has_files }}:
shutil.rmtree("files") shutil.rmtree("files")

View File

@ -14,7 +14,6 @@ printf "cookiecutter==1.7.2\nJinja2==2.11.2" > requirements.txt && pipenv instal
molecule_docker_version="0.2.4" \ molecule_docker_version="0.2.4" \
ansible_lint_version="5.3.2" \ ansible_lint_version="5.3.2" \
yamllint_version="1.28.0" \ yamllint_version="1.28.0" \
has_service="False" \
has_files="False" \ has_files="False" \
has_handlers="False" \ has_handlers="False" \
has_templates="False" \ has_templates="False" \

View File

@ -1,67 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
Copyright {% now 'utc', '%Y' %} Idealista S.A.U.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@ -1,109 +0,0 @@
# {{ cookiecutter.app_name | replace('_',' ') | title }} Ansible role
![Logo](logo.gif)
[![Build Status](https://app.travis-ci.com/idealista/{{ cookiecutter.app_name }}_role.svg)](https://app.travis-ci.com/github/idealista/{{ cookiecutter.app_name }}_role)
[![Ansible Galaxy](https://img.shields.io/badge/galaxy-idealista.{{ cookiecutter.app_name }}_role-B62682.svg)](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_bullseye_support == 'True' %}* Bulleye{% endif %}
{% if cookiecutter.debian_buster_support == 'True' %}* Buster{% endif %}
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).
- [Getting Started](#getting-started)
- [Prerequisities](#prerequisities)
- [Installing](#installing)
- [Usage](#usage)
- [Testing](#testing)
- [Built With](#built-with)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Contributing](#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](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):
```
- 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](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](ipenv-fork.readthedocs.io/en/latest/).
### Testing
```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 }}/{{ cookiecutter.app_name }}_role/tags).
Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.
## Authors
* **Idealista** - *Work with* - [idealista](https://github.com/idealista)
See also the list of [contributors](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/contributors) who participated in this project.
## License
![Apache 2.0 License](https://img.shields.io/hexpm/l/plug.svg)
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.
## Contributing
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

View File

@ -1,62 +0,0 @@
---
## General
# Version
{{ cookiecutter.app_name }}_version: 1.0.0
{{ cookiecutter.app_name }}_release_system: linux_amd64
# Package URL
{{ cookiecutter.app_name }}_release_name: "exampleapplication_{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_version {% raw %}}}{% endraw %}_{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_release_system {% raw %}}}{% endraw %}"
{{ cookiecutter.app_name }}_package: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_release_name {% raw %}}}{% endraw %}.tar.gz"
{{ cookiecutter.app_name }}_url: "https://github.com/someuser/somerepo/releases/download/v{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_version {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_package {% raw %}}}{% endraw %}"
# Package paths
{{ cookiecutter.app_name }}_download_path: /usr/src
{{ cookiecutter.app_name }}_package_path: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_download_path {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_package {% raw %}}}{% endraw %}"
{{ cookiecutter.app_name }}_src_bin: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_download_path {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_release_name {% raw %}}}{% endraw %}/bin/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_exec_name {% raw %}}}{% endraw %}"
# Set true to force the download and installation of the binary
{{ cookiecutter.app_name }}_force_reinstall: false
# Installation path
{{ cookiecutter.app_name }}_root_path: /opt/{{ cookiecutter.app_name }}
{{ cookiecutter.app_name }}_bin_path: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_root_path {% raw %}}}{% endraw %}/bin"
{{ cookiecutter.app_name }}_skeleton_paths:
- "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_bin_path {% raw %}}}{% endraw %}"
{{ cookiecutter.app_name }}_exec_name: {{ cookiecutter.exec_name }}
{% if cookiecutter.has_service == 'True' %}
## Service options
# Documentation
{{ cookiecutter.app_name }}_documentation_link: "{{ cookiecutter.documentation_URL }}"
# Owner
{{ cookiecutter.app_name }}_user: exampleuser
{{ cookiecutter.app_name }}_group: examplegroup
{{ cookiecutter.app_name }}_user_shell: /usr/sbin/nologin
# Maximum number of files limit
{{ cookiecutter.app_name }}_max_files: 32768
# Start on boot
{{ cookiecutter.app_name }}_service_enabled: True
# Current state: started, stopped
{{ cookiecutter.app_name }}_service_state: started
# Logs
# If wanted to output the logs to a file define the following variable
# More information at https://www.freedesktop.org/software/systemd/man/systemd.exec.html#StandardOutput=
# {{ cookiecutter.app_name }}_log_path: /var/log
# {{ cookiecutter.app_name }}_log_file: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_log_path {% raw %}}}{% endraw %}/{{ cookiecutter.app_name }}.log"
{{ cookiecutter.app_name }}_log_output: "{% raw %}{%{% endraw %} if {{ cookiecutter.app_name }}_log_file is defined {% raw %}%}{% endraw %} file:{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_log_file {% raw %}}}{% endraw %} {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} journal {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %}"
# Flags
{{ cookiecutter.app_name }}_port: # the port exposed by the service goes here
{{ cookiecutter.app_name }}_flag1_value: example_value_1
{{ cookiecutter.app_name }}_flag2_value: example_value_2
{{ cookiecutter.app_name }}_options:
- "port {% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_port {% raw %}}}{% endraw %}"
- "flag1 {% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_flag1_value {% raw %}}}{% endraw %}"
- "flag2 {% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_flag2_value {% raw %}}}{% endraw %}"
{{ cookiecutter.app_name }}_private_tmp: true
{% endif %}

View File

@ -1,8 +0,0 @@
---
{% if cookiecutter.has_service == 'True' %}
- name: restart {{ cookiecutter.app_name }}
systemd:
name: {{ cookiecutter.app_name }}
state: restarted
when: {{ cookiecutter.app_name }}_service_state != 'stopped'
{% endif %}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

View File

@ -1,17 +0,0 @@
---
galaxy_info:
author: {{ cookiecutter.author }}
company: {{ cookiecutter.company }}
description: {{ cookiecutter.app_name | replace('_',' ') | title }} Role
min_ansible_version: {{ cookiecutter.min_ansible_version }}
license: {{ cookiecutter.license }}
galaxy_tags:
- {{ cookiecutter.galaxy_tag_1 }}
- {{ cookiecutter.galaxy_tag_2 }}
- {{ cookiecutter.galaxy_tag_3 }}
platforms:
- name: Debian
versions:
{% if cookiecutter.debian_bullseye_support == 'True' %}- bullseye{% endif %}
{% if cookiecutter.debian_buster_support == 'True' %}- buster{% endif %}

View File

@ -1,12 +0,0 @@
# Molecule managed
{% raw %}{% if item.registry is defined %}
FROM {{ item.registry.url }}/{{ item.image }}
{% else %}
FROM {{ item.image }}
{% endif %}
# install minimal packages for debian slim images
RUN apt-get update && \
apt-get install -y python3 sudo bash ca-certificates iproute2 systemd systemd-sysv python3-pip && \
apt-get clean{% endraw %}

View File

@ -1,5 +0,0 @@
---
- name: Converge
hosts: {{ cookiecutter.app_name }}_group
roles:
- role: {{ cookiecutter.app_name }}_role

View File

@ -1,46 +0,0 @@
---
## TODO: Remember to adapt goss tests to your convenience
{% if cookiecutter.has_service == 'True' %}
service:
{{ cookiecutter.app_name }}:
enabled: true
running: true
process:
{{ cookiecutter.exec_name }}:
running: true
user:
exampleuser:
exists: true
groups:
- examplegroup
shell: /usr/sbin/nologin
group:
examplegroup:
exists: true
{% endif %}
file:
/opt/{{ cookiecutter.app_name }}:
{%- if cookiecutter.has_service == 'True' %}
owner: exampleuser
group: examplegroup
{%- endif %}
exists: true
filetype: directory
/opt/{{ cookiecutter.app_name }}/bin:
{%- if cookiecutter.has_service == 'True' %}
owner: exampleuser
group: examplegroup
{%- endif %}
exists: true
filetype: directory
## Check if ports are really exposed
# port:
# # Check port at IPv6
# # https://github.com/aelsabbahy/goss/issues/177
# tcp6:<port>:
# listening: true
# ip:
# - '::'

View File

@ -1 +0,0 @@
---

View File

@ -1,95 +0,0 @@
---
{% if cookiecutter.has_service == 'True' %}
- name: {{ cookiecutter.app_name | upper }} | Ensure {{ cookiecutter.app_name }} group
group:
name: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
system: yes
state: present
tags:
- {{ cookiecutter.app_name }}_install
- name: {{ cookiecutter.app_name | upper }} | Ensure {{ cookiecutter.app_name }} user
user:
name: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}"
group: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
system: yes
shell: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user_shell {% raw %}}}{% endraw %}"
createhome: no
tags:
- {{ cookiecutter.app_name }}_install
{% endif %}
- name: {{ cookiecutter.app_name | upper }} | Ensure skeleton paths
file:
dest: "{% raw %}{{{% endraw %} item {% raw %}}}{% endraw %}"
{%- if cookiecutter.has_service == 'True' %}
owner: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}"
group: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
{%- endif %}
mode: 0755
state: directory
with_items:
- "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_skeleton_paths {% raw %}}}{% endraw %}"
tags:
- {{ cookiecutter.app_name }}_install
- name: {{ cookiecutter.app_name | upper }} | Ensure skeleton log paths
file:
dest: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_log_path {% raw %}}}{% endraw %}"
{%- if cookiecutter.has_service == 'True' %}
owner: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}"
group: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
{%- endif %}
mode: 0755
state: directory
when: {{ cookiecutter.app_name }}_log_file is defined
tags:
- {{ cookiecutter.app_name }}_install
- name: {{ cookiecutter.app_name | upper }} | Check {{ cookiecutter.app_name }} version
command: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_exec_name {% raw %}}}{% endraw %} --version"
register: {{ cookiecutter.app_name }}_check
changed_when: false
ignore_errors: true
check_mode: no
tags:
- {{ cookiecutter.app_name }}_install
- name: {{ cookiecutter.app_name | upper }} | Download package
get_url:
url: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_url {% raw %}}}{% endraw %}"
dest: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_package_path {% raw %}}}{% endraw %}"
when: {{ cookiecutter.app_name }}_force_reinstall or {{ cookiecutter.app_name }}_check is failed or {{ cookiecutter.app_name }}_version not in {{ cookiecutter.app_name }}_check.stderr
tags:
- {{ cookiecutter.app_name }}_install
- name: {{ cookiecutter.app_name | upper }} | Extract downloaded package
unarchive:
src: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_package_path {% raw %}}}{% endraw %}"
dest: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_download_path {% raw %}}}{% endraw %}"
remote_src: True
when: {{ cookiecutter.app_name }}_force_reinstall or {{ cookiecutter.app_name }}_check is failed or {{ cookiecutter.app_name }}_version not in {{ cookiecutter.app_name }}_check.stderr
tags:
- {{ cookiecutter.app_name }}_install
- name: {{ cookiecutter.app_name | upper }} | Copy binary
copy:
src: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_src_bin {% raw %}}}{% endraw %}"
dest: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_bin_path {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_exec_name {% raw %}}}{% endraw %}"
{%- if cookiecutter.has_service == 'True' %}
owner: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}"
group: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}"
{%- endif %}
remote_src: True
mode: 0755
when: {{ cookiecutter.app_name }}_force_reinstall or {{ cookiecutter.app_name }}_check is failed or {{ cookiecutter.app_name }}_version not in {{ cookiecutter.app_name }}_check.stderr
tags:
- {{ cookiecutter.app_name }}_install
- name: {{ cookiecutter.app_name | upper }} | Link binary
file:
src: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_bin_path {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_exec_name {% raw %}}}{% endraw %}"
dest: "/usr/bin/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_exec_name {% raw %}}}{% endraw %}"
state: link
when: {{ cookiecutter.app_name }}_force_reinstall or {{ cookiecutter.app_name }}_check is failed or {{ cookiecutter.app_name }}_version not in {{ cookiecutter.app_name }}_check.stderr
tags:
- {{ cookiecutter.app_name }}_install

View File

@ -1,17 +0,0 @@
---
- name: {{ cookiecutter.app_name | upper }} | Install
import_tasks: install.yml
tags:
- {{ cookiecutter.app_name }}_install
- name: {{ cookiecutter.app_name | upper }} | Configure
import_tasks: config.yml
tags:
- {{ cookiecutter.app_name }}_configure
{% if cookiecutter.has_service == 'True' %}
- name: {{ cookiecutter.app_name | upper }} | Service
import_tasks: service.yml
tags:
- {{ cookiecutter.app_name }}_service
{% endif %}

View File

@ -1,21 +0,0 @@
---
- name: {{ cookiecutter.app_name | upper }} | Copy Daemon script
template:
src: {{ cookiecutter.app_name }}.service.j2
dest: /etc/systemd/system/{{ cookiecutter.app_name }}.service
mode: 0644
owner: root
group: root
notify: restart {{ cookiecutter.app_name }}
tags:
- {{ cookiecutter.app_name }}_service
- name: {{ cookiecutter.app_name | upper }} | Configuring service
systemd:
name: {{ cookiecutter.app_name }}
state: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_service_state {% raw %}}}{% endraw %}"
enabled: "{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_service_enabled {% raw %}}}{% endraw %}"
daemon_reload: yes
tags:
- {{ cookiecutter.app_name }}_service

View File

@ -1,24 +0,0 @@
{% raw %}{{ ansible_managed | comment }}{% endraw %}
[Unit]
Description={{ cookiecutter.app_name | replace('_',' ') }}
Documentation={% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_documentation_link {% raw %}}}{% endraw %}
Requires=network-online.target
After=network-online.target
[Service]
PrivateTmp={% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_private_tmp {% raw %}}}{% endraw %}
User={% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_user {% raw %}}}{% endraw %}
Group={% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_group {% raw %}}}{% endraw %}
RuntimeDirectory={{ cookiecutter.app_name }}
LimitNOFILE={% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_max_files {% raw %}}}{% endraw %}
ExecStart={% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_bin_path {% raw %}}}{% endraw %}/{% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_exec_name {% raw %}}}{% endraw %} {% raw %}{%{% endraw %} for option in {{ cookiecutter.app_name }}_options {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} if option {% raw %}%}{% endraw %}-{% raw %}{{{% endraw %} option {% raw %}}}{% endraw %} {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %}
StandardOutput={% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_log_output {% raw %}}}{% endraw %}
StandardError={% raw %}{{{% endraw %} {{ cookiecutter.app_name }}_log_output {% raw %}}}{% endraw %}
ExecReload=/bin/kill -HUP $MAINPID
KillSignal=SIGTERM
Restart=always
[Install]
WantedBy=multi-user.target