Document Subscription custom resource #1277
Merged
Conversation
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 documentation - Update the cli refernce documentation
abbi-gaurav
added
area/documentation
abbi-gaurav
requested review from
bszwarc,
kazydek,
klaudiagrz and
tomekpapiernik
as code owners
bszwarc
suggested changes
Oct 16, 2018
| type: Custom Resource | ||
| --- | ||
|
|
||
| The `subscriptions.eventing.kyma.cx` Custom Resource Definition (CRD) is a detailed description of the kind of data and the format used to create an event trigger for lambda/microservice in Kyma. After creating a new custom resource, the event trigger is registered in the event bus and events will be delivered to the endpoint specified in the custom resource. To get the up-to-date CRD and show the output in the `yaml` format, run this command: |
There was a problem hiding this comment.
- Create an event trigger for lamba/microservice >
Create an event trigger for lambda or microservice - events will be delivered >
events are delivered - The last sentence:
To get the up-to-date...should be in a new line.
| | **spec.endpoint** | **YES** | The HTTP endpoint to which events will be delivered as a POST request. | | ||
| | **spec.push_request_timeout_ms** | **YES** | The HTTP request timeout. After the timeout expires, event will be redelivered. | | ||
| | **spec.max_inflight** | **YES** | The max concurrent HTTP requests to deliver events. | | ||
| | **spec.include_subscription_name_header** | **YES** | Boolean flag to indicate if the name of the subscription should be included in the HTTP headers while delivering the event. | |
There was a problem hiding this comment.
Boolean flag to indicate > The Boolean flag indicating
| | **spec.include_subscription_name_header** | **YES** | Boolean flag to indicate if the name of the subscription should be included in the HTTP headers while delivering the event. | | ||
| | **spec.event_type** | **YES** | The event type to which the event trigger will be registered. e.g. `order.created` | | ||
| | **spec.event_type_version** | **YES** | The version of the event type. | | ||
| | **spec.source_id** | **YES** | This field identifies the external solution from which the event was sent to Kyma. | |
There was a problem hiding this comment.
This field identifies the external... > Identifies the external the external solution which sent the event to Kyma.
Omitting "this field" at the beginning of the sentence makes it coherent with the first sentence in the table. Also we can avoid the passive voice here.
| | **metadata.name** | **YES** | Specifies the name of the CR. | | ||
| | **spec.endpoint** | **YES** | The HTTP endpoint to which events will be delivered as a POST request. | | ||
| | **spec.push_request_timeout_ms** | **YES** | The HTTP request timeout. After the timeout expires, event will be redelivered. | | ||
| | **spec.max_inflight** | **YES** | The max concurrent HTTP requests to deliver events. | |
There was a problem hiding this comment.
The max concurrent requests > The maximum number of concurrent requests
|
|
||
| This is a sample resource that creates an event trigger for a lambda with `order.created` event. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
You can use yaml formatting (by adding yaml after ```) to make the output look clearer. Example:
apiVersion: eventing.kyma.cx/v1alpha1
kind: Subscription
metadata:
name: hello-with-data-subscription
...| | Parameter | Mandatory | Description | | ||
| |:-----------------------------------------:|:---------:|:----------------------------------------------------------------------------------------------------------------------------| | ||
| | **metadata.name** | **YES** | Specifies the name of the CR. | | ||
| | **spec.endpoint** | **YES** | The HTTP endpoint to which events will be delivered as a POST request. | |
There was a problem hiding this comment.
The HTTP endpoint to which events are delivered as a POST request.
| | **spec.push_request_timeout_ms** | **YES** | The HTTP request timeout. After the timeout expires, event will be redelivered. | | ||
| | **spec.max_inflight** | **YES** | The max concurrent HTTP requests to deliver events. | | ||
| | **spec.include_subscription_name_header** | **YES** | Boolean flag to indicate if the name of the subscription should be included in the HTTP headers while delivering the event. | | ||
| | **spec.event_type** | **YES** | The event type to which the event trigger will be registered. e.g. `order.created` | |
There was a problem hiding this comment.
The event type to which the event trigger is registered.
| |:-----------------------------------------:|:---------:|:----------------------------------------------------------------------------------------------------------------------------| | ||
| | **metadata.name** | **YES** | Specifies the name of the CR. | | ||
| | **spec.endpoint** | **YES** | The HTTP endpoint to which events will be delivered as a POST request. | | ||
| | **spec.push_request_timeout_ms** | **YES** | The HTTP request timeout. After the timeout expires, event will be redelivered. | |
There was a problem hiding this comment.
After the timeout has expired, events are redelivered.
|
@bszwarc I applied the feedback. Please have a look. |
bszwarc
suggested changes
Oct 16, 2018
|
|
||
| This is a sample resource that creates an event trigger for a lambda with `order.created` event. | ||
|
|
||
| ``` ) |
There was a problem hiding this comment.
``` yaml
(at the beginning of the code sample)
abbi-gaurav
force-pushed
the
docu-subscription-cr
branch
from
e242510 to
2f010b2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Related issue(s)
See also #1121