Merge pull request #46320 from abrennan89/SRVCOM-1829

abrennan89 · web-flow · commit 18062d55f357 · 2022-06-08T10:52:18.000-05:00
[SRVCOM-1829] Update abstracts and structure for admin console topics
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -3442,11 +3442,8 @@ Topics:
     # Eventing
   - Name: Knative Kafka
     File: serverless-kafka-admin
-  - Name: Creating Knative Eventing components in the Administrator perspective
-    File: serverless-cluster-admin-eventing
-    # Serving
-  - Name: Creating Knative Serving components in the Administrator perspective
-    File: serverless-cluster-admin-serving
+  - Name: Serverless components in the Administrator perspective
+    File: serverless-admin-perspective
   - Name: Autoscaling
     File: serverless-admin-autoscaling
     # Ingress options
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -284,10 +284,8 @@ Topics:
     File: serverless-configuration
   - Name: Knative Kafka
     File: serverless-kafka-admin
-  - Name: Creating Knative Eventing components in the Administrator perspective
-    File: serverless-cluster-admin-eventing
-  - Name: Creating Knative Serving components in the Administrator perspective
-    File: serverless-cluster-admin-serving
+  - Name: Serverless components in the Administrator perspective
+    File: serverless-admin-perspective
   - Name: Autoscaling
     File: serverless-admin-autoscaling
   - Name: Integrating Service Mesh with OpenShift Serverless
diff --git a/modules/creating-serverless-apps-admin-console.adoc b/modules/creating-serverless-apps-admin-console.adoc
@@ -6,6 +6,10 @@
 [id="creating-serverless-apps-admin-console_{context}"]
 = Creating serverless applications using the Administrator perspective
 
+include::snippets/serverless-apps.adoc[]
+
+After the service is created and the application is deployed, Knative creates an immutable revision for this version of the application. Knative also performs network programming to create a route, ingress, service, and load balancer for your application and automatically scales your pods up and down based on traffic.
+
 .Prerequisites
 
 To create serverless applications using the *Administrator* perspective, ensure that you have completed the following steps.
diff --git a/modules/serverless-creating-broker-admin-web-console.adoc b/modules/serverless-creating-broker-admin-web-console.adoc
@@ -6,18 +6,14 @@
 [id="serverless-creating-broker-admin-web-console_{context}"]
 = Creating a broker by using the Administrator perspective
 
-ifdef::openshift-enterprise[]
-If you have cluster administrator permissions, you can create a broker by using the *Administrator* perspective in the web console.
-endif::[]
-
-ifdef::openshift-dedicated[]
-If you have cluster or dedicated administrator permissions, you can create a broker by using the *Administrator* perspective in the web console.
-endif::[]
+include::snippets/serverless-brokers-intro.adoc[]
 
 .Prerequisites
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 
+* You have logged in to the web console and are in the *Administrator* perspective.
+
 ifdef::openshift-enterprise[]
 * You have cluster administrator permissions for {product-title}.
 endif::[]
diff --git a/modules/serverless-creating-channel-admin-web-console.adoc b/modules/serverless-creating-channel-admin-web-console.adoc
@@ -6,18 +6,14 @@
 [id="serverless-creating-channel-admin-web-console_{context}"]
 = Creating a channel by using the Administrator perspective
 
-ifdef::openshift-enterprise[]
-If you have cluster administrator permissions, you can create a channel by using the *Administrator* perspective in the web console.
-endif::[]
-
-ifdef::openshift-dedicated[]
-If you have cluster or dedicated administrator permissions, you can create a channel by using the *Administrator* perspective in the web console.
-endif::[]
+include::snippets/serverless-channels-intro.adoc[]
 
 .Prerequisites
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 
+* You have logged in to the web console and are in the *Administrator* perspective.
+
 ifdef::openshift-enterprise[]
 * You have cluster administrator permissions for {product-title}.
 endif::[]
diff --git a/modules/serverless-creating-event-source-admin-web-console.adoc b/modules/serverless-creating-event-source-admin-web-console.adoc
@@ -6,18 +6,14 @@
 [id="serverless-creating-event-source-admin-web-console_{context}"]
 = Creating an event source by using the Administrator perspective
 
