Skip to content
This repository has been archived by the owner on Aug 11, 2023. It is now read-only.

Latest commit

 

History

History
411 lines (244 loc) · 7.79 KB

README.rst

File metadata and controls

411 lines (244 loc) · 7.79 KB
Raw

servicez

pipeline

travis

readthedocs

Ansible role to manage system services.

avatar

Full documentation on Readthedocs.

Source code on:

Github.

Gitlab.

Part of:

doombot

Ingredients

ingredient

Contents

Description

Ansible role to manage system services.

This role performs the following actions:

  • Ensure the requirements are installed.
  • Ensure the current user can obtain administrative (root)

    permissions.

  • If the services_disable variable is defined, stop and disable

    the services listed on it.

  • If the configuration variable is defined, stop and disable the

    services_disable listed on it.

  • If the services variable is defined, enable and start the

    services listed on it.

  • If the configuration variable is defined, enable and start the

    services listed on it.

Usage

  • To install and execute:
  • Passing variables:
  • To include the role on a playbook:
  • To include the role as dependency on another role:
  • To use the role from tasks:

To run tests:

cd servicez
chmod +x testme.sh
./testme.sh

On some tests you may need to use sudo to succeed.

Variables

The following variables are supported:

services

List of services to enable and start.

This list can be modified by passing a services array when including the role on a playbook or via –extra-vars from a terminal.

This variable is empty by default.

# Including from terminal.
ansible localhost -m include_role -a name=constrict0r.servicez -K -e \
    "{services: [mosquitto, nginx]}"

# Including on a playbook.
- hosts: servers
  roles:
    - role: constrict0r.servicez
      services:
        - mosquitto
        - nginx

# To a playbook from terminal.
ansible-playbook -i inventory my-playbook.yml -K -e \
    "{services: [mosquitto, nginx]}"

services_disable

List of services to stop and disable.

This list can be modified by passing a services_disable array when including the role on a playbook or via –extra-vars from a terminal.

This variable is empty by default.

# Including from terminal.
ansible localhost -m include_role -a name=constrict0r.servicez -K -e \
    "{services_disable: [mosquitto, nginx]}"

# Including on a playbook.
- hosts: servers
  roles:
    - role: constrict0r.servicez
      services_disable:
        - mosquitto
        - nginx

# To a playbook from terminal.
ansible-playbook -i inventory my-playbook.yml -K -e \
    "{services_disable: [mosquitto, nginx]}"

configuration

Absolute file path or URL to a .yml file that contains all or some of the variables supported by this role.

It is recommended to use a .yml or .yaml extension for the configuration file.

This variable is empty by default.

# Using file path.
ansible localhost -m include_role -a name=constrict0r.servicez -K -e \
    "configuration=/home/username/my-config.yml"

# Using URL.
ansible localhost -m include_role -a name=constrict0r.servicez -K -e \
    "configuration=https://my-url/my-config.yml"

To see how to write a configuration file see the YAML file format section.

YAML

When passing configuration files to this role as parameters, it’s recommended to add a .yml or .yaml extension to the each file.

It is also recommended to add three dashes at the top of each file:

---

You can include in the file the variables required for your tasks:

---
services:
  - ['mosquitto', 'nginx']

If you want this role to load list of items from files and URLs you can set the expand variable to true:

---
services: /home/username/my-config.yml

expand: true

If the expand variable is false, any file path or URL found will be treated like plain text.

Attributes

On the item level you can use attributes to configure how this role handles the items data.

The attributes supported by this role are:

item_expand

Boolean value indicating if treat this item as a file path or URL or just treat it as plain text.

---
services:
  - item_expand: true
    item_path: /home/username/my-config.yml

item_path

Absolute file path or URL to a .yml file.

---
services:
  - item_path: /home/username/my-config.yml

This attribute also works with URLs.

Requirements

If you want to run the tests, you will also need:

Compatibility

License

MIT. See the LICENSE file for more details.

Links

UML

Deployment

The full project structure is shown below:

deploy

Main

The project data flow is shown below:

main

Author

author

The Travelling Vaudeville Villain.

Enjoy!!!

enjoy