Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joknarf/deferlib
puppet functions for deferred execution on agent side
https://github.com/joknarf/deferlib
agent deferred facts library puppet puppet-module
Last synced: 26 days ago
JSON representation
puppet functions for deferred execution on agent side
- Host: GitHub
- URL: https://github.com/joknarf/deferlib
- Owner: joknarf
- Created: 2024-02-10T12:17:04.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-02-13T22:50:02.000Z (9 months ago)
- Last Synced: 2024-10-01T05:23:20.210Z (about 1 month ago)
- Topics: agent, deferred, facts, library, puppet, puppet-module
- Language: Ruby
- Homepage:
- Size: 114 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://forge.puppetlabs.com/joknarf/deferlib)
[](https://forge.puppetlabs.com/joknarf/deferlib)
# deferlib
## Table of Contents
1. [Description](#description)
1. [Setup - The basics of getting started with deferlib](#setup)
* [Setup requirements](#setup-requirements)
* [Beginning with deferlib](#beginning-with-deferlib)
1. [Usage](#usage)
* [deferlib::if_file()](#deferlibif_file)
* [deferlib::unless_file()](#deferlibunless_file)
* [deferlib::if_cmd()](#deferlibif_cmd)
* [deferlib::unless_cmd()](#deferlibunless_cmd)
* [deferlib::cmd()](#deferlibcmd)
1. [Reference](REFERENCE.md)
## Description
Control your resources parameters from client side without creating useless facts.
Provides functions library to use to get values for resource parameters
from files/command executed on agent side (deferred), providing way to control resources
from agent host local things without creating facts that executes on all servers.
## Setup
### Setup Requirements
Puppet agent/server >= 7
### Beginning with deferlib
deferlib provides functions to use to modify resource parameters from host runnning
puppet agent (instead of using facts for example).
Example:
```puppet
# do not restart cron when maintenance flag file exists putting ensure to undef
# => function to read: unless file /etc/maintenance exists ensure running, (else ensure undef)
service { 'cron':
ensure => deferlib::unless_file('/etc/maintenance', 'running'),
}
# noop mode when maintenance preventing starting service during operation
service { 'cron':
ensure => 'running',
noop => deferlib::if_file('/etc/maintenance', true, false),
}
```
## Usage
functions available:
### deferlib::if_file()
```ruby
deferlib::if_file(file, value, [default])
```
#### Description:
returns `value` if `file` exists else returns `default` (default: [])
#### Parameters:
```
file : path to file to check existence
value : value returned if file exists
default : value returned if file does not exist (default [])
```
#### Example:
```puppet
# stop cron when cron_stop flag file exists
# => function to read: if file /etc/cron_stop exists ensure stopped else ensure running
service { 'cron':
ensure => deferlib::if_file('/etc/cron_stop', 'stopped', 'running'),
}
```
### deferlib::unless_file()
```ruby
deferlib::unless_file(file, value, [default])
```
#### Description:
returns `value` if `file` does not exist else returns `default` (default: [])
#### Parameters:
```
file : path to file to check existence
value : value returned if file does not exist
default : value returned if file exists (default [])
```
#### Example:
```puppet
# do not restart cron when maintenance flag file exists putting ensure to undef ([])
# => function to read: unless file /etc/maintenance exists ensure running, (else ensure undef)
service { 'cron':
ensure => deferlib::unless_file('/etc/maintenance', 'running'),
}
```
### deferlib::if_cmd()
```ruby
deferlib::if_cmd(cmd, value, [options])
```
#### Description:
returns `value` if exit code of `cmd` is 0 else returns `options[else]` (default to [])
#### Parameters:
```
cmd : shell code to execute
value : value returned if exit status is 0
options : {
'else' => # value returned if exit status is not 0 (default: [])
'user' => # The user to run the command as
'group' => # The group to run the command as
'environment' => # A Hash of environment variables
}
options['environment'] : {
'' => # value of the environement variable
...
}
```
#### Example:
```puppet
# ensure cron running if isproduction returns 0
service { 'cron':
ensure => deferlib::if_cmd('/bin/isproduction', 'running', {
'user' => 'foo',
'group' => 'bar',
}),
}
```
### deferlib::unless_cmd()
```ruby
deferlib::unless_cmd(cmd, value, [options])
```
#### Description:
returns `value` if exit code of `cmd` is not 0 else returns `options[else]` (default to [])
#### Parameters:
```
cmd : shell code to execute
value : value returned if exit status is not 0
options : Hash with optional settings
options : {
'else' => # value returned if exit status is 0 (default: [])
'user' => # The user to run the command as
'group' => # The group to run the command as
'environment' => # A Hash of environment variables
}
options['environment'] : {
'' => # value of the environement variable
...
}
```
#### Example:
```puppet
# ensure cron running unless ismaintenance returns 0
service { 'cron':
ensure => deferlib::unless_cmd('/bin/ismaintenance', 'running', {
'user' => 'foo',
'group' => 'bar',
}),
}
```
### deferlib::cmd()
```ruby
deferlib::cmd(options)
```
#### Description:
returns output of `options[command]` if exit code is 0 else returns `options['else']` (default to [])
#### parameters:
```
options : Hash with parameters
options : {
'command' => # Shell code to execute
'match' => # regexp to validate output (returns options['else'] if not)
'else' => # value returned if exit code is not 0
'user' => # The user to run the command as
'group' => # The group to run the command as
'environment' => # A Hash of environment variables/values
}
options['environment'] : {
'' => # value of the environement variable
...
}
```
#### Example:
```puppet
# force ensure from local file content if exists, else ensure running
service { 'cron':
ensure => deferlib::cmd({
'command' => 'cat /etc/cron_ensure',
'else' => 'running',
}),
}
# use script cron_ensure from puppet module files
service { 'cron':
ensure => deferlib::cmd({
'command' => file("${module_name}/cron_ensure"),
}),
}
```
## Reference
[Reference](REFERENCE.md)