Rebased from master

1 files changed, 74 insertions, 45 deletions

diff --git a/docs/Hooks.md b/docs/Hooks.md
index 7d503a3..ff430ca 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -1,46 +1,52 @@
 # Hooks
-You can define arbitrary number of hooks that subscribe different events. The hook system is modular and different kind of hook types can be enabled.
+
+You can define an arbitrary number of hooks that subscribe to different events. The hook system is modular and different kind of hook types can be enabled.
 
 ## Configuration
+
 Following configuration keys need to be defined for all hooks:
 
-  * `events`: which events to subscribe. Needs to be an array. See below for the list of available events.
-  * `type`: what hook class to use. See below for the list of available hook types.
+* `events`: which events to subscribe. Needs to be an array. See below for the list of available events.
+* `type`: what hook class to use. See below for the list of available hook types.
 
-### Events
-  * `node_success`: triggered when configuration is succesfully pulled from a node and right before storing the configuration.
-  * `node_fail`: triggered after `retries` amount of failed node pulls.
-  * `post_store`: triggered after node configuration is stored (this is executed only when the configuration has changed).
-  * `nodes_done`: triggered after finished fetching all nodes.
+## Events
+
+* `node_success`: triggered when configuration is successfully pulled from a node and right before storing the configuration.
+* `node_fail`: triggered after `retries` amount of failed node pulls.
+* `post_store`: triggered after node configuration is stored (this is executed only when the configuration has changed).
+* `nodes_done`: triggered after finished fetching all nodes.
 
 ## Hook type: exec
+
 The `exec` hook type allows users to run an arbitrary shell command or a binary when triggered.
 
 The command is executed on a separate child process either in synchronous or asynchronous fashion. Non-zero exit values cause errors to be logged. STDOUT and STDERR are currently not collected.
 
 Command is executed with the following environment:
-```
+
+```text
 OX_EVENT
 OX_NODE_NAME
 OX_NODE_IP
 OX_NODE_FROM
 OX_NODE_MSG
 OX_NODE_GROUP
+OX_NODE_MODEL
 OX_JOB_STATUS
 OX_JOB_TIME
 OX_REPO_COMMITREF
 OX_REPO_NAME
 ```
 
-Exec hook recognizes following configuration keys:
+Exec hook recognizes the following configuration keys:
 
-  * `timeout`: hard timeout for the command execution. SIGTERM will be sent to the child process after the timeout has elapsed. Default: 60
-  * `async`: influences whether main thread will wait for the command execution. Set this true for long running commands so node pull is not blocked. Default: false
-  * `cmd`: command to run.
+* `timeout`: hard timeout (in seconds) for the command execution. SIGTERM will be sent to the child process after the timeout has elapsed. Default: `60`
+* `async`: Execute the command in an asynchronous fashion. The main thread by default will wait for the hook command execution to complete. Set this to `true` for long running commands so node configuration pulls are not blocked. Default: `false`
+* `cmd`: command to run.
 
+### exec hook configuration example
 
-## Hook configuration example
-```
+```yaml
 hooks:
   name_for_example_hook1:
     type: exec
@@ -54,21 +60,31 @@ hooks:
     timeout: 120
 ```
 
-### githubrepo
+## Hook type: githubrepo
 
-This hook configures the repository `remote` and _push_ the code when the specified event is triggerd. If the `username` and `password` are not provided, the `Rugged::Credentials::SshKeyFromAgent` will be used.
+The `githubrepo` hook executes a `git push` to a configured `remote_repo` when the specified event is triggered.
 
-`githubrepo` hook recognizes following configuration keys:
+Several authentication methods are supported:
 
-  * `remote_repo`: the remote repository to be pushed to.
-  * `username`: username for repository auth.
-  * `password`: password for repository auth.
-  * `publickey`: publickey for repository auth.
-  * `privatekey`: privatekey for repository auth.
+* Provide a `password` for username + password authentication
+* Provide both a `publickey` and a `privatekey` for ssh key-based authentication
+* Don't provide any credentials for ssh-agent authentication
 
