mirror of https://github.com/knative/docs.git
Update eventing top-level readme with @sebgoa feedback (#530)
* Update documentation for 0.2 release. * Update docs with @sebgoa feedback.
This commit is contained in:
parent
28588f96b6
commit
f1721ec51a
|
@ -32,11 +32,16 @@ generic interfaces which multiple Kubernetes resources can implement:
|
||||||
external event source are processed.
|
external event source are processed.
|
||||||
|
|
||||||
Knative Eventing also defines a single event forwarding and persistence layer,
|
Knative Eventing also defines a single event forwarding and persistence layer,
|
||||||
called a **Channel**. Messaging implementations may provide implementations of
|
called a
|
||||||
Channels via the ClusterChannelProvisioner object. This allows message delivery
|
[**Channel**](https://github.com/knative/eventing/blob/master/pkg/apis/eventing/v1alpha1/channel_types.go#L36).
|
||||||
in a cluster to vary based on requirements, so that some events might be handled
|
Messaging implementations may provide implementations of Channels via the
|
||||||
by an in-memory implementation while others would be persisted using Kafka or
|
[ClusterChannelProvisioner](https://github.com/knative/eventing/blob/master/pkg/apis/eventing/v1alpha1/cluster_channel_provisioner_types.go#L35)
|
||||||
NATS Streaming.
|
object. Events are delivered to Services or forwarded to other channels
|
||||||
|
(possibly of a different type) using
|
||||||
|
[Subscriptions](https://github.com/knative/eventing/blob/master/pkg/apis/eventing/v1alpha1/subscription_types.go#L35).
|
||||||
|
This allows message delivery in a cluster to vary based on requirements, so that
|
||||||
|
some events might be handled by an in-memory implementation while others would
|
||||||
|
be persisted using Kafka or NATS Streaming.
|
||||||
|
|
||||||
The focus for the next Eventing release will be to enable easy implementation of
|
The focus for the next Eventing release will be to enable easy implementation of
|
||||||
event sources. Sources manage registration and delivery of events from external
|
event sources. Sources manage registration and delivery of events from external
|
||||||
|
@ -71,13 +76,18 @@ definitions and an associated controller) and channels
|
||||||
|
|
||||||
The eventing infrastructure supports two forms of event delivery at the moment:
|
The eventing infrastructure supports two forms of event delivery at the moment:
|
||||||
|
|
||||||
1. Direct delivery from a source to a single Service. In this case, the Source
|
1. Direct delivery from a source to a single Service (an Addressable endpoint,
|
||||||
is responsible for retrying or queueing events if the destination Service is
|
including a Knative Service or a core Kubernetes Service). In this case, the
|
||||||
not available.
|
Source is responsible for retrying or queueing events if the destination
|
||||||
|
Service is not available.
|
||||||
2. Fan-out delivery from a source or Service response to multiple endpoints
|
2. Fan-out delivery from a source or Service response to multiple endpoints
|
||||||
using Channels and Subscriptions. In this case, the Channel implementation
|
using
|
||||||
ensures that messages are delivered to the requested destinations and should
|
[Channels](https://github.com/knative/eventing/blob/master/pkg/apis/eventing/v1alpha1/channel_types.go#L36)
|
||||||
buffer the events if the destination Service is unavailable.
|
and
|
||||||
|
[Subscriptions](https://github.com/knative/eventing/blob/master/pkg/apis/eventing/v1alpha1/subscription_types.go#L35).
|
||||||
|
In this case, the Channel implementation ensures that messages are delivered
|
||||||
|
to the requested destinations and should buffer the events if the destination
|
||||||
|
Service is unavailable.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
@ -97,7 +107,7 @@ Knative Eventing defines the following Sources in the
|
||||||
`sources.eventing.knative.dev` API group. Types below are declared in golang
|
`sources.eventing.knative.dev` API group. Types below are declared in golang
|
||||||
format, but may be expressed as simple lists, etc in YAML. All Sources should be
|
format, but may be expressed as simple lists, etc in YAML. All Sources should be
|
||||||
part of the `sources` category, so you can list all existing Sources with
|
part of the `sources` category, so you can list all existing Sources with
|
||||||
`kubectl get sources`.
|
`kubectl get sources`. The currently-implemented Sources are described below:
|
||||||
|
|
||||||
### KubernetesEventSource
|
### KubernetesEventSource
|
||||||
|
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 36 KiB |
Loading…
Reference in New Issue