docs: add missing documentation for scheduler-failed plugin trigger
This commit is contained in:
1 parent
78f467852e
commit
f173c2f1c2
2 files changed
+21
-1
No files matched your search
@@ -25,7 +25,8 @@ This plugin implements various functionality through `plugn` triggers to integra
|
|||||||
- `pre-restore`
|
- `pre-restore`
|
||||||
- `scheduler-deploy`
|
- `scheduler-deploy`
|
||||||
- `scheduler-docker-cleanup`
|
- `scheduler-docker-cleanup`
|
||||||
|
- `scheduler-failed`
|
||||||
- `scheduler-run`
|
- `scheduler-run`
|
||||||
- `scheduler-stop`
|
- `scheduler-stop`
|
||||||
- `scheduler-tags-create`
|
- `scheduler-tags-create`
|
||||||
- `scheduler-tags-destroy`
|
- `scheduler-tags-destroy`
|
||||||
@@ -1207,6 +1207,25 @@ DOKKU_SCHEDULER="$1"; APP="$2"; FORCE_CLEANUP="$3";
|
|||||||
# TODO
|
# TODO
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### `scheduler-failed`
|
||||||
|
|
||||||
|
> Warning: The scheduler plugin trigger apis are under development and may change
|
||||||
|
> between minor releases until the 1.0 release.
|
||||||
|
|
||||||
|
- Description: Allows you to run scheduler commands when retrieving failed container logs
|
||||||
|
- Invoked by: `dokku logs:failed`
|
||||||
|
- Arguments: `$DOKKU_SCHEDULER $APP`
|
||||||
|
- Example:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
||||||
|
DOKKU_SCHEDULER="$1"; APP="$2"; ARGS="${@:3}";
|
||||||
|
|
||||||
|
# TODO
|
||||||
|
```
|
||||||
|
|
||||||
### `scheduler-run`
|
### `scheduler-run`
|
||||||
|
|
||||||
- Description: Allows you to run scheduler commands when a command is executed for your app
|
- Description: Allows you to run scheduler commands when a command is executed for your app
|
||||||
|
|||||||
Reference in new issue
Block a user