Merge pull request #41667 from abrennan89/020922-3

SRVCOM-1288 + SRVCOM-1664: Clean up attributes, prereqs

Author: abrennan89

_topic_maps/_topic_map.yml

@@ -3212,7 +3212,7 @@ Topics:
     File: serverless-event-delivery
   - Name: Using the API server source
     File: serverless-apiserversource
-  - Name: Using a ping source
+  - Name: Creating a ping source
     File: serverless-pingsource
   - File: serverless-custom-event-sources
     Name: Custom event sources

modules/deleting-pingsource-kn.adoc

@@ -1,13 +1,18 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-pingsource.adoc
+
 :_content-type: PROCEDURE
 [id="serverless-pingsource-kn_{context}"]
 = Creating a ping source by using the Knative CLI
 
-The following procedure describes how to create a basic ping source by using the `kn` CLI.
+You can use the following procedure to create a ping source by using the `kn` CLI.
 
 .Prerequisites
 
-* You have Knative Serving and Eventing installed.
-* You have the `kn` CLI installed.
+* The {ServerlessOperatorName}, Knative Serving and Knative Eventing are installed on the cluster.
+* You have installed the `kn` CLI.
+* 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}.
 
 .Procedure
 
@@ -19,6 +24,7 @@ service that dumps incoming messages to the service logs:
 $ kn service create event-display \
     --image quay.io/openshift-knative/knative-eventing-sources-event-display:latest
 ----
+
 . For each set of ping events that you want to request, create a ping source in the same namespace as the event consumer:
 +
 [source,terminal]
@@ -28,6 +34,7 @@ $ kn source ping create test-ping-source \
     --data '{"message": "Hello world!"}' \
     --sink ksvc:event-display
 ----
+
 . Check that the controller is mapped correctly by entering the following command and inspecting the output:
 +
 [source,terminal]
@@ -73,6 +80,7 @@ The example shown in this guide creates a ping source that sends a message every
 ----
 $ watch oc get pods
 ----
+
 . Cancel watching the pods using Ctrl+C, then look at the logs of the created pod:
 +
 [source,terminal]
@@ -97,3 +105,12 @@ Data,
     "message": "Hello world!"
   }
 ----
+
+.Deleting the ping source
+
+* Delete the ping source:
++
+[source,terminal]
+----
+$ kn delete pingsources.sources.knative.dev <ping_source_name>
+----

modules/deleting-pingsource-yaml.adoc

@@ -1,22 +1,24 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-pingsource.adoc
+
 :_content-type: PROCEDURE
 [id="serverless-pingsource-odc_{context}"]
-= Creating a ping source using the Developer perspective
+= Creating a ping source by using the web console
 
-You can create and verify a basic ping source from the {product-title} web console.
+You can use the following procedure to create a ping source by using the {product-title} web console.
 
 .Prerequisites
 
-To create a ping source using the *Developer* perspective, ensure that:
-
-* The {ServerlessOperatorName}, Knative Serving, and Knative Eventing are installed on your {product-title} cluster.
-* You have logged in to the web console.
-* You are in the *Developer* perspective.
+* You have logged in to the {product-title} web console.
+* The {ServerlessOperatorName}, Knative Serving and Knative Eventing are installed on the cluster.
 * 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}.
 
 .Procedure
 
 . To verify that the ping source is working, create a simple Knative
 service that dumps incoming messages to the logs of the service.
+
 .. In the *Developer* perspective, navigate to *+Add* -> *YAML*.
 .. Copy the example YAML:
 +
@@ -32,10 +34,10 @@ spec:
       containers:
         - image: quay.io/openshift-knative/knative-eventing-sources-event-display:latest
 ----
-
 .. Click *Create*.
 
 . Create a ping source in the same namespace as the service created in the previous step, or any other sink that you want to send events to.
+
 .. In the *Developer* perspective, navigate to *+Add* -> *Event Source*. The  *Event Sources* page is displayed.
 .. Optional: If you have multiple providers for your event sources, select the required provider from the *Providers* list to filter the available event sources from the provider.
 .. Select *Ping Source* and then click *Create Event Source*. The *Create Event Source* page is displayed.
