Mark webhooks as experimental
Project: http://git-wip-us.apache.org/repos/asf/aurora/repo Commit: http://git-wip-us.apache.org/repos/asf/aurora/commit/2e7b317b Tree: http://git-wip-us.apache.org/repos/asf/aurora/tree/2e7b317b Diff: http://git-wip-us.apache.org/repos/asf/aurora/diff/2e7b317b Branch: refs/heads/master Commit: 2e7b317beca4fe039356d63df6a367bd24896a54 Parents: 33295fa Author: Stephan Erb <[email protected]> Authored: Tue Jun 7 00:49:43 2016 +0200 Committer: Stephan Erb <[email protected]> Committed: Tue Jun 7 00:49:43 2016 +0200 ---------------------------------------------------------------------- RELEASE-NOTES.md | 3 ++- docs/features/webhooks.md | 15 ++++++++------- 2 files changed, 10 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/aurora/blob/2e7b317b/RELEASE-NOTES.md ---------------------------------------------------------------------- diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 65f4191..96bc3ca 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -39,7 +39,8 @@ `-job_update_history_pruning_threshold=1mins` and `-job_update_history_per_job_threshold=0` 5. Ensure a new snapshot is created by running `aurora_admin scheduler_snapshot <cluster>` 6. Rollback to previous version -- Adding a webhook feature which POSTs all task state changes to a user defined endpoint. +- Experimental support for a webhook feature which POSTs all task state changes to a user defined + endpoint. ### Deprecations and removals: http://git-wip-us.apache.org/repos/asf/aurora/blob/2e7b317b/docs/features/webhooks.md ---------------------------------------------------------------------- diff --git a/docs/features/webhooks.md b/docs/features/webhooks.md index 2ca342f..075aeec 100644 --- a/docs/features/webhooks.md +++ b/docs/features/webhooks.md @@ -1,13 +1,13 @@ Webhooks -================== +======== -Aurora has an optional feature which allows operator to specify a file to configure a HTTP webhook to receive task state - change events. It can be enabled with a scheduler flag eg - -webhook_config=/path/to/webhook.json +Aurora has an optional feature which allows operator to specify a file to configure a HTTP webhook +to receive task state change events. It can be enabled with a scheduler flag eg +`-webhook_config=/path/to/webhook.json`. At this point, webhooks are still considered *experimental*. - Below is a sample configuration: +Below is a sample configuration: - ```json +```json { "headers": { "Content-Type": "application/vnd.kafka.json.v1+json", @@ -76,4 +76,5 @@ And an example of a response that you will get back: {"cachedHashCode":0,"timestamp":1464992060258,"status":"PENDING","scheduler":"aurora"}] }, "oldState":{}} -``` \ No newline at end of file +``` +
