Skip to content

Commit 37f62e3

Browse files
committed
SRVCOM-1728: Updating abstracts and other improvements for Jupiter guidelines in eventing docs
1 parent 5bc87f0 commit 37f62e3

10 files changed

+39
-46
lines changed

modules/serverless-connect-sink-source-odc.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
[id="serverless-connect-sink-source-odc_{context}"]
88
= Connect an event source to a sink using the Developer perspective
99

10-
You can create multiple event source types in {product-title} that can be connected to sinks.
10+
When you create an event source by using the {product-title} web console, you can specify a sink where events are sent to from that resource. The sink can be any addressable or callable resource that can receive incoming events from other resources.
1111

1212
.Prerequisites
1313

1414
* The {ServerlessOperatorName}, Knative Serving, and Knative Eventing are installed on your {product-title} cluster.
15-
* You have created a sink.
1615
* You have logged in to the web console and are in the *Developer* perspective.
1716
* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
17+
* You have created a sink, such as a Knative service, channel or broker.
1818
1919
.Procedure
2020

modules/serverless-connect-trigger-sink.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[id="serverless-connect-trigger-sink_{context}"]
77
= Connecting a trigger to a sink
88

9-
You can connect a trigger to a sink, so that events from a broker are filtered before they are sent to the sink. A sink that is connected to a trigger is configured as a `subscriber` in the `Trigger` resource spec.
9+
You can connect a trigger to a sink, so that events from a broker are filtered before they are sent to the sink. A sink that is connected to a trigger is configured as a `subscriber` in the `Trigger` object's resource spec.
1010

11-
.Example of a trigger connected to a Kafka sink
11+
.Example of a `Trigger` object connected to a Kafka sink
1212
[source,yaml]
1313
----
1414
apiVersion: eventing.knative.dev/v1

modules/serverless-event-delivery-parameters.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
//
33
// serverless/develop/serverless-event-delivery.adoc
44

5-
:_content-type: CONCEPT
5+
:_content-type: REFERENCE
66
[id="serverless-event-delivery-parameters_{context}"]
77
= Configurable event delivery parameters
88

9-
The following parameters can be configured for event delivery.
9+
Knative Eventing provides configuration parameters that can be used to control what happens to events in cases where events fail to be delivered. For example, you can configure Knative to retry sending events that failed to be consumed, or forward these events to a dead letter sink.
10+
11+
The following parameters can be configured for event delivery:
1012

1113
Dead letter sink:: You can configure the `deadLetterSink` delivery parameter so that if an event fails to be delivered it is sent to the specified event sink.
1214

modules/serverless-list-source-types-kn.adoc

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,15 @@
66
[id="serverless-list-source-types-kn_{context}"]
77
= Listing available event source types by using the Knative CLI
88

9-
You can list event source types that can be created and used on your cluster by using the `kn source list-types` CLI command.
9+
Using the `kn` CLI provides a streamlined and intuitive user interface to view available event source types on your cluster. You can list event source types that can be created and used on your cluster by using the `kn source list-types` CLI command.
1010

1111
.Prerequisites
1212

1313
* The {ServerlessOperatorName} and Knative Eventing are installed on the cluster.
14-
* You have installed the `kn` CLI.
14+
* You have installed the Knative (`kn`) CLI.
1515
1616
.Procedure
1717

18-
ifdef::openshift-enterprise[]
1918
. List the available event source types in the terminal:
2019
+
2120
[source,terminal]
@@ -32,29 +31,12 @@ PingSource pingsources.sources.knative.dev Periodically s
3231
SinkBinding sinkbindings.sources.knative.dev Binding for connecting a PodSpecable to a sink
3332
----
3433

34+
ifdef::openshift-enterprise[]
3535
. Optional: You can also list the available event source types in YAML format:
3636
+
3737
[source,terminal]
3838
----
3939
$ kn source list-types -o yaml
4040
----
4141
endif::[]
42-
// optional step not allowed yet for OSD due to upstream CLI issue #1385
43-
44-
ifdef::openshift-dedicated[]
45-
* List the available event source types in the terminal:
46-
+
47-
[source,terminal]
48-
----
49-
$ kn source list-types
50-
----
51-
+
52-
.Example output
53-
[source,terminal]
54-
----
55-
TYPE NAME DESCRIPTION
56-
ApiServerSource apiserversources.sources.knative.dev Watch and send Kubernetes API events to a sink
57-
PingSource pingsources.sources.knative.dev Periodically send ping events to a sink
58-
SinkBinding sinkbindings.sources.knative.dev Binding for connecting a PodSpecable to a sink
59-
----
60-
endif::[]
42+
// optional step not allowed yet for OSD due to upstream https://github.com/knative/client/issues/1385

modules/serverless-list-source-types-odc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="serverless-list-source-types-odc_{context}"]
77
= Viewing available event source types within the Developer perspective
88

9-
You can use the web console to view available event source types.
9+
It is possible to view a list of all available event source types on your cluster. Using the {product-title} web console provides a streamlined and intuitive user interface to view available event source types.
1010