-ifdef::openshift-enterprise[]
-If you have cluster administrator permissions, you can create an event source by using the *Administrator* perspective in the web console.
-endif::[]
-
-ifdef::openshift-dedicated[]
-If you have cluster or dedicated administrator permissions, you can create an event source by using the *Administrator* perspective in the web console.
-endif::[]
+A Knative _event source_ can be any Kubernetes object that generates or imports cloud events, and relays those events to another endpoint, known as a _sink_. Sourcing events is critical to developing a distributed system that reacts to events.
 
 .Prerequisites
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 
+* You have logged in to the web console and are in the *Administrator* perspective.
+
 ifdef::openshift-enterprise[]
 * You have cluster administrator permissions for {product-title}.
 endif::[]
diff --git a/modules/serverless-creating-subscription-admin-web-console.adoc b/modules/serverless-creating-subscription-admin-web-console.adoc
@@ -6,18 +6,14 @@
 [id="serverless-creating-subscription-admin-web-console_{context}"]
 = Creating a subscription by using the Administrator perspective
 
-ifdef::openshift-enterprise[]
-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.
-endif::[]
-
-ifdef::openshift-dedicated[]
-If you have cluster or dedicated 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.
-endif::[]
+After you have created a channel and an event sink, also known as a _subscriber_, you can create a subscription to enable event delivery. Subscriptions are created by configuring a `Subscription` object, which specifies the channel and the subscriber to deliver events to. You can also specify some subscriber-specific options, such as how to handle failures.
 
 .Prerequisites
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 
+* You have logged in to the web console and are in the *Administrator* perspective.
+
 ifdef::openshift-enterprise[]
 * You have cluster administrator permissions for {product-title}.
 endif::[]
@@ -26,13 +22,14 @@ ifdef::openshift-dedicated[]
 * You have cluster or dedicated administrator permissions for {product-title}.
 endif::[]
 
-* You have created a channel.
+* You have created a Knative 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.
+. In the *Add Subscription* dialogue box, select a *Subscriber* for the subscription. The subscriber is the Knative service that receives 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
@@ -6,18 +6,14 @@
 [id="serverless-creating-trigger-admin-web-console_{context}"]
 = Creating a trigger by using the Administrator perspective
 
-ifdef::openshift-enterprise[]
-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.
-endif::[]
-
-ifdef::openshift-dedicated[]
-If you have cluster or dedicated 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.
-endif::[]
+include::snippets/serverless-brokers-intro.adoc[]
 
 .Prerequisites
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 
+* You have logged in to the web console and are in the *Administrator* perspective.
+
 ifdef::openshift-enterprise[]
 * You have cluster administrator permissions for {product-title}.
 endif::[]
@@ -26,7 +22,8 @@ ifdef::openshift-dedicated[]
 * You have cluster or dedicated administrator permissions for {product-title}.
 endif::[]
 
-* You have created a broker.
+* You have created a Knative broker.
+
 * You have created a Knative service to use as a subscriber.
 
 .Procedure
diff --git a/serverless/admin_guide/serverless-admin-perspective.adoc b/serverless/admin_guide/serverless-admin-perspective.adoc
@@ -1,18 +1,17 @@
 :_content-type: ASSEMBLY
 include::_attributes/common-attributes.adoc[]
-[id="serverless-cluster-admin-eventing"]
-= Creating Eventing components in the Administrator perspective
-:context: serverless-cluster-admin-eventing
+[id="serverless-admin-perspective"]
+= {ServerlessProductShortName} components in the Administrator perspective
+:context: serverless-admin-perspective
 
 toc::[]
 
-You can create Knative Eventing components with {ServerlessProductName} in the *Administrator* perspective of the web console.
+If you do not want to switch to the *Developer* perspective in the {product-title} web console or use the Knative (`kn`) CLI or YAML files, you can create Knative components by using the *Administator* perspective of the {product-title} web console.
 
+// Create services as an admin
+include::modules/creating-serverless-apps-admin-console.adoc[leveloffset=+1]
 // Event sources
 include::modules/serverless-creating-event-source-admin-web-console.adoc[leveloffset=+1]
-
-See xref:../../serverless/discover/knative-event-sources.adoc#knative-event-sources[Event sources] for more information about which event source types are supported and can be created by using {ServerlessProductName}.
-
 // Brokers
 include::modules/serverless-creating-broker-admin-web-console.adoc[leveloffset=+1]
 // Trigger
