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

Commit

Permalink
Fixing ontarget reference in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
madflojo committed Feb 8, 2017
1 parent 9f19573 commit 65f2638
Show file tree
Hide file tree
Showing 13 changed files with 40 additions and 40 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,21 @@ nodes:
checks:
mem_free:
# Check for the % of disk free create warning with 20% free and critical for 10% free
execute_from: ontarget
execute_from: target
type: plugin
plugin: systems/disk_free.py
args: --warn=20 --critical=10 --filesystem=/var/log
actions:
logrotate_nicely:
execute_from: ontarget
execute_from: target
trigger: 0
frequency: 300
call_on:
- WARNING
type: cmd
cmd: bash /etc/cron.daily/logrotate
logrotate_forced:
execute_from: ontarget
execute_from: target
trigger: 5
frequency: 300
call_on:
Expand All @@ -68,7 +68,7 @@ nodes:
checks:
nginx_is_running:
# Check if nginx is running
execute_from: ontarget
execute_from: target
type: cmd
{% if "Linux" in facts['os'] %}
cmd: service nginx status
Expand All @@ -77,7 +77,7 @@ checks:
{% endif %}
actions:
restart_nginx:
execute_from: ontarget
execute_from: target
trigger: 2
frequency: 300
call_on:
Expand Down
6 changes: 3 additions & 3 deletions docs/automatron-in-10-minutes.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ nodes:
checks:
nginx_is_running:
# Check if nginx is running
execute_from: ontarget
execute_from: target
type: cmd
cmd: service nginx status
actions:
restart_nginx:
execute_from: ontarget
execute_from: target
trigger: 2
frequency: 300
call_on:
Expand Down Expand Up @@ -126,4 +126,4 @@ Once our configuration and runbook is defined we can startup Automatron and watc

```sh
$ honcho start
```
```
4 changes: 2 additions & 2 deletions docs/facts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nodes:
checks:
nginx_is_running:
# Check if nginx is running
execute_from: ontarget
execute_from: target
type: cmd
{% if "Linux" in facts['os'] %}
cmd: service nginx status
Expand All @@ -19,7 +19,7 @@ checks:
{% endif %}
actions:
restart_nginx:
execute_from: ontarget
execute_from: target
trigger: 2
frequency: 300
call_on:
Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ nodes:
checks:
mem_free:
# Check for the % of disk free create warning with 20% free and critical for 10% free
execute_from: ontarget
execute_from: target
type: plugin
plugin: systems/disk_free.py
args: --warn=20 --critical=10 --filesystem=/var/log
actions:
logrotate_nicely:
execute_from: ontarget
execute_from: target
trigger: 0
frequency: 300
call_on:
- WARNING
type: cmd
cmd: bash /etc/cron.daily/logrotate
logrotate_forced:
execute_from: ontarget
execute_from: target
trigger: 5
frequency: 300
call_on:
Expand All @@ -65,7 +65,7 @@ nodes:
checks:
nginx_is_running:
# Check if nginx is running
execute_from: ontarget
execute_from: target
type: cmd
{% if "Linux" in facts['os'] %}
cmd: service nginx status
Expand All @@ -74,7 +74,7 @@ checks:
{% endif %}
actions:
restart_nginx:
execute_from: ontarget
execute_from: target
trigger: 2
frequency: 300
call_on:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/actions/docker/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Below is an example of using the `docker/clean.sh` action plugin.
```yaml
actions:
cleanup_docker:
execute_from: ontarget
execute_from: target
trigger: 0
frequency: 300
call_on:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/actions/systems/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The below is an example of using the **systems/services.py** plugin.
```yaml
actions:
restart_nginx:
execute_from: ontarget
execute_from: target
trigger: 0
frequency: 300
call_on:
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/checks/mysql/available.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ The below is an example of using the `mysql/available` health check in a runbook
```yaml
checks:
mysql_up:
execute_from: ontarget
execute_from: target
type: plugin
plugin: mysql/available.py
args: --host=localhost --user=USERNAME --password=YOURPASSWORD
```

This plugin can be executed from either `ontarget` or `remote` depending on the MySQL service's configuration.
This plugin can be executed from either `target` or `remote` depending on the MySQL service's configuration.

### Required arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/checks/mysql/status_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ The below is an example of using the `status_metrics` health check in a runbook.
```yaml
checks:
status_metrics:
execute_from: ontarget
execute_from: target
type: plugin
plugin: mysql/status_metrics.py
args: --warn=20 --critical=10 --metric=slow_queries --host=localhost --user=USERNAME --password=YOURPASSWORD --type=greater
```

This plugin can be executed from either `ontarget` or `remote` depending on the MySQL service's configuration.
This plugin can be executed from either `target` or `remote` depending on the MySQL service's configuration.

### Required arguments

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/checks/network/ping.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ checks:
args: -i 10.0.0.1
```

This plugin can be executed from either `ontarget` or `remote` depending on the goal of the runbook.
This plugin can be executed from either `target` or `remote` depending on the goal of the runbook.

### Required arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/checks/network/tcp_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ The below is an example of using the `network/tcp_connect` health check in a run
```yaml
checks:
mysql_up:
execute_from: ontarget
execute_from: target
type: plugin
plugin: network/tcp_connect.py
args: --host=localhost --port 3306
```

This plugin can be executed from either `ontarget` or `remote` depending on the target being monitored.
This plugin can be executed from either `target` or `remote` depending on the target being monitored.