1111
.Prerequisites
1212

modules/serverless-list-source.adoc

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,22 @@
66
[id="serverless-list-source_{context}"]
77
= Listing available event sources by using the Knative CLI
88

9-
You can list available event sources by using the `kn source list` command.
9+
Using the `kn` CLI provides a streamlined and intuitive user interface to view existing event sources on your cluster. You can list existing event sources by using the `kn source list` command.
1010

11+
.Prerequisites
12+
13+
* The {ServerlessOperatorName} and Knative Eventing are installed on the cluster.
14+
* You have installed the Knative (`kn`) CLI.
15+
16+
.Procedure
17+
18+
. List the existing event sources in the terminal:
19+
+
1120
[source,terminal]
1221
----
1322
$ kn source list
1423
----
15-
24+
+
1625
.Example output
1726
[source,terminal]
1827
----
@@ -22,22 +31,19 @@ b1 SinkBinding sinkbindings.sources.knative.dev ksvc:eshow3 Fa
2231
p1 PingSource pingsources.sources.knative.dev ksvc:eshow1 True
2332
----
2433

25-
[id="serverless-list-source-specific-type_{context}"]
26-
== Listing event sources of a specific type only
27-
28-
You can list event sources of a specific type only, by using the `--type` flag.
29-
34+
. Optional: You can list event sources of a specific type only, by using the `--type` flag:
35+
+
3036
[source,terminal]
3137
----
3238
$ kn source list --type <event_source_type>
3339
----
34-
40+
+
3541
.Example command
3642
[source,terminal]
3743
----
3844
$ kn source list --type PingSource
3945
----
40-
46+
+
4147
.Example output
4248
[source,terminal]
4349
----

modules/serverless-subscription-event-delivery-config.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
[id="serverless-subscription-event-delivery-config_{context}"]
88
= Configuring event delivery failure parameters using subscriptions
99

10-
Developers can configure event delivery parameters for individual subscriptions by modifying the `delivery` settings for a `Subscription` object.
10+
Knative Eventing provides configuration parameters for subscriptions that can be used to control what happens to events in cases where events fail to be delivered. You can configure event delivery parameters for individual subscriptions by modifying the `delivery` settings for a `Subscription` object.
1111

12-
.Example subscription YAML
12+
.Example `Subscription` object
1313
[source,yaml]
1414
----
1515
apiVersion: messaging.knative.dev/v1

modules/specifying-sink-flag-kn.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88

99
:_content-type: REFERENCE
1010
[id="specifying-sink-flag-kn_{context}"]
11-
= Knative CLI --sink flag
11+
= Knative CLI sink flag
1212

13-
When you create an event-producing custom resource by using the Knative (`kn`) CLI, you can specify a sink where events are sent to from that resource, by using the `--sink` flag.
13+
When you create an event source by using the Knative (`kn`) CLI, you can specify a sink where events are sent to from that resource by using the `--sink` flag. The sink can be any addressable or callable resource that can receive incoming events from other resources.
1414

1515
The following example creates a sink binding that uses a service, `\http://event-display.svc.cluster.local`, as the sink:
1616

17-
.Example command using the `--sink` flag
17+
.Example command using the sink flag
1818
[source,terminal]
1919
----
2020
$ kn source binding create bind-heartbeat \
@@ -23,5 +23,4 @@ $ kn source binding create bind-heartbeat \
2323
--sink http://event-display.svc.cluster.local \ <1>
2424
--ce-override "sink=bound"
2525
----
26-
2726
<1> `svc` in `\http://event-display.svc.cluster.local` determines that the sink is a Knative service. Other default sink prefixes include `channel`, and `broker`.

serverless/develop/serverless-event-sinks.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
A sink is an addressable custom resource (CR) that can receive incoming events from other resources. Knative services, channels, and brokers are all examples of sinks.
9+
When you create an event source, you can specify a sink where events are sent to from the source. A sink is an addressable or a callable resource that can receive incoming events from other resources. Knative services, channels and brokers are all examples of sinks.
10+
11+
Addressable objects receive and acknowledge an event delivered over HTTP to an address defined in their `status.address.url` field. As a special case, the core Kubernetes `Service` object also fulfills the addressable interface.
12+
13+
Callable objects are able to receive an event delivered over HTTP and transform the event, returning `0` or `1` new events in the HTTP response. These returned events may be further processed in the same way that events from an external event source are processed.
1014

1115
// Using --sink flag with kn (generic)
1216
include::modules/specifying-sink-flag-kn.adoc[leveloffset=+1]

serverless/develop/serverless-listing-event-sources.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can use the `kn` CLI or the *Developer* perspective in the {product-title} web console to list and manage available event sources or event source types.
9+
It is possible to view a list of all event sources or event source types that exist or are available for use on your {product-title} cluster. You can use the `kn` CLI or the *Developer* perspective in the {product-title} web console to list available event sources or event source types.
1010

1111
include::modules/serverless-list-source-types-kn.adoc[leveloffset=+1]
1212
include::modules/serverless-list-source-types-odc.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)