diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..bd1a0dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Run this role: +2. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Error** +Please show the resulting error. If applicable a snippet of the playbook including the role ran with `-vvv` + +**Environment** +- Control node OS: [e.g. Debian 9] +- Control node Ansible version: [e.g. 2.6.2] +- Managed node OS: [e.g. CentOS 7] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..066b2d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/settings.yml b/.github/settings.yml new file mode 100644 index 0000000..b047ddc --- /dev/null +++ b/.github/settings.yml @@ -0,0 +1,4 @@ +--- +repository: + description: Install and configure logrotate on your system. + homepage: https://robertdebock.nl/ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..47cf7b9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +molecule/*/.molecule +*.log +*.swp \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..d1f7b26 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,93 @@ +--- +sudo: required +language: python +services: docker + +env: + - version=">=2.6,<2.7" distro="alpine-latest" + - version="" distro="alpine-latest" + - version="devel" distro="alpine-latest" + - version=">=2.6,<2.7" distro="alpine-edge" + - version="" distro="alpine-edge" + - version="devel" distro="alpine-edge" + - version=">=2.6,<2.7" distro="archlinux" + - version="" distro="archlinux" + - version="devel" distro="archlinux" + - version=">=2.6,<2.7" distro="centos-6" + - version="" distro="centos-6" + - version="devel" distro="centos-6" + - version=">=2.6,<2.7" distro="centos-latest" + - version="" distro="centos-latest" + - version="devel" distro="centos-latest" + - version=">=2.6,<2.7" distro="debian-latest" + - version="" distro="debian-latest" + - version="devel" distro="debian-latest" + - version=">=2.6,<2.7" distro="debian-stable" + - version="" distro="debian-stable" + - version="devel" distro="debian-stable" + - version=">=2.6,<2.7" distro="debian-unstable" + - version="" distro="debian-unstable" + - version="devel" distro="debian-unstable" + - version=">=2.6,<2.7" distro="fedora-latest" + - version="" distro="fedora-latest" + - version="devel" distro="fedora-latest" + - version=">=2.6,<2.7" distro="fedora-rawhide" + - version="" distro="fedora-rawhide" + - version="devel" distro="fedora-rawhide" + - version=">=2.6,<2.7" distro="opensuse-leap" + - version="" distro="opensuse-leap" + - version="devel" distro="opensuse-leap" + - version=">=2.6,<2.7" distro="ubuntu-rolling" + - version="" distro="ubuntu-rolling" + - version="devel" distro="ubuntu-rolling" + - version=">=2.6,<2.7" distro="ubuntu-latest" + - version="" distro="ubuntu-latest" + - version="devel" distro="ubuntu-latest" + - version=">=2.6,<2.7" distro="ubuntu-devel" + - version="" distro="ubuntu-devel" + - version="devel" distro="ubuntu-devel" + +matrix: + allow_failures: + - env: version=">=2.6,<2.7" distro="alpine-edge" + - env: version="" distro="alpine-edge" + - env: version="devel" distro="alpine-edge" + - env: version="devel" distro="alpine-latest" + - env: version="devel" distro="archlinux" + - env: version="devel" distro="centos-6" + - env: version="devel" distro="centos-latest" + - env: version="devel" distro="debian-latest" + - env: version="devel" distro="debian-stable" + - env: version=">=2.6,<2.7" distro="debian-unstable" + - env: version="" distro="debian-unstable" + - env: version="devel" distro="debian-unstable" + - env: version="devel" distro="fedora-latest" + - env: version=">=2.6,<2.7" distro="fedora-rawhide" + - env: version="" distro="fedora-rawhide" + - env: version="devel" distro="fedora-rawhide" + - env: version="devel" distro="opensuse-leap" + - env: version="devel" distro="ubuntu-rolling" + - env: version=">=2.6,<2.7" distro="ubuntu-devel" + - env: version="" distro="ubuntu-devel" + - env: version="devel" distro="ubuntu-devel" + - env: version="devel" distro="ubuntu-latest" + +cache: + - pip + +install: + - pip install --upgrade pip + - if [ "${version}" != "devel" ] ; then pip install ansible"${version}" ; fi + - if [ "${version}" = "devel" ] ; then pip install git+https://github.com/ansible/ansible.git@devel ; fi + - pip install molecule + - pip install docker + +script: + - if [ "${expectation}" = "fail" ] ; then ! molecule test --scenario-name "${distro}" ; else molecule test --scenario-name "${distro}" ; fi + +notifications: + webhooks: https://galaxy.ansible.com/api/v1/notifications/ + slack: + secure: "# out of `travis encrypt robertdebock:TOKEN-FROM-SLACK`" + + email: false diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..ad0be76 --- /dev/null +++ b/.yamllint @@ -0,0 +1,11 @@ +extends: default + +rules: + braces: + max-spaces-inside: 1 + level: error + brackets: + max-spaces-inside: 1 + level: error + line-length: disable + truthy: disable diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0d97a6f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behaviour that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behaviour by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behaviour and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at robert@meinit.nl. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2931dcf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +# Please contribute! +You can really make a difference by: +- [Making an issue](https://help.github.com/articles/creating-an-issue/). A well described issue helps a lot. +- [Making a pull request](https://services.github.com/on-demand/github-cli/open-pull-request-github) when you see the error in code. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..744118c --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) 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 + + (d) 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2019 Robert de Bock (robert@meinit.nl) + + 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. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b1578c0 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +--- +name: Pull request +about: Describe the proposed change + +--- + +**Describe the change** +A clear and concise description of what the pull request is. + +**Testing** +In case a feature was added, how were tests performed? diff --git a/README.md b/README.md new file mode 100644 index 0000000..f72b59c --- /dev/null +++ b/README.md @@ -0,0 +1,145 @@ +logrotate +========= + +[![Build Status](https://travis-ci.org/robertdebock/ansible-role-logrotate.svg?branch=master)](https://travis-ci.org/robertdebock/ansible-role-logrotate) + +Install and configure logrotate on your system. + +Example Playbook +---------------- + +This example is taken from `molecule/default/playbook.yml`: +```yaml +--- +- name: Converge + hosts: all + become: yes + gather_facts: yes + + roles: + - robertdebock.logrotate +``` + +The machine you are running this on, may need to be prepared. Tests have been done on machines prepared by this playbook: +```yaml +--- +- name: Converge + hosts: all + become: yes + gather_facts: no + + roles: + - robertdebock.bootstrap +``` + +Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles. + +Role Variables +-------------- + +These variables are set in `defaults/main.yml`: +```yaml +--- +# defaults file for logrotate + +# How often to rotate logs, either daily, weekly or monthly. +logrotate_frequency: weekly + +# How many files to keep. +logrotate_keep: 4 + +# Should rotated logs be compressed?? +logrotate_compress: yes + +logrotate_entries: + - name: example + path: "/var/log/example/*.log" + frequency: daily + keep: 7 + compress: no +``` + +Requirements +------------ + +- Access to a repository containing packages, likely on the internet. +- A recent version of Ansible. (Tests run on the last 3 release of Ansible.) + +The following roles can be installed to ensure all requirements are met, using `ansible-galaxy install -r requirements.yml`: + +```yaml +--- +- robertdebock.bootstrap + +``` + +Context +------- + +This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information. + +Here is an overview of related roles: +![dependencies](https://raw.githubusercontent.com/robertdebock/drawings/artifacts/logrotate.png "Dependency") + + +Compatibility +------------- + +This role has been tested against the following distributions and Ansible version: + +|distribution|ansible 2.6|ansible 2.7|ansible devel| +|------------|-----------|-----------|-------------| +|alpine-edge*|yes|yes|yes*| +|alpine-latest|yes|yes|yes*| +|archlinux|yes|yes|yes*| +|centos-6|yes|yes|yes*| +|centos-latest|yes|yes|yes*| +|debian-latest|yes|yes|yes*| +|debian-stable|yes|yes|yes*| +|debian-unstable*|yes|yes|yes*| +|fedora-latest|yes|yes|yes*| +|fedora-rawhide*|yes|yes|yes*| +|opensuse-leap|yes|yes|yes*| +|ubuntu-devel*|yes|yes|yes*| +|ubuntu-latest|yes|yes|yes*| +|ubuntu-rolling|yes|yes|yes*| + +A single star means the build may fail, it's marked as an experimental build. + +Testing +------- + +[Unit tests](https://travis-ci.org/robertdebock/ansible-role-logrotate) are done on every commit and periodically. + +If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-logrotate/issues) + +To test this role locally please use [Molecule](https://github.com/metacloud/molecule): +``` +pip install molecule +molecule test +``` + +To test on Amazon EC2, configure [~/.aws/credentials](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html) and `export AWS_REGION=eu-central-1` before running `molecule test --scenario-name ec2`. + +There are many specific scenarios available, please have a look in the `molecule/` directory. + +Run the [ansible-galaxy](https://github.com/ansible/galaxy-lint-rules) and [my](https://github.com/robertdebock/ansible-lint-rules) lint rules if you want your change to be merges: + +```shell +git clone https://github.com/ansible/ansible-lint.git /tmp/ansible-lint +ansible-lint -r /tmp/ansible-lint/lib/ansiblelint/rules . + +git clone https://github.com/robertdebock/ansible-lint /tmp/my-ansible-lint +ansible-lint -r /tmp/my-ansible-lint/rules . +``` + +License +------- + +Apache-2.0 + + +Author Information +------------------ + +[Robert de Bock](https://robertdebock.nl/) diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..e4d1273 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,18 @@ +--- +# defaults file for logrotate + +# How often to rotate logs, either daily, weekly or monthly. +logrotate_frequency: weekly + +# How many files to keep. +logrotate_keep: 4 + +# Should rotated logs be compressed?? +logrotate_compress: yes + +logrotate_entries: + - name: example + path: "/var/log/example/*.log" + frequency: daily + keep: 7 + compress: no diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..f3d0e81 --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,8 @@ +--- +# handlers file for logrotate +- name: restart logrotate + service: + name: "{{ logrotate_service }}" + state: restarted + when: + - ansible_virtualization_type != "docker" diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..5a7c0cf --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,47 @@ +--- +galaxy_info: + author: Robert de Bock + role_name: logrotate + description: Install and configure logrotate on your system. + license: Apache-2.0 + company: none + min_ansible_version: 2.6 + + platforms: + - name: Alpine + versions: + - all + - name: ArchLinux + version: + - all + - name: Debian + versions: + - all + - name: EL + version: + - 6 + - 7 + - name: Fedora + versions: + - all + - name: OpenSUSE + versions: + - all + - name: Ubuntu + versions: + - artful + - bionic + + galaxy_tags: + - logrotate + - alpine + - archlinux + - centos + - debian + - el + - fedora + - opensuse + - rhel + - ubuntu + +dependencies: [] diff --git a/molecule/alpine-edge/molecule.yml b/molecule/alpine-edge/molecule.yml new file mode 100644 index 0000000..439e114 --- /dev/null +++ b/molecule/alpine-edge/molecule.yml @@ -0,0 +1,23 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-alpine-edge + image: alpine:edge + pre_build_image: yes + command: sh -c "while true ; do sleep 1 ; done" +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: alpine-edge diff --git a/molecule/alpine-latest/molecule.yml b/molecule/alpine-latest/molecule.yml new file mode 100644 index 0000000..109978a --- /dev/null +++ b/molecule/alpine-latest/molecule.yml @@ -0,0 +1,23 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-alpine-latest + image: alpine:latest + pre_build_image: yes + command: sh -c "while true ; do sleep 1 ; done" +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: alpine-latest diff --git a/molecule/archlinux/molecule.yml b/molecule/archlinux/molecule.yml new file mode 100644 index 0000000..3e634a3 --- /dev/null +++ b/molecule/archlinux/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-archlinux + image: archlinux/base + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: archlinux diff --git a/molecule/centos-6/molecule.yml b/molecule/centos-6/molecule.yml new file mode 100644 index 0000000..3237720 --- /dev/null +++ b/molecule/centos-6/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-centos-6 + image: centos:6 + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: centos-6 diff --git a/molecule/centos-latest/molecule.yml b/molecule/centos-latest/molecule.yml new file mode 100644 index 0000000..8ee4c53 --- /dev/null +++ b/molecule/centos-latest/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-centos-latest + image: centos:latest + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: centos-latest diff --git a/molecule/debian-latest/molecule.yml b/molecule/debian-latest/molecule.yml new file mode 100644 index 0000000..0ca9a91 --- /dev/null +++ b/molecule/debian-latest/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-debian-latest + image: debian:latest + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: debian-latest diff --git a/molecule/debian-stable/molecule.yml b/molecule/debian-stable/molecule.yml new file mode 100644 index 0000000..7658e3c --- /dev/null +++ b/molecule/debian-stable/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-debian-stable + image: debian:stable + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: debian-stable diff --git a/molecule/debian-unstable/molecule.yml b/molecule/debian-unstable/molecule.yml new file mode 100644 index 0000000..421eb2d --- /dev/null +++ b/molecule/debian-unstable/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-debian-unstable + image: debian:unstable + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: debian-unstable diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml new file mode 100644 index 0000000..e2c751f --- /dev/null +++ b/molecule/default/molecule.yml @@ -0,0 +1,63 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-alpine-edge + image: alpine:edge + pre_build_image: yes + command: sh -c "while true ; do sleep 1 ; done" + - name: logrotate-alpine-latest + image: alpine:latest + pre_build_image: yes + command: sh -c "while true ; do sleep 1 ; done" + - name: logrotate-archlinux + image: archlinux/base + pre_build_image: yes + - name: logrotate-centos-6 + image: centos:6 + pre_build_image: yes + - name: logrotate-centos-latest + image: centos:latest + pre_build_image: yes + - name: logrotate-debian-latest + image: debian:latest + pre_build_image: yes + - name: logrotate-debian-stable + image: debian:stable + pre_build_image: yes + - name: logrotate-debian-unstable + image: debian:unstable + pre_build_image: yes + - name: logrotate-fedora-latest + image: fedora:latest + pre_build_image: yes + - name: logrotate-fedora-rawhide + image: fedora:rawhide + pre_build_image: yes + - name: logrotate-opensuse-leap + image: opensuse:leap + pre_build_image: yes + - name: logrotate-ubuntu-latest + image: ubuntu:latest + pre_build_image: yes + - name: logrotate-ubuntu-rolling + image: ubuntu:rolling + pre_build_image: yes + - name: logrotate-ubuntu-devel + image: ubuntu:devel + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: default diff --git a/molecule/ec2/README.md b/molecule/ec2/README.md new file mode 100644 index 0000000..856b351 --- /dev/null +++ b/molecule/ec2/README.md @@ -0,0 +1,15 @@ +# Amazon EC2 + +To test on Amazon elastic compute cloud (EC2), set this variable: + +``` +export EC2_REGION=eu-central-1 +``` + +And save the credentials: +``` +cat ~/.aws/credentials +[default] +aws_access_key_id=YOUR_KEY_ID +aws_secret_access_key=YOUR_ACCESS_KEY +``` diff --git a/molecule/ec2/create.yml b/molecule/ec2/create.yml new file mode 100644 index 0000000..7992818 --- /dev/null +++ b/molecule/ec2/create.yml @@ -0,0 +1,125 @@ +--- +- name: Create + hosts: localhost + connection: local + gather_facts: false + no_log: "{{ not (lookup('env', 'MOLECULE_DEBUG') | bool or molecule_yml.provisioner.log|default(false) | bool) }}" + vars: + ssh_user: ec2-user + ssh_port: 22 + + security_group_name: molecule + security_group_description: Security group for testing Molecule + security_group_rules: + - proto: tcp + from_port: "{{ ssh_port }}" + to_port: "{{ ssh_port }}" + cidr_ip: '0.0.0.0/0' + - proto: icmp + from_port: 8 + to_port: -1 + cidr_ip: '0.0.0.0/0' + security_group_rules_egress: + - proto: -1 + from_port: 0 + to_port: 0 + cidr_ip: '0.0.0.0/0' + + keypair_name: molecule_key + keypair_path: "{{ lookup('env', 'MOLECULE_EPHEMERAL_DIRECTORY') }}/ssh_key" + tasks: + - name: Create security group + ec2_group: + name: "{{ security_group_name }}" + description: "{{ security_group_name }}" + rules: "{{ security_group_rules }}" + rules_egress: "{{ security_group_rules_egress }}" + + - name: Test for presence of local keypair + stat: + path: "{{ keypair_path }}" + register: keypair_local + + - name: Delete remote keypair + ec2_key: + name: "{{ keypair_name }}" + state: absent + when: not keypair_local.stat.exists + + - name: Create keypair + ec2_key: + name: "{{ keypair_name }}" + register: keypair + + - name: Persist the keypair + copy: + dest: "{{ keypair_path }}" + content: "{{ keypair.key.private_key }}" + mode: 0600 + when: keypair.changed + + - name: Create molecule instance(s) + ec2: + key_name: "{{ keypair_name }}" + image: "{{ item.image }}" + instance_type: "{{ item.instance_type }}" + vpc_subnet_id: "{{ item.vpc_subnet_id }}" + group: "{{ security_group_name }}" + instance_tags: + instance: "{{ item.name }}" + wait: true + assign_public_ip: true + exact_count: 1 + count_tag: + instance: "{{ item.name }}" + register: server + with_items: "{{ molecule_yml.platforms }}" + async: 7200 + poll: 0 + + - name: Wait for instance(s) creation to complete + async_status: + jid: "{{ item.ansible_job_id }}" + register: ec2_jobs + until: ec2_jobs.finished + retries: 300 + with_items: "{{ server.results }}" + + # Mandatory configuration for Molecule to function. + + - name: Populate instance config dict + set_fact: + instance_conf_dict: { + 'instance': "{{ item.instances[0].tags.instance }}", + 'address': "{{ item.instances[0].public_ip }}", + 'user': "{{ ssh_user }}", + 'port': "{{ ssh_port }}", + 'identity_file': "{{ keypair_path }}", + 'instance_ids': "{{ item.instance_ids }}", } + with_items: "{{ ec2_jobs.results }}" + register: instance_config_dict + when: server.changed | bool + + - name: Convert instance config dict to a list + set_fact: + instance_conf: "{{ instance_config_dict.results | map(attribute='ansible_facts.instance_conf_dict') | list }}" + when: server.changed | bool + + - name: Dump instance config + copy: + content: "{{ instance_conf | to_json | from_json | molecule_to_yaml | molecule_header }}" + dest: "{{ molecule_instance_config }}" + when: server.changed | bool + + - name: Wait for SSH + wait_for: + port: "{{ ssh_port }}" + host: "{{ item.address }}" + search_regex: SSH + delay: 10 + timeout: 320 + with_items: "{{ lookup('file', molecule_instance_config) | molecule_from_yaml }}" + + - name: Wait for boot process to finish + pause: + minutes: 2 diff --git a/molecule/ec2/destroy.yml b/molecule/ec2/destroy.yml new file mode 100644 index 0000000..b460c1e --- /dev/null +++ b/molecule/ec2/destroy.yml @@ -0,0 +1,47 @@ +--- +- name: Destroy + hosts: localhost + connection: local + gather_facts: false + no_log: "{{ not (lookup('env', 'MOLECULE_DEBUG') | bool or molecule_yml.provisioner.log|default(false) | bool) }}" + tasks: + - block: + - name: Populate instance config + set_fact: + instance_conf: "{{ lookup('file', molecule_instance_config) | molecule_from_yaml }}" + skip_instances: false + rescue: + - name: Populate instance config when file missing + set_fact: + instance_conf: {} + skip_instances: true + + - name: Destroy molecule instance(s) + ec2: + state: absent + instance_ids: "{{ item.instance_ids }}" + register: server + with_items: "{{ instance_conf }}" + when: not skip_instances + async: 7200 + poll: 0 + + - name: Wait for instance(s) deletion to complete + async_status: + jid: "{{ item.ansible_job_id }}" + register: ec2_jobs + until: ec2_jobs.finished + retries: 300 + with_items: "{{ server.results }}" + + # Mandatory configuration for Molecule to function. + + - name: Populate instance config + set_fact: + instance_conf: {} + + - name: Dump instance config + copy: + content: "{{ instance_conf | to_json | from_json | molecule_to_yaml | molecule_header }}" + dest: "{{ molecule_instance_config }}" + when: server.changed | bool diff --git a/molecule/ec2/molecule.yml b/molecule/ec2/molecule.yml new file mode 100644 index 0000000..8b92982 --- /dev/null +++ b/molecule/ec2/molecule.yml @@ -0,0 +1,77 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: ec2 +platforms: + - name: logrotate-rhel-7 + image: ami-c86c3f23 + instance_type: t2.micro + vpc_subnet_id: subnet-0e688067 + - name: logrotate-sles-15 + image: ami-0a1886cf45f944eb1 + instance_type: t2.micro + vpc_subnet_id: subnet-0e688067 + - name: logrotate-ubuntu-18.04 + image: ami-0bdf93799014acdc4 + instance_type: t2.micro + vpc_subnet_id: subnet-0e688067 + - name: logrotate-amazon-linux-2 + image: ami-02ea8f348fa28c108 + instance_type: t2.micro + vpc_subnet_id: subnet-0e688067 + - name: logrotate-centos-7 + image: ami-9a183671 + instance_type: t2.micro + vpc_subnet_id: subnet-0e688067 + - name: logrotate-fedora-29 + image: ami-0f904cfaa69a1c64c + instance_type: t2.micro + vpc_subnet_id: subnet-0e688067 +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint + inventory: + host_vars: + logrotate-ubuntu-18.04: + ansible_user: ubuntu + logrotate-centos-7: + ansible_user: centos + logrotate-fedora-29: + ansible_user: fedora +scenario: + name: ec2 + create_sequence: + - create + check_sequence: + - destroy + - dependency + - create + - converge + - check + - destroy + converge_sequence: + - dependency + - create + - converge + destroy_sequence: + - destroy + test_sequence: + - lint + - destroy + - dependency + - syntax + - create + - converge + - idempotence + - side_effect + - verify + - destroy diff --git a/molecule/fedora-latest/molecule.yml b/molecule/fedora-latest/molecule.yml new file mode 100644 index 0000000..e6ad3af --- /dev/null +++ b/molecule/fedora-latest/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-fedora-latest + image: fedora:latest + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: fedora-latest diff --git a/molecule/fedora-rawhide/molecule.yml b/molecule/fedora-rawhide/molecule.yml new file mode 100644 index 0000000..83c4d25 --- /dev/null +++ b/molecule/fedora-rawhide/molecule.yml @@ -0,0 +1,24 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-fedora-rawhide + image: fedora:rawhide + pre_build_image: yes + registry: + url: registry.fedoraproject.org +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: fedora-rawhide diff --git a/molecule/opensuse-leap/molecule.yml b/molecule/opensuse-leap/molecule.yml new file mode 100644 index 0000000..dc2f250 --- /dev/null +++ b/molecule/opensuse-leap/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-opensuse-leap + image: opensuse:leap + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: opensuse-leap diff --git a/molecule/resources/playbook.yml b/molecule/resources/playbook.yml new file mode 100644 index 0000000..3a0f50b --- /dev/null +++ b/molecule/resources/playbook.yml @@ -0,0 +1,8 @@ +--- +- name: Converge + hosts: all + become: yes + gather_facts: yes + + roles: + - ansible-role-logrotate diff --git a/molecule/resources/prepare.yml b/molecule/resources/prepare.yml new file mode 100644 index 0000000..70e034f --- /dev/null +++ b/molecule/resources/prepare.yml @@ -0,0 +1,8 @@ +--- +- name: Converge + hosts: all + become: yes + gather_facts: no + + roles: + - robertdebock.bootstrap diff --git a/molecule/ubuntu-devel/molecule.yml b/molecule/ubuntu-devel/molecule.yml new file mode 100644 index 0000000..5d7633e --- /dev/null +++ b/molecule/ubuntu-devel/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-ubuntu-devel + image: ubuntu:devel + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: ubuntu-devel diff --git a/molecule/ubuntu-latest/molecule.yml b/molecule/ubuntu-latest/molecule.yml new file mode 100644 index 0000000..3cf0a1b --- /dev/null +++ b/molecule/ubuntu-latest/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-ubuntu-latest + image: ubuntu:latest + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: ubuntu-latest diff --git a/molecule/ubuntu-rolling/molecule.yml b/molecule/ubuntu-rolling/molecule.yml new file mode 100644 index 0000000..a3006d9 --- /dev/null +++ b/molecule/ubuntu-rolling/molecule.yml @@ -0,0 +1,22 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: docker +platforms: + - name: logrotate-ubuntu-rolling + image: ubuntu:rolling + pre_build_image: yes +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: ubuntu-rolling diff --git a/molecule/vagrant/molecule.yml b/molecule/vagrant/molecule.yml new file mode 100644 index 0000000..5f52bc7 --- /dev/null +++ b/molecule/vagrant/molecule.yml @@ -0,0 +1,25 @@ +--- +dependency: + name: galaxy + options: + role-file: requirements.yml +lint: + name: yamllint +driver: + name: vagrant + provider: + name: virtualbox +platforms: + - name: logrotate-debian + box: debian/stretch64 + - name: logrotate-fedora + box: fedora/29-cloud-base +provisioner: + name: ansible + playbooks: + prepare: ../resources/prepare.yml + converge: ../resources/playbook.yml + lint: + name: ansible-lint +scenario: + name: vagrant diff --git a/requirements.yml b/requirements.yml new file mode 100644 index 0000000..46dec9d --- /dev/null +++ b/requirements.yml @@ -0,0 +1,2 @@ +--- +- robertdebock.bootstrap diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..5512428 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,35 @@ +--- +# tasks file for logrotate +- name: install logrotate + package: + name: "{{ logrotate_packages }}" + state: present + register: logrotate_install_logrotate + until: logrotate_install_logrotate is succeeded + retries: 3 + +- name: configure logrotate + template: + src: "{{ logrotate_config_file }}.j2" + dest: "{{ logrotate_config_directory }}/{{ logrotate_config_file }}" + notify: + - restart logrotate + +- name: generate logrotate.d files + template: + src: entry.j2 + dest: "{{ logrotate_confd_directory }}/{{ item.name }}" + with_items: + - "{{ logrotate_entries }}" + when: + - logrotate_entries is defined + loop_control: + label: "{{ item.name }}" + +- name: start and enable logrotate + service: + name: "{{ logrotate_service }}" + state: started + enabled: yes + when: + - ansible_virtualization_type != "docker" diff --git a/templates/.gitkeep b/templates/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/templates/entry.j2 b/templates/entry.j2 new file mode 100644 index 0000000..978f158 --- /dev/null +++ b/templates/entry.j2 @@ -0,0 +1,7 @@ +{{ ansible_managed | comment }} + +{{ item.path }} { + {{ item.frequency | default(omit) }} +{% if item.compress %} compress{% endif %} + {{ item.keep | default(omit) }} +} diff --git a/templates/logrotate.conf.j2 b/templates/logrotate.conf.j2 new file mode 100644 index 0000000..4d230f4 --- /dev/null +++ b/templates/logrotate.conf.j2 @@ -0,0 +1,42 @@ +{{ ansible_managed | comment }} + +# see "man logrotate" for details +# rotate log files weekly +{{ logrotate_frequency }} + +# use the syslog group by default, since this is the owning group +# of /var/log/syslog. +su root syslog + +# keep 4 weeks worth of backlogs +rotate {{ logrotate_keep }} + +# create new (empty) log files after rotating old ones +create + +# uncomment this if you want your log files compressed +{% if logrotate_compress %} +compress +{% else %} +#compress +{% endif %} + +# packages drop log rotation information into this directory +include /etc/logrotate.d + +# no packages own wtmp, or btmp -- we'll rotate them here +/var/log/wtmp { + missingok + monthly + create 0664 root utmp + rotate 1 +} + +/var/log/btmp { + missingok + monthly + create 0660 root utmp + rotate 1 +} + +# system-specific logs may be configured here diff --git a/vars/main.yml b/vars/main.yml new file mode 100644 index 0000000..5c655e6 --- /dev/null +++ b/vars/main.yml @@ -0,0 +1,16 @@ +--- +# vars file for logrotate +_logrotate_packages: + default: + - logrotate + +logrotate_packages: "{{ _logrotate_packages[ansible_distribution ~ '-' ~ ansible_distribution_major_version] | default(_logrotate_packages[ansible_distribution] | default(_logrotate_packages['default'])) }}" + +_logrotate_config_directory: + default: /etc + +logrotate_config_directory: "{{ _logrotate_config_directory[ansible_distribution] | default(_logrotate_config_directory['default']) }}" + +logrotate_config_file: logrotate.conf + +logrotate_confd_directory: "{{ logrotate_config_directory }}/logrotate.d"