-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Victor Castell
committed
Jan 21, 2019
1 parent
17a973e
commit 7535024
Showing
14 changed files
with
177 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: Executors | ||
--- |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Processors | ||
--- | ||
|
||
{{% children style="h3" description="true" %}} |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: HTTP Executor | ||
--- | ||
|
||
HTTP executor can send a request to an HTTP endpoint | ||
|
||
## Configuration | ||
|
||
Params: | ||
|
||
``` | ||
method: Request method in uppercase | ||
url: Request url | ||
headers: Json string, such as "[\"Content-Type: application/json\"]" | ||
body: POST body | ||
timeout: Request timeout, unit seconds | ||
expectCode: Expect response code, such as 200,206 | ||
expectBody: Expect response body, support regexp, such as /success/ | ||
debug: Debug option, will log everything when this option is not empty | ||
``` | ||
|
||
Example | ||
|
||
```json | ||
{ | ||
"executor": "http", | ||
"executor_config": { | ||
"method": "GET", | ||
"url": "http://example.com", | ||
"headers": "[]", | ||
"body": "", | ||
"timeout": "30", | ||
"expectCode": "200", | ||
"expectBody": "", | ||
"debug": "true" | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
|
||
--- | ||
title: Shell Executor | ||
--- | ||
|
||
Shell executor run a system command | ||
|
||
## Configuration | ||
|
||
Params | ||
|
||
``` | ||
shell: Run this command using a shell environment | ||
command: The command to run | ||
env: Env vars separated by comma | ||
cwd: Chdir before command run | ||
``` | ||
|
||
Example | ||
|
||
```json | ||
{ | ||
"executor": "shell", | ||
"executor_config": { | ||
"shell": "true", | ||
"command": "my_command", | ||
"env": "ENV_VAR=va1,ANOTHER_ENV_VAR=var2", | ||
"cwd": "/app" | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
title: File Processor | ||
--- | ||
|
||
File processor saves the execution output to a single log file in the specified directory | ||
|
||
## Configuration | ||
|
||
Parameters | ||
|
||
``` | ||
log_dir: Path to the location where the log files will be saved | ||
forward: Forward log output to the next processor | ||
``` | ||
|
||
Example | ||
|
||
``` | ||
{ | ||
"name": "job_name", | ||
"command": "echo 'Hello files'", | ||
"schedule": "@every 2m", | ||
"tags": { | ||
"role": "web" | ||
}, | ||
"processors": { | ||
"files": { | ||
"log_dir": "/var/log/mydir", | ||
"forward": true | ||
} | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: Log Processor | ||
--- | ||
|
||
Log processor writes the execution output to stdout/stderr | ||
|
||
## Configuration | ||
|
||
Parameters | ||
|
||
`forward: Forward the output to the next processor` | ||
|
||
Example | ||
|
||
``` | ||
{ | ||
"name": "job_name", | ||
"command": "echo 'Hello log'", | ||
"schedule": "@every 2m", | ||
"tags": { | ||
"role": "web" | ||
}, | ||
"processors": { | ||
"log": { | ||
"forward": true | ||
} | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: Syslog Processor | ||
--- | ||
|
||
Syslog processor writes the execution output to the system syslog daemon | ||
|
||
Note: Only work on linux systems | ||
|
||
## Configuration | ||
|
||
Parameters | ||
|
||
`forward: Forward the output to the next processor` | ||
|
||
Example | ||
|
||
``` | ||
{ | ||
"name": "job_name", | ||
"command": "echo 'Hello syslog'", | ||
"schedule": "@every 2m", | ||
"tags": { | ||
"role": "web" | ||
}, | ||
"processors": { | ||
"syslog": { | ||
"forward": true | ||
} | ||
} | ||
} | ||
``` |