https://github.com/robertdebock/ansible-role-service
Add custom services to your Linux system.
https://github.com/robertdebock/ansible-role-service
ansible molecule playbook service system tox
Last synced: 3 days ago
JSON representation
Add custom services to your Linux system.
- Host: GitHub
- URL: https://github.com/robertdebock/ansible-role-service
- Owner: robertdebock
- License: apache-2.0
- Created: 2019-02-20T18:38:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T16:19:41.000Z (8 months ago)
- Last Synced: 2025-04-20T10:16:42.092Z (6 months ago)
- Topics: ansible, molecule, playbook, service, system, tox
- Language: Shell
- Homepage: https://robertdebock.nl/
- Size: 233 KB
- Stars: 10
- Watchers: 2
- Forks: 14
- Open Issues: 2
-
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 service](#ansible-role-service)
Add custom services to your Linux system.
|GitHub|GitLab|Downloads|Version|
|------|------|---------|-------|
|[](https://github.com/robertdebock/ansible-role-service/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-service)|[](https://galaxy.ansible.com/robertdebock/service)|[](https://github.com/robertdebock/ansible-role-service/releases/)|
## [Example Playbook](#example-playbook)
This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-service/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
vars:
_service_test_command:
default: /usr/bin/sleep
Alpine: /bin/sleep
Debian: /bin/sleep
Ubuntu-16: /bin/sleep
Ubuntu-18: /bin/sleep
service_test_command: "{{ _service_test_command[ansible_distribution ~ '-' ~ ansible_distribution_major_version] | default(_service_test_command[ansible_os_family] | default(_service_test_command['default'])) }}" # noqa 204 Just long.
roles:
- role: robertdebock.service
service_list:
- name: simple-service
description: Simple Service
start_command: "{{ service_test_command }} 3600"
state: started
enabled: true
- name: stopped-service
description: Simple Service
start_command: "{{ service_test_command }} 3601"
state: stopped
enabled: false
- name: specific-stop-service
description: Specific Stop Service
start_command: "{{ service_test_command }} 1440"
stop_command: /usr/bin/killall -f "sleep 1440"
- name: specific-user-group-service
description: Specific User Group Service
start_command: "{{ service_test_command }} 28800"
user_name: root
group_name: root
- name: specific-workingdirectory-service
description: Specific WorkingDirectory Service
start_command: "{{ service_test_command }} 57600"
working_directory: /tmp
- name: specific-pattern-service
description: Specific Status Pattern Service
start_command: "{{ service_test_command }} 115200"
status_pattern: 115200
- name: variable-service
description: Service with environment variables
start_command: "{{ service_test_command }} ${time}"
environment_variables:
time: 230400
- name: pidfile-service
description: Service with pidfile
start_command: "{{ service_test_command }} 460800"
pidfile: /var/run/pidfile-service.pid
- name: environmentfile-service
description: Service with environmentfile
start_command: "{{ service_test_command }} 921600"
environmentfile: /environmentfile.txt
- name: reload-service
description: Service with reload command
start_command: "{{ service_test_command }} 1843200"
reload_command: "kill -HUP $MAINPID"
state: started
enabled: true
```
The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-service/blob/master/molecule/default/prepare.yml):
```yaml
---
- name: Prepare
hosts: all
become: true
gather_facts: false
serial: 30%
roles:
- role: robertdebock.bootstrap
post_tasks:
- name: Place /environmentfile.txt
ansible.builtin.copy:
content: "value=variable"
dest: /environmentfile.txt
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-service/blob/master/defaults/main.yml):
```yaml
---
# defaults file for service
# service_list can contain a list of services to add to the system.
# The mandatory items for each item are:
# - name: The (short) name of the service, i.e. "tomcat".
# - description: A bit longer name, i.e. "Tomcat application server".
# - start_command: The command to start the daemon,
# i.e. "/usr/local/bin/java -jar some.jar"
# The optional items are:
# - stop_command: By default the program that is started is found and stopped.
# in case a running program is renamed or expanded (including a path) during
# startup, you can specify a custom stop command here, i.e. "pkill foo"
# - status_pattern: What program (or pattern) to look for when finding the
# status of a program, i.e. "artifactory".
# - type: How the program starts; "simple" or "forking". Simple means the
# program runs on the foreground, i.e. "nc -l 1234". Forking means the
# program itself forks, i.e. "nc -l 12345 &"
# - working_directory: The directory to cd into before starting the service.
# - environment_variables: A list for variables to set. for example:
# environment_variables:
# variable1: value1
# variable2: value2
# - after: Start after the mentioned service.
# - restart_mode: The mode to use, for example "always".
# - restart_seconds: The time to allow restart to finish.
# - reload_command: Custom command to reload the service configuration.
# This is useful for services that support configuration reloading
# without a full restart, i.e. "kill -HUP $MAINPID"
service_list: []
```
## [Requirements](#requirements)
- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-service/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 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|
|---------|----|
|[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 on:
- The previous version.
- The current version.
- The development version.
If you find issues, please register them on [GitHub](https://github.com/robertdebock/ansible-role-service/issues).
## [License](#license)
[Apache-2.0](https://github.com/robertdebock/ansible-role-service/blob/master/LICENSE).
## [Author Information](#author-information)
[robertdebock](https://robertdebock.nl/)
Please consider [sponsoring me](https://github.com/sponsors/robertdebock).