### Required arguments

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/checks/systems/disk_free.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The below is an example of using the `disk_free` health check in a runbook.
checks:
disk_free:
# Check for the % of disk free create warning with 20% free and critical for 10% free
execute_from: ontarget
execute_from: target
type: plugin
plugin: systems/disk_free.py
args: --warn=20 --critical=10 --filesystem=/var/log
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/checks/systems/mem_free.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The below is an example of the `mem_free` check used within a runbook.
```yaml
checks:
mem_free:
execute_from: ontarget
execute_from: target
type: plugin
plugin: systems/mem_free.py
args: --warn=20 --critical=10
Expand Down
28 changes: 14 additions & 14 deletions docs/runbooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ nodes:
checks:
nginx_is_running:
# Check if nginx is running
execute_from: ontarget
execute_from: target
type: cmd
cmd: service nginx status
actions:
restart_nginx:
execute_from: ontarget
execute_from: target
trigger: 2
frequency: 300
call_on:
Expand Down Expand Up @@ -104,7 +104,7 @@ Below is an example of a `cmd` based health check.
checks:
nginx_is_running:
# Check if nginx is running
execute_from: ontarget
execute_from: target
type: cmd
cmd: service nginx status
```
Expand All @@ -119,7 +119,7 @@ The `type` field is used to specify what type of health check this check is. Acc

##### `execute_from`

The `execute_from` field is used to specify where to run the health check. Acceptable values for this field are `ontarget` which is used to execute the health check on the node itself and `remote`. The `remote` setting will tell Automatron to execute the health check from the system running Automatron's `monitoring.py` service.
The `execute_from` field is used to specify where to run the health check. Acceptable values for this field are `target` which is used to execute the health check on the node itself and `remote`. The `remote` setting will tell Automatron to execute the health check from the system running Automatron's `monitoring.py` service.

##### `cmd`

Expand All @@ -143,7 +143,7 @@ The below example shows a `plugin` based health check.
checks:
disk_free:
# Check for the % of disk free create warning with 20% free and critical for 10% free
execute_from: ontarget
execute_from: target
type: plugin
plugin: systems/disk_free.py
args: --warn=20 --critical=10 --filesystem=/var/log
Expand All @@ -159,7 +159,7 @@ The `type` field is used to specify what type of health check this check is. Acc

##### `execute_from`

The `execute_from` field is used to specify where to run the health check. Acceptable values for this field are `ontarget` which is used to execute the health check on the node itself and `remote`. The `remote` setting will tell Automatron to execute the health check from the system running the `monitoring.py` service of Automatron.
The `execute_from` field is used to specify where to run the health check. Acceptable values for this field are `target` which is used to execute the health check on the node itself and `remote`. The `remote` setting will tell Automatron to execute the health check from the system running the `monitoring.py` service of Automatron.

##### `plugin`

Expand Down Expand Up @@ -209,7 +209,7 @@ The `cmd` action type is designed to execute an arbitrary shell command. The bel
```yaml
actions:
restart_nginx:
execute_from: ontarget
execute_from: target
trigger: 2
frequency: 300
call_on:
Expand All @@ -221,7 +221,7 @@ actions:

##### `execute_from`

The `execute_from` field is used to specify where to run the action. Acceptable values for this field are `ontarget` which is used to execute the health check on the node itself and `remote`. The `remote` setting will tell Automatron to execute the action from the system running the `actioning.py` service of Automatron.
The `execute_from` field is used to specify where to run the action. Acceptable values for this field are `target` which is used to execute the health check on the node itself and `remote`. The `remote` setting will tell Automatron to execute the action from the system running the `actioning.py` service of Automatron.

##### `trigger`

Expand Down Expand Up @@ -266,7 +266,7 @@ actions:

##### `execute_from`

The `execute_from` field is used to specify where to run the action. Acceptable values for this field are `ontarget` which is used to execute the health check on the target node itself and `remote`. The `remote` setting will tell Automatron to execute the action from the system running Automatron's `actioning.py` service.
The `execute_from` field is used to specify where to run the action. Acceptable values for this field are `target` which is used to execute the health check on the target node itself and `remote`. The `remote` setting will tell Automatron to execute the action from the system running Automatron's `actioning.py` service.

##### `trigger`

Expand Down Expand Up @@ -318,7 +318,7 @@ checks:
cmd: /usr/bin/curl -Lw "Response %{http_code}\\n" http://{{ facts['network']['eth0']['v4'][0] }} -o /dev/null | egrep "Response [200|301]"
actions:
restart_http:
execute_from: ontarget
execute_from: target
trigger: 0
frequency: 300
call_on:
Expand All @@ -339,7 +339,7 @@ actions:
plugin: cloudflare/dns.py
args: remove someone@example.com 12345 example.com --content {{ facts['network']['eth0']['v4'][0] }}
reboot:
execute_from: ontarget
execute_from: target
trigger: 5
frequency: 900
call_on:
Expand All @@ -362,21 +362,21 @@ nodes:
checks:
disk_free:
# Check for the % of disk free create warning with 20% free and critical for 10% free
execute_from: ontarget
execute_from: target
type: plugin
plugin: systems/disk_free.py
args: --warn=20 --critical=10 --filesystem=/var/log
actions:
logrotate_nicely:
execute_from: ontarget
execute_from: target
trigger: 0
frequency: 300
call_on:
- WARNING
type: cmd
cmd: bash /etc/cron.daily/logrotate
logrotate_forced:
execute_from: ontarget
execute_from: target
trigger: 5
frequency: 300
call_on:
Expand Down

0 comments on commit 65f2638

Please sign in to comment.