Skip to content

Commit 44bf931

Browse files
abrennan89abrennan89
committed
Put serverless OSD docs live
1 parent 0fd0986 commit 44bf931

File tree

3 files changed

+185
-161
lines changed

3 files changed

+185
-161
lines changed

‎_topic_maps/_topic_map_osd.yml‎

Lines changed: 160 additions & 161 deletions
Original file line numberDiff line numberDiff line change
@@ -206,167 +206,166 @@ Topics:
206206
File: policy-understand-availability
207207
- Name: Update life cycle
208208
File: osd-life-cycle
209-
# serverless commented out til 1.21.0 release
210-
# ---
211-
# Name: Serverless
212-
# Dir: serverless
213-
# Distros: openshift-dedicated
214-
# Topics:
215-
# - Name: Release notes
216-
# File: serverless-release-notes
217-
# - Name: Discover
218-
# Dir: discover
219-
# Topics:
220-
# - Name: About OpenShift Serverless
221-
# File: about-serverless
222-
# - Name: About OpenShift Serverless Functions
223-
# File: serverless-functions-about
224-
# - Name: Event sources
225-
# File: knative-event-sources
226-
# - Name: Channels and subscriptions
227-
# File: serverless-channels
228-
# - Name: Install
229-
# Dir: install
230-
# Topics:
231-
# - Name: Installing the OpenShift Serverless Operator
232-
# File: install-serverless-operator
233-
# - Name: Installing Knative Serving
234-
# File: installing-knative-serving
235-
# - Name: Installing Knative Eventing
236-
# File: installing-knative-eventing
237-
# - Name: Removing OpenShift Serverless
238-
# File: removing-openshift-serverless
239-
# - Name: Develop
240-
# Dir: develop
241-
# Topics:
242-
# - Name: Serverless applications
243-
# File: serverless-applications
244-
# - Name: Autoscaling
245-
# File: serverless-autoscaling-developer
246-
# - Name: Traffic management
247-
# File: serverless-traffic-management
248-
# - Name: Routing
249-
# File: serverless-configuring-routes
250-
# - Name: Event sinks
251-
# File: serverless-event-sinks
252-
# - Name: Event delivery
253-
# File: serverless-event-delivery
254-
# - Name: Listing event sources and event source types
255-
# File: serverless-listing-event-sources
256-
# - Name: Creating an API server source
257-
# File: serverless-apiserversource
258-
# - Name: Creating a ping source
259-
# File: serverless-pingsource
260-
# - File: serverless-custom-event-sources
261-
# Name: Custom event sources
262-
# - Name: Creating channels
263-
# File: serverless-creating-channels
264-
# - Name: Creating subscriptions
265-
# File: serverless-subs
266-
# - Name: Brokers
267-
# File: serverless-using-brokers
268-
# - Name: Triggers
269-
# File: serverless-triggers
270-
# - Name: Knative Kafka
271-
# File: serverless-kafka-developer
272-
# - Name: Administer
273-
# Dir: admin_guide
274-
# Topics:
275-
# - Name: Configuring OpenShift Serverless
276-
# File: serverless-configuration
277-
# - Name: Configuring Knative Eventing defaults
278-
# File: serverless-configuring-eventing-defaults
279-
# - Name: Knative Kafka
280-
# File: serverless-kafka-admin
281-
# - Name: Creating Knative Eventing components in the Administrator perspective
282-
# File: serverless-cluster-admin-eventing
283-
# - Name: Creating Knative Serving components in the Administrator perspective
284-
# File: serverless-cluster-admin-serving
285-
# - Name: Configuring the Knative Serving custom resource
286-
# File: knative-serving-CR-config
287-
# - Name: Autoscaling
288-
# File: serverless-admin-autoscaling
289-
# - Name: Integrating Service Mesh with OpenShift Serverless
290-
# File: serverless-ossm-setup
291-
# - Name: Monitoring serverless components
292-
# File: serverless-admin-monitoring
293-
# - Name: Metrics
294-
# File: serverless-admin-metrics
295-
# - Name: High availability on OpenShift Serverless
296-
# File: serverless-ha
297-
# - Name: Monitor
298-
# Dir: monitor
299-
# Topics:
300-
# - Name: Cluster logging with OpenShift Serverless
301-
# File: cluster-logging-serverless
302-
# - Name: Tracing requests using Jaeger
303-
# File: serverless-tracing
304-
# - Name: Metrics
305-
# File: serverless-serving-metrics
306-
# - Name: Monitoring Knative services
307-
# File: serverless-service-monitoring
308-
# - Name: Autoscaling dashboard
309-
# File: serverless-autoscaling-dashboard
310-
# - Name: Support
311-
# File: serverless-support
312-
# - Name: Security
313-
# Dir: security
314-
# Topics:
315-
# - Name: Configuring JSON Web Token authentication for Knative services
316-
# File: serverless-ossm-with-kourier-jwt
317-
# - Name: Configuring a custom domain for a Knative service
318-
# File: serverless-custom-domains
319-
# - Name: Using a custom TLS certificate for domain mapping
320-
# File: serverless-custom-tls-cert-domain-mapping
321-
# - Name: Security configuration for Knative Kafka
322-
# File: serverless-kafka-security
323-
# - Name: Functions
324-
# Dir: functions
325-
# Topics:
326-
# - Name: Setting up OpenShift Serverless Functions
327-
# File: serverless-functions-setup
328-
# - Name: Getting started with functions
329-
# File: serverless-functions-getting-started
330-
# - Name: Developing Node.js functions
331-
# File: serverless-developing-nodejs-functions
332-
# - Name: Developing TypeScript functions
333-
# File: serverless-developing-typescript-functions
334-
# - Name: Developing Golang functions
335-
# File: serverless-developing-go-functions
336-
# - Name: Developing Python functions
337-
# File: serverless-developing-python-functions
338-
# - Name: Developing Quarkus functions
339-
# File: serverless-developing-quarkus-functions
340-
# - Name: Using functions with Knative Eventing
341-
# File: serverless-functions-eventing
342-
# - Name: Function project configuration in func.yaml
343-
# File: serverless-functions-yaml
344-
# - Name: Accessing secrets and config maps from functions
345-
# File: serverless-functions-accessing-secrets-configmaps
346-
# - Name: Adding annotations to functions
347-
# File: serverless-functions-annotations
348-
# - Name: Functions development reference guide
349-
# File: serverless-functions-reference-guide
350-
# - Name: CLI tools
351-
# Dir: cli_tools
352-
# Topics:
353-
# - Name: Installing the Knative CLI
354-
# File: installing-kn
355-
# - Name: Knative CLI advanced configuration
356-
# File: advanced-kn-config
357-
# - Name: Reference
358-
# Dir: reference
359-
# Topics:
360-
# - Name: Knative CLI flags
361-
# File: kn-flags-reference
362-
# - Name: Knative Serving CLI commands
363-
# File: kn-serving-ref
364-
# - Name: Knative Eventing CLI commands
365-
# File: kn-eventing-ref
366-
# - Name: Functions commands
367-
# File: kn-func-ref
368-
# - Name: kn event
369-
# File: kn-event-ref
209+
---
210+
Name: Serverless
211+
Dir: serverless
212+
Distros: openshift-dedicated
213+
Topics:
214+
- Name: Release notes
215+
File: serverless-release-notes
216+
- Name: Discover
217+
Dir: discover
218+
Topics:
219+
- Name: About OpenShift Serverless
220+
File: about-serverless
221+
- Name: About OpenShift Serverless Functions
222+
File: serverless-functions-about
223+
- Name: Event sources
224+
File: knative-event-sources
225+
- Name: Channels and subscriptions
226+
File: serverless-channels
227+
- Name: Install
228+
Dir: install
229+
Topics:
230+
- Name: Installing the OpenShift Serverless Operator
231+
File: install-serverless-operator
232+
- Name: Installing Knative Serving
233+
File: installing-knative-serving
234+
- Name: Installing Knative Eventing
235+
File: installing-knative-eventing
236+
- Name: Removing OpenShift Serverless
237+
File: removing-openshift-serverless
238+
- Name: Develop
239+
Dir: develop
240+
Topics:
241+
- Name: Serverless applications
242+
File: serverless-applications
243+
- Name: Autoscaling
244+
File: serverless-autoscaling-developer
245+
- Name: Traffic management
246+
File: serverless-traffic-management
247+
- Name: Routing
248+
File: serverless-configuring-routes
249+
- Name: Event sinks
250+
File: serverless-event-sinks
251+
- Name: Event delivery
252+
File: serverless-event-delivery
253+
- Name: Listing event sources and event source types
254+
File: serverless-listing-event-sources
255+
- Name: Creating an API server source
256+
File: serverless-apiserversource
257+
- Name: Creating a ping source
258+
File: serverless-pingsource
259+
- File: serverless-custom-event-sources
260+
Name: Custom event sources
261+
- Name: Creating channels
262+
File: serverless-creating-channels
263+
- Name: Creating subscriptions
264+
File: serverless-subs
265+
- Name: Brokers
266+
File: serverless-using-brokers
267+
- Name: Triggers
268+
File: serverless-triggers
269+
- Name: Knative Kafka
270+
File: serverless-kafka-developer
271+
- Name: Administer
272+
Dir: admin_guide
273+
Topics:
274+
- Name: Configuring OpenShift Serverless
275+
File: serverless-configuration
276+
- Name: Configuring Knative Eventing defaults
277+
File: serverless-configuring-eventing-defaults
278+
- Name: Knative Kafka
279+
File: serverless-kafka-admin
280+
- Name: Creating Knative Eventing components in the Administrator perspective
281+
File: serverless-cluster-admin-eventing
282+
- Name: Creating Knative Serving components in the Administrator perspective
283+
File: serverless-cluster-admin-serving
284+
- Name: Configuring the Knative Serving custom resource
285+
File: knative-serving-CR-config
286+
- Name: Autoscaling
287+
File: serverless-admin-autoscaling
288+
- Name: Integrating Service Mesh with OpenShift Serverless
289+
File: serverless-ossm-setup
290+
- Name: Monitoring serverless components
291+
File: serverless-admin-monitoring
292+
- Name: Metrics
293+
File: serverless-admin-metrics
294+
- Name: High availability on OpenShift Serverless
295+
File: serverless-ha
296+
- Name: Monitor
297+
Dir: monitor
298+
Topics:
299+
- Name: Cluster logging with OpenShift Serverless
300+
File: cluster-logging-serverless
301+
- Name: Tracing requests using Jaeger
302+
File: serverless-tracing
303+
- Name: Metrics
304+
File: serverless-serving-metrics
305+
- Name: Monitoring Knative services
306+
File: serverless-service-monitoring
307+
- Name: Autoscaling dashboard
308+
File: serverless-autoscaling-dashboard
309+
- Name: Support
310+
File: serverless-support
311+
- Name: Security
312+
Dir: security
313+
Topics:
314+
- Name: Configuring JSON Web Token authentication for Knative services
315+
File: serverless-ossm-with-kourier-jwt
316+
- Name: Configuring a custom domain for a Knative service
317+
File: serverless-custom-domains
318+
- Name: Using a custom TLS certificate for domain mapping
319+
File: serverless-custom-tls-cert-domain-mapping
320+
- Name: Security configuration for Knative Kafka
321+
File: serverless-kafka-security
322+
- Name: Functions
323+
Dir: functions
324+
Topics:
325+
- Name: Setting up OpenShift Serverless Functions
326+
File: serverless-functions-setup
327+
- Name: Getting started with functions
328+
File: serverless-functions-getting-started
329+
- Name: Developing Node.js functions
330+
File: serverless-developing-nodejs-functions
331+
- Name: Developing TypeScript functions
332+
File: serverless-developing-typescript-functions
333+
- Name: Developing Golang functions
334+
File: serverless-developing-go-functions
335+
- Name: Developing Python functions
336+
File: serverless-developing-python-functions
337+
- Name: Developing Quarkus functions
338+
File: serverless-developing-quarkus-functions
339+
- Name: Using functions with Knative Eventing
340+
File: serverless-functions-eventing
341+
- Name: Function project configuration in func.yaml
342+
File: serverless-functions-yaml
343+
- Name: Accessing secrets and config maps from functions
344+
File: serverless-functions-accessing-secrets-configmaps
345+
- Name: Adding annotations to functions
346+
File: serverless-functions-annotations
347+
- Name: Functions development reference guide
348+
File: serverless-functions-reference-guide
349+
- Name: CLI tools
350+
Dir: cli_tools
351+
Topics:
352+
- Name: Installing the Knative CLI
353+
File: installing-kn
354+
- Name: Knative CLI advanced configuration
355+
File: advanced-kn-config
356+
- Name: Reference
357+
Dir: reference
358+
Topics:
359+
- Name: Knative CLI flags
360+
File: kn-flags-reference
361+
- Name: Knative Serving CLI commands
362+
File: kn-serving-ref
363+
- Name: Knative Eventing CLI commands
364+
File: kn-eventing-ref
365+
- Name: Functions commands
366+
File: kn-func-ref
367+
- Name: kn event
368+
File: kn-event-ref
370369
---
371370
Name: Support
372371
Dir: support