-When using groups repositories, each group must have its own `remote` in the `remote_repo` config.
+The username will be set to the relevant part of the `remote_repo` URI, with a fallback to `git`. It is also possible to provide one by setting the `username` configuration key.
 
-``` yaml
+For ssh key-based authentication, it is possible to set the environment variable `OXIDIZED_SSH_PASSPHRASE` to a passphrase if the private key requires it.
+
+`githubrepo` hook recognizes the following configuration keys:
+
+* `remote_repo`: the remote repository to be pushed to.
+* `username`: username for repository auth.
+* `password`: password for repository auth.
+* `publickey`: public key file path for repository auth.
+* `privatekey`: private key file path for repository auth.
+
+When using groups, each group must have a unique entry in the `remote_repo` config.
+
+```yaml
 hooks:
   push_to_remote:
     remote_repo:
@@ -77,10 +93,11 @@ hooks:
       firewalls: git@git.intranet:oxidized/firewalls.git
 ```
 
+### githubrepo hook configuration example
 
-## Hook configuration example
+Authenticate with a username and a password without groups in use:
 
-``` yaml
+```yaml
 hooks:
   push_to_remote:
     type: githubrepo
@@ -90,20 +107,37 @@ hooks:
     password: pass
 ```
 
+Authenticate with the username `git` and an ssh key:
+
+```yaml
+hooks:
+  push_to_remote:
+    type: githubrepo
+    events: [post_store]
+    remote_repo: git@git.intranet:oxidized/test.git
+    publickey: /root/.ssh/id_rsa.pub
+    privatekey: /root/.ssh/id_rsa
+```
+
 ## Hook type: awssns
 
 The `awssns` hook publishes messages to AWS SNS topics. This allows you to notify other systems of device configuration changes, for example a config orchestration pipeline. Multiple services can subscribe to the same AWS topic.
 
 Fields sent in the message:
 
-  * `event`: Event type (e.g. `node_success`)
-  * `group`: Group name
-  * `model`: Model name (e.g. `eos`)
-  * `node`: Device hostname
+* `event`: Event type (e.g. `node_success`)
+* `group`: Group name
+* `model`: Model name (e.g. `eos`)
+* `node`: Device hostname
 
-Configuration example:
 
-``` yaml
+The AWS SNS hook requires the following configuration keys:
+
+* `region`: AWS Region name
+* `topic_arn`: ASN Topic reference
+### awssns hook configuration example
+
+```yaml
 hooks:
   hook_script:
     type: awssns
@@ -112,11 +146,6 @@ hooks:
     topic_arn: arn:aws:sns:us-east-1:1234567:oxidized-test-backup_events
 ```
 
-AWS SNS hook requires the following configuration keys:
-
-  * `region`: AWS Region name
-  * `topic_arn`: ASN Topic reference
-
 Your AWS credentials should be stored in `~/.aws/credentials`.
 
 ## Hook type: slackdiff
@@ -125,13 +154,13 @@ The `slackdiff` hook posts colorized config diffs to a [Slack](http://www.slack.
 
 You will need to manually install the `slack-api` gem on your system:
 
-```
+```shell
 gem install slack-api
 ```
 
-Configuration example:
+### slackdiff hook configuration example
 
-``` yaml
+```yaml
 hooks:
   slack:
     type: slackdiff
@@ -142,7 +171,7 @@ hooks:
 
 Optionally you can disable snippets and post a formatted message, for instance linking to a commit in a git repo. Named parameters `%{node}`, `%{group}`, `%{model}` and `%{commitref}` are available.
 
-``` yaml
+```yaml
 hooks:
   slack:
     type: slackdiff
@@ -161,13 +190,13 @@ The `xmppdiff` hook posts config diffs to a [XMPP](https://en.wikipedia.org/wiki
 
 You will need to manually install the `xmpp4r` gem on your system:
 
-```
+```shell
 gem install xmpp4r
 ```
 
-Configuration example:
+### xmppdiff hook configuration example
 
-``` yaml
+```yaml
 hooks:
   xmpp:
     type: xmppdiff