From 966afcb78759747484c56033816068af269b42e7 Mon Sep 17 00:00:00 2001
From: Jose Diaz-Gonzalez <email@josediazgonzalez.com>
Date: Wed, 19 Jun 2019 13:50:29 -0400
Subject: [PATCH] chore: add missing hooks to events plugin and plugin triggers
 docs

---
 docs/development/plugin-triggers.md          | 111 ++++++++++++++-----
 plugins/20_events/app-restart                |   1 +
 plugins/20_events/app-urls                   |   1 +
 plugins/20_events/docker-args-process-build  |   1 +
 plugins/20_events/docker-args-process-deploy |   1 +
 plugins/20_events/docker-args-process-run    |   1 +
 plugins/20_events/git-revision               |   1 +
 plugins/20_events/resource-get-property      |   1 +
 plugins/20_events/scheduler-app-status       |   1 +
 plugins/20_events/scheduler-inspect          |   1 +
 plugins/20_events/scheduler-is-deployed      |   1 +
 plugins/20_events/scheduler-logs             |   1 +
 plugins/20_events/scheduler-logs-failed      |   1 +
 plugins/20_events/scheduler-post-delete      |   1 +
 plugins/20_events/scheduler-retire           |   1 +
 15 files changed, 96 insertions(+), 29 deletions(-)
 create mode 120000 plugins/20_events/app-restart
 create mode 120000 plugins/20_events/app-urls
 create mode 120000 plugins/20_events/docker-args-process-build
 create mode 120000 plugins/20_events/docker-args-process-deploy
 create mode 120000 plugins/20_events/docker-args-process-run
 create mode 120000 plugins/20_events/git-revision
 create mode 120000 plugins/20_events/resource-get-property
 create mode 120000 plugins/20_events/scheduler-app-status
 create mode 120000 plugins/20_events/scheduler-inspect
 create mode 120000 plugins/20_events/scheduler-is-deployed
 create mode 120000 plugins/20_events/scheduler-logs
 create mode 120000 plugins/20_events/scheduler-logs-failed
 create mode 120000 plugins/20_events/scheduler-post-delete
 create mode 120000 plugins/20_events/scheduler-retire

diff --git a/docs/development/plugin-triggers.md b/docs/development/plugin-triggers.md
index a7e52baf7..eaf905aa8 100644
--- a/docs/development/plugin-triggers.md
+++ b/docs/development/plugin-triggers.md
@@ -29,6 +29,21 @@ The following plugin triggers describe those available to a Dokku installation.
 
 > The example plugin trigger code is not guaranteed to be implemented as in within dokku, and are merely simplified examples. Please look at the Dokku source for larger, more in-depth examples.
 
+### `app-restart`
+
+- Description: Triggers an app restart
+- Invoked by: `dokku config:clear`, `dokku config:set`, `dokku config:unset`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+# TODO
+```
+
 ### `app-urls`
 
 - Description: Allows you to change the urls Dokku reports for an application. Will override any auto-detected urls.
@@ -291,26 +306,6 @@ verify_app_name "$APP"
 # TODO
 ```
 
-### `docker-args-run`
-
-> Warning: Deprecated, please use `docker-args-process-run` instead
-
-- Description:
-- Invoked by: `dokku run`
-- Arguments: `$APP $IMAGE_TAG`
-- Example:
-
-```shell
-#!/usr/bin/env bash
-
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
-source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
-APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
-verify_app_name "$APP"
-
-# TODO
-```
-
 ### `docker-args-process-build`
 
 - Description: `$PROC_TYPE` may be set to magic `_all_` process type to signify global docker deploy options.
@@ -365,6 +360,26 @@ verify_app_name "$APP"
 # TODO
 ```
 
+### `docker-args-run`
+
+> Warning: Deprecated, please use `docker-args-process-run` instead
+
+- Description:
+- Invoked by: `dokku run`
+- Arguments: `$APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+APP="$1"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $APP $IMAGE_TAG)
+verify_app_name "$APP"
+
+# TODO
+```
+
 ### `git-post-pull`
 
 - Description:
@@ -1162,9 +1177,9 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 # TODO
 ```
 
