Skip to content

Commit 4135ba0

Browse files
Merge pull request #29367 from abrennan89/RHDEVDOCS2334
[RHDEVDOCS-2334] Adding admin console eventing tasks
2 parents 59cf6c7 + 999bd4c commit 4135ba0

7 files changed

+111
-6
lines changed

_topic_map.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2752,10 +2752,11 @@ Topics:
27522752
File: upgrading-serverless
27532753
- Name: Removing OpenShift Serverless
27542754
File: removing-openshift-serverless
2755-
# Admin console
2756-
- Name: Creating Eventing components as a cluster administrator
2755+
# Eventing
2756+
- Name: Creating Eventing components
27572757
File: serverless-cluster-admin-eventing
2758-
- Name: Creating Serving components as a cluster administrator
2758+
# Serving
2759+
- Name: Creating Serving components
27592760
File: serverless-cluster-admin-serving
27602761
# Metering
27612762
- Name: Using metering with OpenShift Serverless
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc
4+
5+
[id="serverless-creating-channel-admin-web-console_{context}"]
6+
= Creating a channel by using the Administrator perspective
7+
8+
If you have cluster administrator permissions, you can create a channel by using the Administrator perspective in the web console.
9+
10+
.Prerequisites
11+
12+
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
13+
* You have cluster administrator permissions for {product-title}.
14+
15+
.Procedure
16+
17+
. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
18+
. In the *Create* list, select *Channel*. You will be directed to the *Channel* page.
19+
. Select the type of `Channel` object that you want to create from the *Type* drop-down.
20+
+
21+
[NOTE]
22+
====
23+
Currently only `InMemoryChannel` channel objects are supported by default. Kafka channels are available as a Technology Preview if you have installed Apache Kafka on {ServerlessProductName}.
24+
====
25+
. Click *Create*.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc
4+
5+
[id="serverless-creating-event-source-admin-web-console_{context}"]
6+
= Creating an event source by using the Administrator perspective
7+
8+
If you have cluster administrator permissions, you can create an event source by using the Administrator perspective in the web console.
9+
10+
.Prerequisites
11+
12+
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
13+
* You have cluster administrator permissions for {product-title}.
14+
15+
.Procedure
16+
17+
. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
18+
. In the *Create* list, select *Event Source*. You will be directed to the *Event Sources* page.
19+
. Select the event source type that you want to create.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc
4+
5+
[id="serverless-creating-subscription-admin-web-console_{context}"]
6+
= Creating a subscription by using the Administrator perspective
7+
8+
If you have cluster administrator permissions and have created a channel, you can create a subscription to connect your broker to a subscriber by using the Administrator perspective in the web console.
9+
10+
.Prerequisites
11+
12+
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
13+
* You have cluster administrator permissions for {product-title}.
14+
* You have created a channel.
15+
* You have created a Knative service to use as a subscriber.
16+
17+
.Procedure
18+
19+
. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
20+
. In the *Channel* tab, select the Options menu {kebab} for the channel that you want to add a subscription to.
21+
. Click *Add Subscription* in the list.
22+
. In the *Add Subscription* dialogue box, select a *Subscriber* for the subscription. The subscriber is the Knative service that will receive events from the channel.
23+
. Click *Add*.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc
4+
5+
[id="serverless-creating-trigger-admin-web-console_{context}"]
6+
= Creating a trigger by using the Administrator perspective
7+
8+
If you have cluster administrator permissions and have created a broker, you can create a trigger to connect your broker to a subscriber by using the Administrator perspective in the web console.
9+
10+
.Prerequisites
11+
12+
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
13+
* You have cluster administrator permissions for {product-title}.
14+
* You have created a broker.
15+
* You have created a Knative service to use as a subscriber.
16+
17+
.Procedure
18+
19+
. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
20+
. In the *Broker* tab, select the Options menu {kebab} for the broker that you want to add a trigger to.
21+
. Click *Add Trigger* in the list.
22+
. In the *Add Trigger* dialogue box, select a *Subscriber* for the trigger. The subscriber is the Knative service that will receive events from the broker.
23+
. Click *Add*.

modules/serverless-install-web-console.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ image::serverless-search.png[{ServerlessOperatorName} in the {product-title} web
1616

1717
. Review the information about the Operator and click *Install*.
1818
. On the *Install Operator* page:
19-
.. The *Installation Mode* is *All namespaces on the cluster (default)*. This mode installs the Operator in the default `openshift-operators` namespace to watch and be made available to all namespaces in the cluster.
20-
.. The *Installed Namespace* will be `openshift-operators`.
19+
.. The *Installation Mode* is *All namespaces on the cluster (default)*. This mode installs the Operator in the default `openshift-serverless` namespace to watch and be made available to all namespaces in the cluster.
20+
.. The *Installed Namespace* will be `openshift-serverless`.
2121
.. Select the *4.6* channel as the *Update Channel*. The *4.6* channel will enable installation of the latest stable release of the {ServerlessOperatorName}.
2222
.. Select *Automatic* or *Manual* approval strategy.
2323
. Click *Install* to make the Operator available to the selected namespaces on this {product-title} cluster.
@@ -32,4 +32,4 @@ After the Subscription’s upgrade status is *Up to date*, select *Catalog* -> *
3232
If it does not:
3333

3434
. Switch to the *Catalog* -> *Operator Management* page and inspect the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors under *Status*.
35-
. Check the logs in any pods in the `openshift-operators` project on the *Workloads* -> *Pods* page that are reporting issues to troubleshoot further.
35+
. Check the logs in any pods in the `openshift-serverless` project on the *Workloads* -> *Pods* page that are reporting issues to troubleshoot further.

serverless/admin_guide/serverless-cluster-admin-eventing.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,26 @@ toc::[]
88

99
If you have cluster administrator permissions on a {product-title} cluster, you can create Knative Eventing components with {ServerlessProductName} in the *Administrator* perspective of the web console or by using the `kn` and `oc` CLIs.
1010

11+
// Event sources
12+
include::modules/serverless-creating-event-source-admin-web-console.adoc[leveloffset=+1]
13+
14+
See xref:../../serverless/event_sources/knative-event-sources.adoc#knative-event-sources[Getting started with event sources] for more information on which event source types are supported and can be created using by {ServerlessProductName}.
15+
1116
// Brokers
1217
include::modules/serverless-creating-broker-admin-web-console.adoc[leveloffset=+1]
1318
include::modules/serverless-creating-broker-admin.adoc[leveloffset=+1]
1419
include::modules/serverless-deleting-broker-admin.adoc[leveloffset=+1]
20+
// Trigger
21+
include::modules/serverless-creating-trigger-admin-web-console.adoc[leveloffset=+1]
22+
// Channel
23+
include::modules/serverless-creating-channel-admin-web-console.adoc[leveloffset=+1]
24+
// Subscription
25+
include::modules/serverless-creating-subscription-admin-web-console.adoc[leveloffset=+1]
1526

1627
[id="serverless-cluster-admin-eventing-additional-resources"]
1728
== Additional resources
1829

1930
* See xref:../../serverless/event_workflows/serverless-using-brokers.adoc#serverless-using-brokers[Event delivery workflows using brokers and triggers].
31+
* See xref:../../serverless/event_workflows/serverless-channels.adoc#serverless-channels[Event delivery workflows using channels].
32+
* For information about using Apache Kafka components, see xref:../../serverless/serverless-kafka.adoc#serverless-kafka[
33+
Using Apache Kafka with {ServerlessProductName}].

0 commit comments

Comments
 (0)