‎modules/serverless-creating-broker-labeling.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Brokers created using this method are not removed if you remove the label. You m
1919
* You have installed the `oc` CLI.
2020
* 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}.
2121
22+
ifdef::openshift-dedicated[]
23+
* You have cluster or dedicated administrator permissions.
24+
endif::[]
25+
2226
.Procedure
2327

2428
* Label a namespace with `eventing.knative.dev/injection=enabled`:

‎modules/serverless-list-source-types-kn.adoc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ You can list event source types that can be created and used on your cluster by
1515
1616
.Procedure
1717

18+
ifdef::openshift-enterprise[]
1819
. List the available event source types in the terminal:
1920
+
2021
[source,terminal]
@@ -37,3 +38,23 @@ SinkBinding sinkbindings.sources.knative.dev Binding for co
3738
----
3839
$ kn source list-types -o yaml
3940
----
41+
endif::[]
42+
// optional step not allowed yet for OSD due to upstream CLI issue #1385
43+
44+
ifdef::openshift-dedicated[]
45+
* List the available event source types in the terminal:
46+
+
47+
[source,terminal]
48+
----
49+
$ kn source list-types
50+
----
51+
+
52+
.Example output
53+
[source,terminal]
54+
----
55+
TYPE NAME DESCRIPTION
56+
ApiServerSource apiserversources.sources.knative.dev Watch and send Kubernetes API events to a sink
57+
PingSource pingsources.sources.knative.dev Periodically send ping events to a sink
58+
SinkBinding sinkbindings.sources.knative.dev Binding for connecting a PodSpecable to a sink
59+
----
60+
endif::[]

0 commit comments

Comments
 (0)