Minor updates to improve docs (#3504)
* Minor updates to improve docs * removed duplicate eventing getting started bit * moved sequence example to main flows -> sequence section * add redirects
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "CLI tools"
|
||||
weight: 01
|
||||
weight: 03
|
||||
type: "docs"
|
||||
showlandingtoc: "false"
|
||||
aliases:
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Knative concepts"
|
||||
linkTitle: "concepts"
|
||||
linkTitle: "Concepts"
|
||||
weight: 100
|
||||
type: "docs"
|
||||
---
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: "Knative Eventing"
|
||||
linkTitle: "Eventing Component"
|
||||
weight: 60
|
||||
weight: 05
|
||||
type: "docs"
|
||||
showlandingtoc: "false"
|
||||
aliases:
|
||||
|
@ -12,11 +11,6 @@ Knative Eventing is a system that is designed to address a common need for cloud
|
|||
native development and provides composable primitives to enable late-binding
|
||||
event sources and event consumers.
|
||||
|
||||
## Getting Started
|
||||
|
||||
- [Install Knative](../install)
|
||||
- [Run samples](./samples/)
|
||||
|
||||
## Functionality
|
||||
|
||||
Knative Eventing supports multiple modes of usage. The following scenarios are
|
||||
|
|
|
@ -3,9 +3,10 @@ title: "Eventing Flows"
|
|||
linkTitle: "Flows"
|
||||
weight: 31
|
||||
type: "docs"
|
||||
showlandingtoc: "false"
|
||||
---
|
||||
|
||||
Knative Eventing provides a collection of [CRDs](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
|
||||
for describing event flows:
|
||||
* [Sequence](./sequence.md) is for defining an in-order list of functions.
|
||||
* [Parallel](./parallel.md) is for defining a list of branches, each receiving the same CloudEvent.
|
||||
Knative Eventing provides a collection of [custom resource definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) that you can use to define event flows:
|
||||
|
||||
* [Sequence](./sequence) is for defining an in-order list of functions.
|
||||
* [Parallel](./parallel) is for defining a list of branches, each receiving the same CloudEvent.
|
||||
|
|
|
@ -4,6 +4,8 @@ weight: 20
|
|||
type: "docs"
|
||||
aliases:
|
||||
- /docs/eventing/sequence.md
|
||||
- /docs/eventing/samples/sequence
|
||||
showlandingtoc: "false"
|
||||
---
|
||||
|
||||
Sequence CRD provides a way to define an in-order list of functions that will be
|
||||
|
@ -45,23 +47,18 @@ Sequence has four parts for the Status:
|
|||
|
||||
## Examples
|
||||
|
||||
For each of these examples below, we'll use
|
||||
[`PingSource`](https://knative.dev/docs/eventing/samples/ping-source/) as
|
||||
the source of events.
|
||||
For each of these examples below, You will use a [`PingSource`](../../samples/ping-source/) as the source of events.
|
||||
|
||||
We also use a very simple
|
||||
[transformer](https://github.com/vaikas-google/transformer) which performs very
|
||||
trivial transformation of the incoming events to demonstrate they have passed
|
||||
through each stage.
|
||||
We also use a very simple [transformer](https://github.com/vaikas-google/transformer) which performs very trivial transformation of the incoming events to demonstrate they have passed through each stage.
|
||||
|
||||
### [Sequence with no reply (terminal last Step)](../samples/sequence/sequence-terminal/README.md)
|
||||
### [Sequence with no reply (terminal last Step)](../sequence/sequence-terminal/)
|
||||
|
||||
For the first example, we'll use a 3 Step `Sequence` that is wired directly into
|
||||
the `PingSource`. Each of the steps simply tacks on "- Handled by
|
||||
<STEP NUMBER>", for example the first Step in the `Sequence` will take the
|
||||
incoming message and append "- Handled by 0" to the incoming message.
|
||||
|
||||
### [Sequence with reply (last Step produces output)](../samples/sequence/sequence-reply-to-event-display/README.md)
|
||||
### [Sequence with reply (last Step produces output)](../sequence/sequence-reply-to-event-display/)
|
||||
|
||||
For the next example, we'll use the same 3 Step `Sequence` that is wired
|
||||
directly into the `PingSource`. Each of the steps simply tacks on "- Handled
|
||||
|
@ -71,7 +68,7 @@ incoming message and append "- Handled by 0" to the incoming message.
|
|||
The only difference is that we'll use the `Subscriber.Spec.Reply` field to wire
|
||||
the output of the last Step to an event display pod.
|
||||
|
||||
### [Chaining Sequences together](../samples/sequence/sequence-reply-to-sequence/README.md)
|
||||
### [Chaining Sequences together](../sequence/sequence-reply-to-sequence/)
|
||||
|
||||
For the next example, we'll use the same 3 Step `Sequence` that is wired
|
||||
directly into the `PingSource`. Each of the steps simply tacks on "- Handled
|
||||
|
@ -82,7 +79,7 @@ The only difference is that we'll use the `Subscriber.Spec.Reply` field to wire
|
|||
the output of the last Step to another `Sequence` that does the same message
|
||||
modifications as the first pipeline (with different steps however).
|
||||
|
||||
### [Using Sequence with Broker/Trigger model](../samples/sequence/sequence-with-broker-trigger/README.md)
|
||||
### [Using Sequence with Broker/Trigger model](../sequence/sequence-with-broker-trigger/)
|
||||
|
||||
You can also create a Trigger which targets `Sequence`. This time we'll wire
|
||||
`PingSource` to send events to a `Broker` and then we'll have the `Sequence`
|
|
@ -3,6 +3,8 @@ title: "Sequence wired to event-display"
|
|||
linkTitle: "Displaying sequence output"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
aliases:
|
||||
- /docs/eventing/samples/sequence/sequence-replay-to-event-display
|
||||
---
|
||||
|
||||
We are going to create the following logical configuration. We create a
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
@ -3,6 +3,8 @@ title: "Sequence wired to another Sequence"
|
|||
linkTitle: "Using Sequences in series"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
aliases:
|
||||
- /docs/eventing/samples/sequence/sequence-reply-to-sequence
|
||||
---
|
||||
|
||||
We are going to create the following logical configuration. We create a
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
@ -3,6 +3,8 @@ title: "Sequence terminal"
|
|||
linkTitle: "Create additional events"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
aliases:
|
||||
- /docs/eventing/samples/sequence/sequence-terminal
|
||||
---
|
||||
|
||||
We are going to create the following logical configuration. We create a
|
||||
|
@ -194,5 +196,3 @@ kubectl -n default logs -l serving.knative.dev/service=third -c user-container -
|
|||
2020/03/02 21:28:03 Transform the event to:
|
||||
2020/03/02 21:28:03 [2020-03-02T21:28:00.0010247Z] /apis/v1/namespaces/default/pingsources/ping-source dev.knative.sources.ping: &{Sequence:0 Message:Hello world! - Handled by 0 - Handled by 1 - Handled by 2}
|
||||
```
|
||||
|
||||
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
@ -3,6 +3,8 @@ title: "Using Sequence with Broker and Trigger"
|
|||
linkTitle: "Using with Broker and Trigger"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
aliases:
|
||||
- /docs/eventing/samples/sequence/sequence-with-broker-trigger
|
||||
---
|
||||
|
||||
We are going to create the following logical configuration. We create a
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
@ -1,6 +0,0 @@
|
|||
---
|
||||
title: "Sequence Example"
|
||||
linkTitle: "Sequences"
|
||||
weight: 10
|
||||
type: "docs"
|
||||
---
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Installing Knative"
|
||||
weight: 05
|
||||
weight: 01
|
||||
type: "docs"
|
||||
aliases:
|
||||
- /docs/install/knative-with-any-k8s
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Knative Offerings"
|
||||
linkTitle: "Knative Offerings"
|
||||
weight: 15
|
||||
weight: 06
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title: "Knative Serving"
|
||||
linkTitle: "Serving Component"
|
||||
weight: 20
|
||||
weight: 04
|
||||
type: "docs"
|
||||
showlandingtoc: "false"
|
||||
---
|
||||
|
||||
Knative Serving builds on Kubernetes and Istio to support deploying and serving
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Uninstalling Knative"
|
||||
weight: 85
|
||||
weight: 02
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
|
|