mirror of https://github.com/knative/docs.git
Fixed few broken cloudevents links in the documentation (#4445)
* Fixed few broken cloudevents links in the documentation * Fixed more broken CloudEvent docs links in the documentation. Updated links to CloudEvents v1.0 documentation to CloudEvents v1.0.1 documentation
This commit is contained in:
Maciej Chyczewski
GitHub
parent
31a4740480
commit
79e4639009
|
|
@ -504,7 +504,7 @@ with Apache Kafka for the Knative Broker and Trigger model.</p>
|
|||
<li>Control plane High Availability</li>
|
||||
<li>Horizontally scalable data plane</li>
|
||||
<li><a href="#kafka-producer-and-consumer-configurations">Extensively configurable</a></li>
|
||||
<li>Ordered delivery of events based on <a href="https://github.com/cloudevents/spec/blob/master/extensions/partitioning.md">CloudEvents partitioning extension</a></li>
|
||||
<li>Ordered delivery of events based on <a href="https://github.com/cloudevents/spec/blob/v1.0.1/extensions/partitioning.md">CloudEvents partitioning extension</a></li>
|
||||
<li>Support any Kafka version, see <a href="https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix">compatibility matrix</a></li>
|
||||
</ul>
|
||||
<h2 id="prerequisites">Prerequisites</h2>
|
||||
|
|
|
|||
|
|
@ -2130,7 +2130,7 @@ with Apache Kafka for the Knative Broker and Trigger model.</p>
|
|||
<li>Control plane High Availability</li>
|
||||
<li>Horizontally scalable data plane</li>
|
||||
<li><a href="#kafka-producer-and-consumer-configurations">Extensively configurable</a></li>
|
||||
<li>Ordered delivery of events based on <a href="https://github.com/cloudevents/spec/blob/master/extensions/partitioning.md">CloudEvents partitioning extension</a></li>
|
||||
<li>Ordered delivery of events based on <a href="https://github.com/cloudevents/spec/blob/v1.0.1/extensions/partitioning.md">CloudEvents partitioning extension</a></li>
|
||||
<li>Support any Kafka version, see <a href="https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix">compatibility matrix</a></li>
|
||||
</ul>
|
||||
<h2 id="prerequisites">Prerequisites</h2>
|
||||
|
|
|
|||
|
|
@ -2125,9 +2125,9 @@ type information in the cluster data store.</p>
|
|||
<ol>
|
||||
<li>Read about the <a href="../broker/">broker</a> and <a href="../broker/triggers/">trigger</a> objects.</li>
|
||||
<li>Be familiar with the
|
||||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md">CloudEvents spec</a>,
|
||||
<a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md">CloudEvents spec</a>,
|
||||
particularly the
|
||||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes">Context Attributes</a>
|
||||
<a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes">Context Attributes</a>
|
||||
section.</li>
|
||||
<li>Be familiar with <a href="../sources">event sources</a>.</li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -2146,7 +2146,7 @@ consumer.</li>
|
|||
</li>
|
||||
<li>Ensure cross-service interoperability. Knative Eventing is consistent with
|
||||
the
|
||||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#design-goals">CloudEvents</a>
|
||||
<a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#design-goals">CloudEvents</a>
|
||||
specification that is developed by the
|
||||
<a href="https://lists.cncf.io/g/cncf-wg-serverless">CNCF Serverless WG</a>.</li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -741,9 +741,9 @@ type information in the cluster data store.</p>
|
|||
<ol>
|
||||
<li>Read about the <a href="../broker/">broker</a> and <a href="../broker/triggers/">trigger</a> objects.</li>
|
||||
<li>Be familiar with the
|
||||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md">CloudEvents spec</a>,
|
||||
<a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md">CloudEvents spec</a>,
|
||||
particularly the
|
||||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes">Context Attributes</a>
|
||||
<a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes">Context Attributes</a>
|
||||
section.</li>
|
||||
<li>Be familiar with <a href="../sources">event sources</a>.</li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -2237,7 +2237,7 @@ variables.</li>
|
|||
<code>K_SINK</code> and <code>K_CE_OVERRIDES</code>, resolved from <code>spec.sink</code> and <code>spec.ceOverrides</code> respectively.</li>
|
||||
<li>The event messages shall be sent to the sink URI specified in <code>K_SINK</code>. The message can be any
|
||||
format.
|
||||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#design-goals">CloudEvents</a>
|
||||
<a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#design-goals">CloudEvents</a>
|
||||
format is recommended.</li>
|
||||
</ul>
|
||||
<p><a href="https://github.com/knative/eventing/blob/main/cmd/heartbeats/main.go">heartbeats</a>
|
||||
|
|
|
|||
|
|
@ -232,7 +232,7 @@ variables.</li>
|
|||
<code>K_SINK</code> and <code>K_CE_OVERRIDES</code>, resolved from <code>spec.sink</code> and <code>spec.ceOverrides</code> respectively.</li>
|
||||
<li>The event messages shall be sent to the sink URI specified in <code>K_SINK</code>. The message can be any
|
||||
format.
|
||||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#design-goals">CloudEvents</a>
|
||||
<a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#design-goals">CloudEvents</a>
|
||||
format is recommended.</li>
|
||||
</ul>
|
||||
<p><a href="https://github.com/knative/eventing/blob/main/cmd/heartbeats/main.go">heartbeats</a>
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@
|
|||
</ul>
|
||||
<h1 id="theory">Theory</h1>
|
||||
<p>Quick Introduction to Knative Eventing Sources
|
||||
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a <a href="https://github.com/cloudevents/spec/blob/v1.0/primer.md">CloudEvents</a>.</p>
|
||||
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a <a href="https://github.com/cloudevents/spec/blob/v1.0.1/primer.md">CloudEvents</a>.</p>
|
||||
<p><a href="https://github.com/knative/eventing/blob/master/docs/spec/sources.md">The specification</a>
|
||||
for Knative Eventing Sources contains a number of requirements that
|
||||
together define a well-behaved Knative Source.</p>
|
||||
|
|
|
|||
|
|
@ -2166,7 +2166,7 @@ if (!doNotTrack) {
|
|||
</ul>
|
||||
<h1 id="theory">Theory</h1>
|
||||
<p>Quick Introduction to Knative Eventing Sources
|
||||
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a <a href="https://github.com/cloudevents/spec/blob/v1.0/primer.md">CloudEvents</a>.</p>
|
||||
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a <a href="https://github.com/cloudevents/spec/blob/v1.0.1/primer.md">CloudEvents</a>.</p>
|
||||
<p><a href="https://github.com/knative/eventing/blob/main/docs/spec/sources.md">The specification</a>
|
||||
for Knative Eventing Sources contains a number of requirements that
|
||||
together define a well-behaved Knative Source.</p>
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@
|
|||
</ul>
|
||||
<h1 id="theory">Theory</h1>
|
||||
<p>Quick Introduction to Knative Eventing Sources
|
||||
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a <a href="https://github.com/cloudevents/spec/blob/v1.0/primer.md">CloudEvents</a>.</p>
|
||||
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a <a href="https://github.com/cloudevents/spec/blob/v1.0.1/primer.md">CloudEvents</a>.</p>
|
||||
<p><a href="https://github.com/knative/eventing/blob/main/docs/spec/sources.md">The specification</a>
|
||||
for Knative Eventing Sources contains a number of requirements that
|
||||
together define a well-behaved Knative Source.</p>
|
||||
|
|
|
|||
|
|
@ -9,7 +9,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/master/extensions/partitioning.md)
|
||||
- Ordered delivery of events based on [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/v1.0.1/extensions/partitioning.md)
|
||||
- Support any Kafka version, see [compatibility matrix](https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix)
|
||||
|
||||
## Prerequisites
|
||||
|
|
|
|||
|
|
@ -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/master/spec.md),
|
||||
- The [CloudEvents spec](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md),
|
||||
particularly the
|
||||
[Context Attributes](https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes)
|
||||
[Context Attributes](https://github.com/cloudevents/spec/blob/v1.0.1/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/master/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/master/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.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.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/spec.md#message
|
||||
# - https://github.com/cloudevents/spec/blob/v1.0/kafka-protocol-binding.md#33-structured-content-mode
|
||||
# - https://github.com/cloudevents/spec/blob/v1.0/kafka-protocol-binding.md#32-binary-content-mode
|
||||
# - 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
|
||||
contentMode: binary # or structured
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Let's take a look at how these components interact:
|
|||
|
||||
### CloudEvents
|
||||
Knative Eventing uses
|
||||
[CloudEvents](https://github.com/cloudevents/spec/blob/master/primer.md){target=blank_} to send
|
||||
[CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.1/primer.md){target=blank_} to send
|
||||
information back and forth between your Services and these components.
|
||||
|
||||
??? question "What are CloudEvents?"
|
||||
|
|
|
|||
|
|
@ -6,9 +6,9 @@ import "errors"
|
|||
type Encoding int
|
||||
|
||||
const (
|
||||
// Binary encoding as specified in https://github.com/cloudevents/spec/blob/master/spec.md#message
|
||||
// Binary encoding as specified in https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#message
|
||||
EncodingBinary Encoding = iota
|
||||
// Structured encoding as specified in https://github.com/cloudevents/spec/blob/master/spec.md#message
|
||||
// Structured encoding as specified in https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#message
|
||||
EncodingStructured
|
||||
// Message is an instance of EventMessage or it contains EventMessage nested (through MessageWrapper)
|
||||
EncodingEvent
|
||||
|
|
|
|||
|
|
@ -157,7 +157,7 @@ func (ec EventContextV03) AsV1() *EventContextV1 {
|
|||
}
|
||||
|
||||
// Validate returns errors based on requirements from the CloudEvents spec.
|
||||
// For more details, see https://github.com/cloudevents/spec/blob/master/spec.md
|
||||
// For more details, see https://github.com/cloudevents/spec/blob/v1.0.1/spec.md
|
||||
// As of Feb 26, 2019, commit 17c32ea26baf7714ad027d9917d03d2fff79fc7e
|
||||
// + https://github.com/cloudevents/spec/pull/387 -> datacontentencoding
|
||||
// + https://github.com/cloudevents/spec/pull/406 -> subject
|
||||
|
|
|
|||
|
|
@ -163,7 +163,7 @@ func (ec EventContextV1) AsV1() *EventContextV1 {
|
|||
}
|
||||
|
||||
// Validate returns errors based on requirements from the CloudEvents spec.
|
||||
// For more details, see https://github.com/cloudevents/spec/blob/v1.0/spec.md.
|
||||
// For more details, see https://github.com/cloudevents/spec/blob/v1.0.1/spec.md.
|
||||
func (ec EventContextV1) Validate() ValidationError {
|
||||
errors := map[string]error{}
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ type Protocol struct {
|
|||
|
||||
// OptionsHandlerFn handles the OPTIONS method requests and is intended to
|
||||
// implement the abuse protection spec:
|
||||
// https://github.com/cloudevents/spec/blob/v1.0/http-webhook.md#4-abuse-protection
|
||||
// https://github.com/cloudevents/spec/blob/v1.0.1/http-webhook.md#4-abuse-protection
|
||||
OptionsHandlerFn http.HandlerFunc
|
||||
WebhookConfig *WebhookConfig
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue