-
Notifications
You must be signed in to change notification settings - Fork 746
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Simple health check endpoint for webhooks (#823)
* feat: Simple health check endpoint for webhooks * doc * doc update * dock change * re-run codegen * fix
- Loading branch information
Showing
7 changed files
with
50 additions
and
8 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 @@ | ||
# Webhook Health Check | ||
|
||
![alpha](assets/alpha.svg) | ||
|
||
> v1.0 and after | ||
For `webhook` or `webhook` extended event sources such as `github`, `gitlab`, | ||
`sns`, `slack`, `Storage GRID` and `stripe`, besides the endpint configured in | ||
the spec, an endpoint `:${port}/health` will be created by default, this is | ||
useful for LB or Ingress configuration for the event source, where usually a | ||
health check endpoint is required. | ||
|
||
For example, besides `:12000/example1` and `:13000/example2`, the EventSource | ||
object below also creates 2 extra endpoints, `:12000/health` and | ||
`:13000/health`. A HTTP GET request to the health endpoint returns a text `OK` | ||
with HTTP response code `200`. | ||
|
||
```yaml | ||
apiVersion: argoproj.io/v1alpha1 | ||
kind: EventSource | ||
metadata: | ||
name: webhook | ||
spec: | ||
webhook: | ||
example: | ||
port: "12000" | ||
endpoint: /example1 | ||
method: POST | ||
example-foo: | ||
port: "13000" | ||
endpoint: /example2 | ||
method: POST | ||
``` |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.