@@ -25,6 +24,8 @@ include::modules/serverless-creating-subscription-admin-web-console.adoc[levelof
 [id="additional-resources_serverless-cluster-admin-eventing"]
 [role="_additional-resources"]
 == Additional resources
+* xref:../../serverless/develop/serverless-applications.adoc#serverless-applications[Serverless applications]
+* xref:../../serverless/discover/knative-event-sources.adoc#knative-event-sources[Event sources]
 * xref:../../serverless/develop/serverless-using-brokers.adoc#serverless-using-brokers[Brokers]
 * xref:../../serverless/develop/serverless-triggers.adoc#serverless-triggers[Triggers]
 * xref:../../serverless/discover/serverless-channels.adoc#serverless-channels[Channels and subscriptions]
diff --git a/serverless/admin_guide/serverless-cluster-admin-serving.adoc b/serverless/admin_guide/serverless-cluster-admin-serving.adoc
diff --git a/serverless/develop/serverless-applications.adoc b/serverless/develop/serverless-applications.adoc
@@ -6,29 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-Serverless applications are created and deployed as Kubernetes services, defined by a route and a configuration, and contained in a YAML file. To deploy a serverless application using {ServerlessProductName}, you must create a Knative `Service` object.
-
-.Example Knative `Service` object YAML file
-[source,yaml]
-----
-apiVersion: serving.knative.dev/v1
-kind: Service
-metadata:
-  name: hello <1>
-  namespace: default <2>
-spec:
-  template:
-    spec:
-      containers:
-        - image: docker.io/openshift/hello-openshift <3>
-          env:
-            - name: RESPONSE <4>
-              value: "Hello Serverless!"
-----
-<1> The name of the application.
-<2> The namespace the application uses.
-<3> The image of the application.
-<4> The environment variable printed out by the sample application.
+include::snippets/serverless-apps.adoc[]
 
 You can create a serverless application by using one of the following methods:
 
diff --git a/snippets/serverless-apps.adoc b/snippets/serverless-apps.adoc
@@ -0,0 +1,30 @@
+// Text snippet included in the following modules and assemblies:
+//
+// * /serverless/develop/serverless-applications.adoc
+// * /modules/creating-serverless-apps-admin-console.adoc
+
+:_content-type: SNIPPET
+
+Serverless applications are created and deployed as Kubernetes services, defined by a route and a configuration, and contained in a YAML file. To deploy a serverless application using {ServerlessProductName}, you must create a Knative `Service` object.
+
+.Example Knative `Service` object YAML file
+[source,yaml]
+----
+apiVersion: serving.knative.dev/v1
+kind: Service
+metadata:
+  name: hello <1>
+  namespace: default <2>
+spec:
+  template:
+    spec:
+      containers:
+        - image: docker.io/openshift/hello-openshift <3>
+          env:
+            - name: RESPONSE <4>
+              value: "Hello Serverless!"
+----
+<1> The name of the application.
+<2> The namespace the application uses.
+<3> The image of the application.
+<4> The environment variable printed out by the sample application.
diff --git a/snippets/serverless-brokers-intro.adoc b/snippets/serverless-brokers-intro.adoc
@@ -1,7 +1,9 @@
-// Text snippet included in the following modules:
+// Text snippet included in the following modules and assemblies:
 //
 // * /serverless/develop/serverless-using-brokers.adoc
 // * /serverless/develop/serverless-triggers.adoc
+// * /modules/serverless-creating-broker-admin-web-console.adoc
+// * /modules/serverless-creating-trigger-admin-web-console.adoc
 
 :_content-type: SNIPPET
 
diff --git a/snippets/serverless-channels-intro.adoc b/snippets/serverless-channels-intro.adoc
@@ -7,4 +7,4 @@ Channels are custom resources that define a single event-forwarding and persiste
 
 image::serverless-event-channel-workflow.png[Channel workflow overview]
 
-You can create channels by instantiating a supported `Channel` object, and configure xref:../../serverless/develop/serverless-event-delivery.adoc#serverless-event-delivery[re-delivery attempts] by modifying the `delivery` spec in a `Subscription` object.
+You can create channels by instantiating a supported `Channel` object, and configure re-delivery attempts by modifying the `delivery` spec in a `Subscription` object.
