This repository was archived by the owner on May 5, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
HTTP Poller docs #112
Merged
Merged
HTTP Poller docs #112
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a3648c6
add HTTP Poller docs
odacremolbap eb39008
fix remaining HTTP Source references
odacremolbap 10d851f
can I also fix webhook copy/paste errors here?
odacremolbap 4cde900
Update docs/sources/httppoller.md
addbd5b
Update docs/sources/httppoller.md
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,47 @@ | ||
| # Event Source for HTTP Polling | ||
|
|
||
| This event source launches periodic HTTP requests against an external system endpoint, turning received requests into [CloudEvents][ce] to be consumed by other TriggerMesh components. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - An external system that exposes an HTTP endpoint. | ||
| - When using HTTP basic authentication, a secret containing the password. | ||
|
|
||
| ## Deploying an Instance of the HTTP Poller Source | ||
|
|
||
| Open the Bridge creation screen and add a source of type `HTTP Poller`. | ||
|
|
||
| In the Source creation form add the following information: | ||
|
|
||
| - **Name**: all TriggerMesh components need a unique name per namespace. | ||
| - **Broker**: request converted into [CloudEvents][ce] will be sent to this location. | ||
| - **EventType**: string that identifies the purpose for all CloudEvent messages produced from this source. | ||
| - **EventSource**: (optional) string that identifies the origin for all CloudEvent messages produced from this source. | ||
| - **Enpoint**: URL location for the remote service to be polled. | ||
| - **Method**: HTTP method. | ||
| - **Frequency**: periodicity for requests formatted as [Go duration][go-duration]. | ||
| - **CA Certificate**: (optional) CA certificate configured for TLS connection as plain text. | ||
| - **Skip Verify**: (optional) when set to true skips remote server TLS certificate verification. | ||
| - **Basic Auth Username**: (optional) HTTP basic authentication username. | ||
| - **Basic Auth Password** (optional) points to a secret that contains the HTTP basic authentication password. | ||
| - **Headers** (optional) is a set of key/value pairs that will be set within the HTTP request. | ||
|
|
||
| `Frequency` is formatted after [Go's duration parsing][go-duration]. Most typically this value will contain a number followed by one of "ns", "us" or "µs", "ms", "s", "m", "h". Valid examples are `15000ms` or `15s` for 15 seconds, `60m` or `1h` for one hour. | ||
|
|
||
| When using `CA Certificate` it should be copied into the text area in plain text. | ||
|
|
||
| After clicking the `Save` button, you will be taken back to the Bridge editor. Proceed to adding the remaining components to the Bridge, then submit it. | ||
|
|
||
| ## Events Types | ||
|
|
||
| The HTTP Poller Source creates a CloudEvent for each request received. CloudEvents header values are filled according to these rules: | ||
|
|
||
| - `event-type` is set to the source's provided value. | ||
| - `event-source` is set to the source's provided value. | ||
| - `id` is set to a generated UID. | ||
| - `date` is timestamped when generating the CloudEvent at Triggermesh. | ||
|
|
||
| Request response body is used to fill the CloudEvent data. | ||
|
|
||
| [ce]: https://cloudevents.io | ||
| [go-duration]: https://golang.org/pkg/time/#ParseDuration | ||
This file contains hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMHO it should have been named "Interval", but ok...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that would be a change for the CRD.
Since controller and frontend are merged that will need to go through all other layers.
I would suggest to merge this, then I'll try to have those 3 changes (sources/fe/docs) in place