README.md in prometheus-splash-0.3.0 vs README.md in prometheus-splash-0.4.0
- old
+ new
@@ -2,14 +2,27 @@
 _Orchestration and Supervision made easy_
SPLASH is **Supervision with Prometheus of Logs and Asynchronous tasks orchestration for Services or Hosts**
+* Author : Romain GEORGES
+* COPYright : BSD-2-Clause (c) 2020 Ultragreen Software
+* Web : http://www.ultragreen.net
+* Github : https://github.com/Ultragreen/prometheus-splash
+* Rubygems : https://rubygems.org/gems/prometheus-splash
+* DOC yardoc : https://www.rubydoc.info/gems/prometheus-splash/0.3.0
Prometheus Logs and Batchs supervision over PushGateway
+[](https://badge.fury.io/gh/Ultragreen%2Fprometheus-splash)
+
+[](https://badge.fury.io/rb/prometheus-splash)
+## Design
+
+
+
## Preconfiguration
You need a Prometheus PushGateway operational, if the service not run on localhost:9091,
See Prometheus server Configuration chapter to precise it in the configuration
@@ -287,10 +300,17 @@
#### Prepare test with default configuration
Commands or Commands Sequences must be defined in the main configuration file '/etc/splash.yml'
+Command name must be Ruby Symbols, so in the YAML file, it must look like :
+
+ :xxxxxx:
+
+_with x in the following list [A-Za-z_0-9]_
+
+
*Exemple* in default configuration :
### configuration of commands and scheduling
:commands:
:id_root:
@@ -348,15 +368,26 @@
may include :
* :user: the userneme to use to run the command
* :on_failure: the name of an other defined command, to, execute if exit_code > 0
* :on_success: the name of an other defined command, to, execute if exit_code = 0
-* :schedule: (hash) a scheduling for daemon, after in this documentation, it support :
+* :schedule: (Hash) a scheduling for daemon, after in this documentation, it support :
* :every: "<timing>" ex: "1s", "3m", "2h"
* :at: "<date/time>" ex: "2030/12/12 23:30:00"
* :cron: * * * * * a cron format
+* delegate_to: (Hash) a Slash delagation
+ * :host: the hostname of an other Confiugured Splash Node.
+ * :remote_command: a command defined in the remote Splash node Configuration
+_Remarque_ : Command name, as precise earlier in this documentation is Ruby Symbols ':xxxxx'.
+In YAML as a Hash key : ':xxxxxx: ', but as a value _':xxxxx'_, so the synthaxe for callbacks :
+
+ :on_success: :xxxxxx
+ :on_failure: :xxxxxx
+
+It's the same for :remote_command
+
[Rufus Scheduler Doc](https://github.com/jmettraux/rufus-scheduler)
if you want to inject default configuration, again as root :
# splash conf set
@@ -702,5 +733,10 @@
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+
+## Context
+
+*Massively made during COVID-19 containment : #StayAtHomeSoftware*