diff --git a/_topic_map.yml b/_topic_map.yml index 603bfac1fd39..919b1ae977a5 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -2742,10 +2742,11 @@ Topics: File: upgrading-serverless - Name: Removing OpenShift Serverless File: removing-openshift-serverless - # Admin console - - Name: Creating Eventing components as a cluster administrator + # Eventing + - Name: Creating Eventing components File: serverless-cluster-admin-eventing - - Name: Creating Serving components as a cluster administrator + # Serving + - Name: Creating Serving components File: serverless-cluster-admin-serving # Metering - Name: Using metering with OpenShift Serverless diff --git a/modules/serverless-creating-channel-admin-web-console.adoc b/modules/serverless-creating-channel-admin-web-console.adoc new file mode 100644 index 000000000000..9e2a13c4cf65 --- /dev/null +++ b/modules/serverless-creating-channel-admin-web-console.adoc @@ -0,0 +1,25 @@ +// Module included in the following assemblies: +// +// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc + +[id="serverless-creating-channel-admin-web-console_{context}"] += Creating a channel by using the Administrator perspective + +If you have cluster administrator permissions, you can create a channel by using the Administrator perspective in the web console. + +.Prerequisites + +* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster. +* You have cluster administrator permissions for {product-title}. + +.Procedure + +. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*. +. In the *Create* list, select *Channel*. You will be directed to the *Channel* page. +. Select the type of `Channel` object that you want to create from the *Type* drop-down. ++ +[NOTE] +==== +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}. +==== +. Click *Create*. diff --git a/modules/serverless-creating-event-source-admin-web-console.adoc b/modules/serverless-creating-event-source-admin-web-console.adoc new file mode 100644 index 000000000000..c91b97cfa218 --- /dev/null +++ b/modules/serverless-creating-event-source-admin-web-console.adoc @@ -0,0 +1,19 @@ +// Module included in the following assemblies: +// +// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc + +[id="serverless-creating-event-source-admin-web-console_{context}"] += Creating an event source by using the Administrator perspective + +If you have cluster administrator permissions, you can create an event source by using the Administrator perspective in the web console. + +.Prerequisites + +* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster. +* You have cluster administrator permissions for {product-title}. + +.Procedure + +. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*. +. In the *Create* list, select *Event Source*. You will be directed to the *Event Sources* page. +. Select the event source type that you want to create. diff --git a/modules/serverless-creating-subscription-admin-web-console.adoc b/modules/serverless-creating-subscription-admin-web-console.adoc new file mode 100644 index 000000000000..e01b8298aeae --- /dev/null +++ b/modules/serverless-creating-subscription-admin-web-console.adoc @@ -0,0 +1,23 @@ +// Module included in the following assemblies: +// +// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc + +[id="serverless-creating-subscription-admin-web-console_{context}"] += Creating a subscription by using the Administrator perspective + +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. + +.Prerequisites + +* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster. +* You have cluster administrator permissions for {product-title}. +* You have created a channel. +* You have created a Knative service to use as a subscriber. + +.Procedure + +. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*. +. In the *Channel* tab, select the Options menu {kebab} for the channel that you want to add a subscription to. +. Click *Add Subscription* in the list. +. 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. +. Click *Add*. diff --git a/modules/serverless-creating-trigger-admin-web-console.adoc b/modules/serverless-creating-trigger-admin-web-console.adoc new file mode 100644 index 000000000000..cdd0acc8b152 --- /dev/null +++ b/modules/serverless-creating-trigger-admin-web-console.adoc @@ -0,0 +1,23 @@ +// Module included in the following assemblies: +// +// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc + +[id="serverless-creating-trigger-admin-web-console_{context}"] += Creating a trigger by using the Administrator perspective + +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. + +.Prerequisites + +* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster. +* You have cluster administrator permissions for {product-title}. +* You have created a broker. +* You have created a Knative service to use as a subscriber. + +.Procedure + +. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*. +. In the *Broker* tab, select the Options menu {kebab} for the broker that you want to add a trigger to. +. Click *Add Trigger* in the list. +. 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. +. Click *Add*. diff --git a/modules/serverless-install-web-console.adoc b/modules/serverless-install-web-console.adoc index 6a623f4be640..1e102d589d5c 100644 --- a/modules/serverless-install-web-console.adoc +++ b/modules/serverless-install-web-console.adoc @@ -16,8 +16,8 @@ image::serverless-search.png[{ServerlessOperatorName} in the {product-title} web . Review the information about the Operator and click *Install*. . On the *Install Operator* page: -.. 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. -.. The *Installed Namespace* will be `openshift-operators`. +.. 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. +.. The *Installed Namespace* will be `openshift-serverless`. .. Select the *4.6* channel as the *Update Channel*. The *4.6* channel will enable installation of the latest stable release of the {ServerlessOperatorName}. .. Select *Automatic* or *Manual* approval strategy. . 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* -> * If it does not: . Switch to the *Catalog* -> *Operator Management* page and inspect the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors under *Status*. -. Check the logs in any pods in the `openshift-operators` project on the *Workloads* -> *Pods* page that are reporting issues to troubleshoot further. +. Check the logs in any pods in the `openshift-serverless` project on the *Workloads* -> *Pods* page that are reporting issues to troubleshoot further. diff --git a/serverless/admin_guide/serverless-cluster-admin-eventing.adoc b/serverless/admin_guide/serverless-cluster-admin-eventing.adoc index ec89305ac355..03a43c54a7e9 100644 --- a/serverless/admin_guide/serverless-cluster-admin-eventing.adoc +++ b/serverless/admin_guide/serverless-cluster-admin-eventing.adoc @@ -8,12 +8,26 @@ toc::[] 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. +// Event sources +include::modules/serverless-creating-event-source-admin-web-console.adoc[leveloffset=+1] + +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}. + // Brokers include::modules/serverless-creating-broker-admin-web-console.adoc[leveloffset=+1] include::modules/serverless-creating-broker-admin.adoc[leveloffset=+1] include::modules/serverless-deleting-broker-admin.adoc[leveloffset=+1] +// Trigger +include::modules/serverless-creating-trigger-admin-web-console.adoc[leveloffset=+1] +// Channel +include::modules/serverless-creating-channel-admin-web-console.adoc[leveloffset=+1] +// Subscription +include::modules/serverless-creating-subscription-admin-web-console.adoc[leveloffset=+1] [id="serverless-cluster-admin-eventing-additional-resources"] == Additional resources * See xref:../../serverless/event_workflows/serverless-using-brokers.adoc#serverless-using-brokers[Event delivery workflows using brokers and triggers]. +* See xref:../../serverless/event_workflows/serverless-channels.adoc#serverless-channels[Event delivery workflows using channels]. +* For information about using Apache Kafka components, see xref:../../serverless/serverless-kafka.adoc#serverless-kafka[ +Using Apache Kafka with {ServerlessProductName}].