https://github.com/robertdebock/ansible-role-maintenance
Maintain your system by cleaning up.
https://github.com/robertdebock/ansible-role-maintenance
ansible maintenance molecule playbook security system tox
Last synced: about 2 months ago
JSON representation
Maintain your system by cleaning up.
- Host: GitHub
- URL: https://github.com/robertdebock/ansible-role-maintenance
- Owner: robertdebock
- License: apache-2.0
- Created: 2020-02-04T15:47:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T16:11:58.000Z (3 months ago)
- Last Synced: 2025-04-20T10:16:40.844Z (about 2 months ago)
- Topics: ansible, maintenance, molecule, playbook, security, system, tox
- Homepage: https://robertdebock.nl/
- Size: 140 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# [Ansible role maintenance](#maintenance)
Maintain your system by cleaning up.
|GitHub|GitLab|Downloads|Version|
|------|------|---------|-------|
|[](https://github.com/robertdebock/ansible-role-maintenance/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-maintenance)|[](https://galaxy.ansible.com/robertdebock/maintenance)|[](https://github.com/robertdebock/ansible-role-maintenance/releases/)|
## [Example Playbook](#example-playbook)
This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-maintenance/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.
```yaml
---
- name: Converge
hosts: all
become: true
gather_facts: true
roles:
- role: robertdebock.maintenance
maintenance_files_to_empty:
- /tmp/some_file.txt
```
The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-maintenance/blob/master/molecule/default/prepare.yml):
```yaml
---
- name: Prepare
hosts: all
become: true
gather_facts: false
roles:
- role: robertdebock.bootstrap
tasks:
- name: Create a file
ansible.builtin.copy:
dest: /tmp/some_file.txt
content: "Some content"
mode: "0644"
```
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
## [Role Variables](#role-variables)
The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-maintenance/blob/master/defaults/main.yml):
```yaml
---
# defaults file for maintenance
maintenance_journalctl_vacuum: 10d
# A list of files that needs to be emptied.
# maintenance_files_to_empty:
# - /tmp/some_file.txt
```
## [Requirements](#requirements)
- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-maintenance/blob/master/requirements.txt).
## [State of used roles](#state-of-used-roles)
The following roles are used to prepare a system. You can prepare your system in another way.
| Requirement | GitHub | GitLab |
|-------------|--------|--------|
|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|
## [Context](#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:
## [Compatibility](#compatibility)
This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):
|container|tags|
|---------|----|
|[Alpine](https://hub.docker.com/r/robertdebock/alpine)|all|
|[Amazon](https://hub.docker.com/r/robertdebock/amazonlinux)|Candidate|
|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|9|
|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|
|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|
|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|all|
The minimum version of Ansible required is 2.12, tests have been done to:
- The previous version.
- The current version.
- The development version.
If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-maintenance/issues).
## [License](#license)
[Apache-2.0](https://github.com/robertdebock/ansible-role-maintenance/blob/master/LICENSE).
## [Author Information](#author-information)
[robertdebock](https://robertdebock.nl/)
Please consider [sponsoring me](https://github.com/sponsors/robertdebock).