-### `proxy-enable`
+### `proxy-disable`
 
-- Description: Enables the configured proxy implementation for an app
+- Description: Disables the configured proxy implementation for an app
 - Invoked by: `internally triggered by ps:restore`
 - Arguments: `$APP`
 - Example:
@@ -1177,9 +1192,9 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 # TODO
 ```
 
-### `proxy-disable`
+### `proxy-enable`
 
-- Description: Disables the configured proxy implementation for an app
+- Description: Enables the configured proxy implementation for an app
 - Invoked by: `internally triggered by ps:restore`
 - Arguments: `$APP`
 - Example:
@@ -1234,6 +1249,22 @@ fi
 plugn trigger receive-app $APP $newrev
 ```
 
+### `report`
+
+- Description: Allows you to report on any custom configuration in use by your application
+- Invoked by: `dokku report`
+- Arguments: `$APP`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+APP="$1";
+
+# TODO
+```
+
 ### `resource-get-property`
 
 - Description: Fetches a given resource property value
@@ -1267,18 +1298,21 @@ APP="$1"; HOSTNAME=$(hostname -s)
 mail -s "$APP containers on $HOSTNAME failed to retire" ops@dokku.me
 ```
 
-### `report`
+### `scheduler-app-status`
 
-- Description: Allows you to report on any custom configuration in use by your application
-- Invoked by: `dokku report`
-- Arguments: `$APP`
+> Warning: The scheduler plugin trigger apis are under development and may change
+> between minor releases until the 1.0 release.
+
+- Description: Fetch the status of an app
+- Invoked by: `dokku ps:report`
+- Arguments: `$DOKKU_SCHEDULER $APP`
 - Example:
 
 ```shell
 #!/usr/bin/env bash
 
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
-APP="$1";
+DOKKU_SCHEDULER="$1"; APP="$2";
 
 # TODO
 ```
@@ -1396,6 +1430,25 @@ DOKKU_SCHEDULER="$1"; APP="$2";
 # TODO
 ```
 
+### `scheduler-post-delete`
+
+> 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 an app is deleted
+- Invoked by: `dokku apps:destroy`
+- Arguments: `$DOKKU_SCHEDULER $APP $IMAGE_TAG`
+- Example:
+
+```shell
+#!/usr/bin/env bash
+
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+DOKKU_SCHEDULER="$1"; APP="$2"; IMAGE_TAG="$3";
+
+# TODO
+```
+
 ### `scheduler-retire`
 
 > Warning: The scheduler plugin trigger apis are under development and may change
diff --git a/plugins/20_events/app-restart b/plugins/20_events/app-restart
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/app-restart
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/app-urls b/plugins/20_events/app-urls
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/app-urls
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/docker-args-process-build b/plugins/20_events/docker-args-process-build
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/docker-args-process-build
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/docker-args-process-deploy b/plugins/20_events/docker-args-process-deploy
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/docker-args-process-deploy
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/docker-args-process-run b/plugins/20_events/docker-args-process-run
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/docker-args-process-run
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/git-revision b/plugins/20_events/git-revision
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/git-revision
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/resource-get-property b/plugins/20_events/resource-get-property
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/resource-get-property
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/scheduler-app-status b/plugins/20_events/scheduler-app-status
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/scheduler-app-status
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/scheduler-inspect b/plugins/20_events/scheduler-inspect
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/scheduler-inspect
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/scheduler-is-deployed b/plugins/20_events/scheduler-is-deployed
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/scheduler-is-deployed
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/scheduler-logs b/plugins/20_events/scheduler-logs
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/scheduler-logs
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/scheduler-logs-failed b/plugins/20_events/scheduler-logs-failed
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/scheduler-logs-failed
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/scheduler-post-delete b/plugins/20_events/scheduler-post-delete
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/scheduler-post-delete
@@ -0,0 +1 @@
+hook
\ No newline at end of file
diff --git a/plugins/20_events/scheduler-retire b/plugins/20_events/scheduler-retire
new file mode 120000
index 000000000..5178a749f
--- /dev/null
+++ b/plugins/20_events/scheduler-retire
@@ -0,0 +1 @@
+hook
\ No newline at end of file