mirror of https://github.com/knative/docs.git
Updating to point to CE 1.0.2 (#5082)
Signed-off-by: Matthias Wessendorf <mwessend@redhat.com>
This commit is contained in:
parent
7f4bb9b043
commit
625c6202ea
|
@ -8,7 +8,7 @@ Notable features are:
|
|||
- Control plane High Availability
|
||||
- Horizontally scalable data plane
|
||||
- [Extensively configurable](#kafka-producer-and-consumer-configurations)
|
||||
- Ordered delivery of events based on [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/v1.0.1/extensions/partitioning.md)
|
||||
- Ordered delivery of events based on [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/extensions/partitioning.md)
|
||||
- Support any Kafka version, see [compatibility matrix](https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix)
|
||||
|
||||
The Knative Kafka Broker stores incoming CloudEvents as Kafka records, using the [binary content mode](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/kafka-protocol-binding.md#32-binary-content-mode). This means all CloudEvent attributes and extensions are mapped as [headers on the Kafka record](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/kafka-protocol-binding.md#323-metadata-headers), while the `data` of the CloudEvent corresponds to the value of the Kafka record.
|
||||
|
|
|
@ -18,7 +18,7 @@ Before you can create a ContainerSource object, you must have [Knative Eventing]
|
|||
You can develop a container image by using any language, and can build and publish your image by using any tools you like. The following are some basic guidelines:
|
||||
|
||||
- Two environments variables are injected by the ContainerSource controller; `K_SINK` and `K_CE_OVERRIDES`, resolved from `spec.sink` and `spec.ceOverrides` respectively.
|
||||
- The event messages are sent to the sink URI specified in `K_SINK`. The message must be sent as a POST in [CloudEvents HTTP format](https://github.com/cloudevents/spec/blob/v1.0.1/http-protocol-binding.md).
|
||||
- The event messages are sent to the sink URI specified in `K_SINK`. The message must be sent as a POST in [CloudEvents HTTP format](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md).
|
||||
|
||||
## Create a ContainerSource object
|
||||
|
||||
|
|
|
@ -94,4 +94,4 @@ spec:
|
|||
[kubernetes-overview]:
|
||||
https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
|
||||
[cloudevents-attribute-naming]:
|
||||
https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#attribute-naming-convention
|
||||
https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#attribute-naming-convention
|
||||
|
|
|
@ -147,4 +147,4 @@ spec:
|
|||
[kubernetes-namespaces]:
|
||||
https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
|
||||
[cloudevents-attribute-naming]:
|
||||
https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#attribute-naming-convention
|
||||
https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#attribute-naming-convention
|
||||
|
|
|
@ -14,9 +14,9 @@ It's recommended that you have a basic understanding of the following:
|
|||
|
||||
- [Brokers](broker/README.md)
|
||||
- [Triggers](broker/triggers/README.md)
|
||||
- The [CloudEvents spec](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md),
|
||||
- The [CloudEvents spec](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md),
|
||||
particularly the
|
||||
[Context Attributes](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes)
|
||||
[Context Attributes](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#context-attributes)
|
||||
section
|
||||
- [Event sources](sources/README.md)
|
||||
|
||||
|
@ -71,8 +71,8 @@ EventType objects:
|
|||
|
||||
| Field | Description | Required or optional |
|
||||
|-------|-------------|----------------------|
|
||||
| `spec.type` | Refers to the [CloudEvent type](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#type) as it enters into the event mesh. Event consumers can create Triggers filtering on this attribute. This field is authoritative. | Required |
|
||||
| `spec.source` | Refers to the [CloudEvent source](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#source-1) as it enters into the event mesh. Event consumers can create Triggers filtering on this attribute. | Required |
|
||||
| `spec.type` | Refers to the [CloudEvent type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) as it enters into the event mesh. Event consumers can create Triggers filtering on this attribute. This field is authoritative. | Required |
|
||||
| `spec.source` | Refers to the [CloudEvent source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) as it enters into the event mesh. Event consumers can create Triggers filtering on this attribute. | Required |
|
||||
| `spec.schema` | A valid URI with the EventType schema such as a JSON schema or a protobuf schema. | Optional |
|
||||
| `spec.description` | A string describing what the EventType is about. | Optional |
|
||||
| `spec.broker` | Refers to the Broker that can provide the EventType. | Required |
|
||||
|
|
|
@ -89,9 +89,9 @@ spec:
|
|||
# default: structured.
|
||||
#
|
||||
# CloudEvent spec references:
|
||||
# - https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#message
|
||||
# - https://github.com/cloudevents/spec/blob/v1.0.1/kafka-protocol-binding.md#33-structured-content-mode
|
||||
# - https://github.com/cloudevents/spec/blob/v1.0.1/kafka-protocol-binding.md#32-binary-content-mode
|
||||
# - https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#message
|
||||
# - https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/kafka-protocol-binding.md#33-structured-content-mode
|
||||
# - https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/kafka-protocol-binding.md#32-binary-content-mode
|
||||
contentMode: binary # or structured
|
||||
```
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ All Sources are part of the `sources` category.
|
|||
```
|
||||
|
||||
!!! note
|
||||
Event Sources that import events from other messaging technologies such as Kafka or RabbitMQ are not responsible for setting [Optional Attributes](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#optional-attributes) such as the `datacontenttype`. This is a responsibility of the original event producer; the Source just appends attributes if they exist.
|
||||
Event Sources that import events from other messaging technologies such as Kafka or RabbitMQ are not responsible for setting [Optional Attributes](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#optional-attributes) such as the `datacontenttype`. This is a responsibility of the original event producer; the Source just appends attributes if they exist.
|
||||
|
||||
## Knative Sources
|
||||
|
||||
|
|
|
@ -259,4 +259,4 @@ spec:
|
|||
[label-selectors]:
|
||||
http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
|
||||
[cloudevents-attribute-naming]:
|
||||
https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#attribute-naming-convention
|
||||
https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#attribute-naming-convention
|
||||
|
|
|
@ -77,4 +77,4 @@ spec:
|
|||
[kubernetes-namespaces]:
|
||||
https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
|
||||
[cloudevents-attribute-naming]:
|
||||
https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#attribute-naming-convention
|
||||
https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#attribute-naming-convention
|
||||
|
|
Loading…
Reference in New Issue