Skip to content

Commit 78c5b95

Browse files
authored
Merge pull request #41712 from abrennan89/021022
SRVCOM-1288 + SRVCOM-1664: Clean up attributes, prereqs
2 parents 535aad7 + dfe2612 commit 78c5b95

28 files changed

+189
-156
lines changed

_topic_maps/_topic_map.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3181,7 +3181,7 @@ Topics:
31813181
File: serverless-functions-about
31823182
- Name: Event sources
31833183
File: knative-event-sources
3184-
- Name: Channels
3184+
- Name: Channels and subscriptions
31853185
File: serverless-channels
31863186
- Name: Install
31873187
Dir: install
@@ -3218,9 +3218,9 @@ Topics:
32183218
File: serverless-pingsource
32193219
- File: serverless-custom-event-sources
32203220
Name: Custom event sources
3221-
- Name: Creating and deleting channels
3221+
- Name: Creating channels
32223222
File: serverless-creating-channels
3223-
- Name: Subscriptions
3223+
- Name: Creating subscriptions
32243224
File: serverless-subs
32253225
# Brokers
32263226
- Name: Brokers

modules/serverless-containersource-guidelines.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/develop/serverless-custom-event-sources.adoc
4+
5+
:_content-type: REFERENCE
16
[id="serverless-containersource-guidelines_{context}"]
27
= Guidelines for creating a container image
38

modules/serverless-containersource-reference.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/develop/serverless-custom-event-sources.adoc
4+
5+
:_content-type: REFERENCE
16
[id="serverless-containersource-reference_{context}"]
27
= Container source reference
38