@@ -57,3 +59,8 @@ You can verify that the ping source was created and is connected to the sink by
 . View the ping source and sink.
 +
 image::verify-pingsource-ODC.png[View the ping source and service in the Topology view]
+
+.Deleting the ping source
+
+. Navigate to the *Topology* view.
+. Right-click the API server source and select *Delete Ping Source*.

modules/serverless-pingsource-kn.adoc

@@ -1,28 +1,23 @@
 // Module included in the following assemblies:
 //
-// * serverless/event_sources/serverless-pingsource.adoc
+// * /serverless/develop/serverless-pingsource.adoc
 
 :_content-type: PROCEDURE
 [id="serverless-pingsource-yaml_{context}"]
-= Using a ping source with YAML
+= Creating a ping source by using YAML
 
 The following sections describe how to create a basic ping source using YAML files.
 
 .Prerequisites
 
-* You have Knative Serving and Eventing installed.
-
-[NOTE]
-====
-The following procedure requires you to create YAML files.
-
-If you change the names of the YAML files from those used in the examples, you must ensure that you also update the corresponding CLI commands.
-====
+* The {ServerlessOperatorName}, Knative Serving and Knative Eventing are installed on the cluster.
+* 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}.
 
 .Procedure
 
 . To verify that the ping source is working, create a simple Knative
 service that dumps incoming messages to the service's logs.
+
 .. Copy the example YAML into a file named `service.yaml`:
 +
 [source,yaml]
@@ -37,7 +32,6 @@ spec:
       containers:
         - image: quay.io/openshift-knative/knative-eventing-sources-event-display:latest
 ----
-
 .. Create the service:
 +
 [source,terminal]
@@ -46,6 +40,7 @@ $ oc apply --filename service.yaml
 ----
 
 . For each set of ping events that you want to request, create a ping source in the same namespace as the event consumer.
+
 .. Copy the example YAML into a file named `ping-source.yaml`:
 +
 [source,yaml]
@@ -63,7 +58,6 @@ spec:
       kind: Service
       name: event-display
 ----
-
 .. Create the ping source:
 +
 [source,terminal]
@@ -143,3 +137,18 @@ Data,
     "message": "Hello world!"
   }
 ----
+
+.Deleting the ping source
+
+* Delete the ping source:
++
+[source,terminal]
+----
+$ oc delete -f <ping_source_yaml_filename>
+----
++
+.Example command
+[source,terminal]
+----
+$ oc delete -f ping-source.yaml
+----

modules/serverless-pingsource-odc.adoc

@@ -1,6 +1,6 @@
 :_content-type: ASSEMBLY
 [id="serverless-pingsource"]
-= Using a ping source
+= Creating a ping source
 :context: serverless-pingsource
 include::modules/serverless-document-attributes.adoc[]
 include::modules/common-attributes.adoc[]
@@ -37,7 +37,5 @@ include::modules/serverless-pingsource-odc.adoc[leveloffset=+1]
 // kn commands
 include::modules/serverless-pingsource-kn.adoc[leveloffset=+1]
 include::modules/specifying-sink-flag-kn.adoc[leveloffset=+2]
-include::modules/deleting-pingsource-kn.adoc[leveloffset=+1]
 // YAML
 include::modules/serverless-pingsource-yaml.adoc[leveloffset=+1]
-include::modules/deleting-pingsource-yaml.adoc[leveloffset=+1]

modules/serverless-pingsource-yaml.adoc

@@ -19,5 +19,4 @@ include::modules/serverless-kn-containersource.adoc[leveloffset=+2]
 include::modules/apiserversource-kn.adoc[leveloffset=+2]
 include::modules/apiserversource-kn-delete.adoc[leveloffset=+2]
 include::modules/serverless-pingsource-kn.adoc[leveloffset=+2]
-include::modules/deleting-pingsource-kn.adoc[leveloffset=+2]
 include::modules/serverless-kafka-source-kn.adoc[leveloffset=+2]