initscript

Table of Contents

1. Overview
2. Module Description
3. Setup
   • What initscript affects
   • Setup requirements
   • Beginning with initscript
4. Usage
5. Reference
6. Limitations
7. Development

Overview

Creates a generic sysV initscript given a command to run.

Module Description

Manages a sysV compatible init script to be able to start arbitrary services

Setup

What initscript affects

Creates a $name script file on /etc/init.d to start and stop a service

Setup Requirements

None

Beginning with initscript

basic example from eyp-kibana:

initscript::service { 'kibana':
  cmd => "${basedir}/${productname}/bin/kibana",
  require   => [ Class['initscript'], File["${basedir}/${productname}/config/kibana.yml"] ],
  before => Service['kibana'],
}

Usage

• Start a given service using a start command that runs in the foregroundA

initscript::service { 'demo1':
  cmd   => 'sleep 1337m',
}

• Start a given service using a start command that runs in the foreground using a specific user

initscript::service { 'demo2':
  cmd      => 'sleep 666m',
  run_user => 'evil',
}

estil

• Start a given service using a command to start it and another command to stop it. Start command have to start the service in the background

initscript::service { 'demo3':
  cmd_start => 'nohup sleep 31173m &',
  cmd_stop  => 'pkill sleep',
}

Reference

defines

initscript::service

• initscript: script name (default: resource's name)
• description: script description (default: "default script for ${name}")
• cmd: command to start a foreground service (default: undef)
• cmd_start: command to start a servie in background mode (default: undef)
• cmd_stop: command to stop a service in background mode (default: undef)
• run_user: start daemon using a specific user (default: root)
• option_scripts: load script before running start/stop commands (default: [])
• tcp_listen_check: use a specific TCP port to check if the daemon is running (default: undef)
• pid_file: set PID file for the service - only used in cmd mode (default: /var/run/generic.init.${name}.pid)
• debug: set a debug log file (default: undef)

Limitations

Should work anywhere

Development

We are pushing to have acceptance testing in place, so any new feature should have some test to check both presence and absence of any feature

CHANGELOG

0.1.11

• Add the ability to easily add a service resource for the new init script - thanks to coreone for this PR-12

0.1.10

• Allow for the init file to be removed by adding and ensure option - thanks to coreone for this PR-10

0.1.9

• load user's variables
• metadata lint

0.1.8

• bugfix initscript::service
• added debug options to initscript::service

0.1.7

• improved init script

0.1.6

• added run_user to initscript::service

0.1.5

• bugfix check tcp port

0.1.4

• initscript::service: added optional tcp check for script's status
• initscript::service: customizable pid_file

0.1.3

• initscript::service: added optional config files
• initscript::service: added description for init script