modules/serverless-create-channel-kn.adoc

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/develop/serverless-creating-channels.adoc
4+
15
:_content-type: PROCEDURE
26
[id="serverless-create-channel-kn_{context}"]
37
= Creating a channel by using the Knative CLI
@@ -6,9 +10,7 @@ You can create a channel with the cluster default configuration by using the `kn
610

711
.Prerequisites
812

9-
To create channels using the `kn` CLI, ensure that:
10-
11-
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
13+
* The {ServerlessOperatorName} and Knative Eventing are installed on the cluster.
1214
* You have installed the `kn` CLI.
1315
* 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}.
1416
@@ -51,3 +53,12 @@ kn channel list
5153
NAME TYPE URL AGE READY REASON
5254
mychannel InMemoryChannel http://mychannel-kn-channel.default.svc.cluster.local 93s True
5355
----
56+
57+
.Deleting a channel
58+
59+
* Delete a channel:
60+
+
61+
[source,terminal]
62+
----
63+
$ kn channel delete <channel_name>
64+
----

modules/serverless-create-channel-odc.adoc

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
11
// Module included in the following assemblies:
22
//
3-
// * serverless/knative_eventing/serverless-creating-channels.adoc
3+
// * /serverless/develop/serverless-creating-channels.adoc
44

55
:_content-type: PROCEDURE
66
[id="serverless-create-channel-odc_{context}"]
7-
= Creating a channel using the Developer perspective
7+
= Creating a channel by using the web console
88

9-
You can create a channel with the cluster default configuration by using the {product-title} web console.
9+
You can create a channel by using the {product-title} web console.
1010

1111
.Prerequisites
12-
To create channels using the *Developer* perspective ensure that:
1312

13+
* You have logged in to the {product-title} web console.
1414
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
15-
* You have logged in to the web console.
1615
* 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}.
1716
1817
.Procedure
1918

2019
. In the *Developer* perspective, navigate to *+Add* -> *Channel*.
2120
. Select the type of `Channel` object that you want to create from the *Type* drop-down.
22-
+
23-
[NOTE]
24-
====
25-
Currently only InMemoryChannel type `Channel` objects are supported.
26-
====
2721
. Click *Create*.
2822

2923
.Verification

modules/serverless-create-default-channel-yaml.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
11
// Module included in the following assemblies:
22
//
3-
// * serverless/channels/serverless-creating-channels.adoc
3+
// * /serverless/develop/serverless-creating-channels.adoc
44

55
:_content-type: PROCEDURE
66
[id="serverless-create-default-channel-yaml_{context}"]
77
= Creating a default implementation channel by using YAML
88

9-
You can create a channel by using YAML with the cluster default configuration.
9+
You can create a channel with the cluster default configuration by using YAML.
1010

1111
.Prerequisites
1212

13-
* {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
13+
* The {ServerlessOperatorName} and Knative Eventing are installed on the cluster.
14+
* You have installed the `oc` CLI.
1415
* 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}.
1516
1617
.Procedure
1718

18-
To create a `Channel` object:
19-
20-
. Create a YAML file and copy the following sample code into it:
19+
. Create a `Channel` object as a YAML file:
2120
+
2221
[source,yaml]
2322
----
@@ -27,6 +26,7 @@ metadata:
2726
name: example-channel
2827
namespace: default
2928
----
29+
3030
. Apply the YAML file:
3131
+
3232
[source,terminal]

modules/serverless-create-kafka-channel-yaml.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ You can create a Kafka channel by using YAML to create the `KafkaChannel` object
1212
.Prerequisites
1313

1414
* The {ServerlessOperatorName}, Knative Eventing, and the `KnativeKafka` custom resource are installed on your {product-title} cluster.
15+
* You have installed the `oc` CLI.
1516
* 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}.
1617
1718
.Procedure

modules/serverless-creating-subscriptions-kn.adoc

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/develop/serverless-subs.adoc
4+
15
:_content-type: PROCEDURE
26
[id="serverless-creating-subscriptions-kn_{context}"]
3-
= Creating subscriptions by using the Knative CLI
7+
= Creating a subscription by using the Knative CLI
48

59
You can create a subscription to connect a channel to a sink by using the `kn` CLI.
610

711
.Prerequisites
812

9-
To create subscriptions using the `kn` CLI, ensure that:
10-
1113
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
1214
* You have installed the `kn` CLI.
1315
* 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}.
@@ -57,3 +59,12 @@ $ kn subscription list
5759
NAME CHANNEL SUBSCRIBER REPLY DEAD LETTER SINK READY REASON
5860
mysubscription Channel:mychannel ksvc:event-display True
5961
----
62+
63+
.Deleting a subscription
64+
65+
* Delete a subscription:
66+
+
67+
[source,terminal]
68+
----
69+
$ kn subscription delete <subscription_name>
70+
----

modules/serverless-creating-subscriptions-odc.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
// Module included in the following assemblies:
22
//
3-
// * serverless/channel/serverless-subs.adoc
3+
// * /serverless/develop/serverless-subs.adoc
44

55
:_content-type: PROCEDURE
66
[id="serverless-creating-subscriptions-odc_{context}"]
7-
= Creating subscriptions in the Developer perspective
7+
= Creating a subscription by using the web console
8+
9+
You can create a subscription to connect a channel to a sink by using the {product-title} web console.
810

911
.Prerequisites
10-
To create subscriptions using the *Developer* perspective, ensure that:
1112

1213
* The {ServerlessOperatorName}, Knative Serving, and Knative Eventing are installed on your {product-title} cluster.
1314
* You have logged in to the web console.
14-
* 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}.
1515
* You have created an event sink, such as a Knative service, and a channel.
16+
* 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}.
1617
1718
.Procedure
19+
1820
. In the *Developer* perspective, navigate to the *Topology* page.
21+
1922
. Create a subscription using one of the following methods:
23+
2024
.. Hover over the channel that you want to create a subscription for, and drag the arrow. The *Add Subscription* option is displayed.
2125
+
2226
image::create-sub-ODC.png[Create a subscription for the channel]
@@ -25,10 +29,8 @@ image::create-sub-ODC.png[Create a subscription for the channel]
2529
... Click *Add*.
2630
.. If the service is available in the *Topology* view under the same namespace or project as the channel, click on the channel that you want to create a subscription for, and drag the arrow directly to a service to immediately create a subscription from the channel to that service.
2731

28-
2932
.Verification
33+
3034
* After the subscription has been created, you can see it represented as a line that connects the channel to the service in the *Topology* view:
3135
+
3236
image::verify-subscription-odc.png[Subscription in the Topology view]
33-
+
34-
You can view the event source, channel, and subscriptions for the sink by clicking on the service.

modules/serverless-creating-subscriptions-yaml.adoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
// Module included in the following assemblies:
22
//
3-
// * serverless/channels/serverless-subs.adoc
3+
// * /serverless/develop/serverless-subs.adoc
44

55
:_content-type: PROCEDURE
66
[id="serverless-creating-subscriptions-yaml_{context}"]
7-
= Creating subscriptions by using YAML
7+
= Creating a subscription by using YAML
88

99
You can create a subscription to connect a channel to a sink by using YAML.
1010

11+
.Prerequisites
12+
13+
* The {ServerlessOperatorName} and Knative Eventing are installed on the cluster.
14+
* You have installed the `oc` CLI.
15+
* 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}.
16+
1117
.Procedure
1218

13-
* Create a `Subscription` object.
19+
* Create a `Subscription` object:
1420
** Create a YAML file and copy the following sample code into it:
1521
+
1622
[source,yaml]

0 commit comments

Comments
 (0)