Skip to content

Commit 654b18a

Browse files
committed
SRVCOM-1451: Add serving docs for OSD
1 parent 111be88 commit 654b18a

16 files changed

+277
-105
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 127 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -207,105 +207,133 @@ Topics:
207207
- Name: Update life cycle
208208
File: osd-life-cycle
209209
# 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: Event sinks
243-
# File: serverless-event-sinks
244-
# - Name: Event delivery
245-
# File: serverless-event-delivery
246-
# - Name: Creating an API server source
247-
# File: serverless-apiserversource
248-
# - Name: Creating a ping source
249-
# File: serverless-pingsource
250-
# - File: serverless-custom-event-sources
251-
# Name: Custom event sources
252-
# - Name: Creating channels
253-
# File: serverless-creating-channels
254-
# - Name: Creating subscriptions
255-
# File: serverless-subs
256-
# Brokers
257-
# - Name: Brokers
258-
# File: serverless-using-brokers
259-
# Triggers
260-
# - Name: Triggers
261-
# File: serverless-triggers
262-
# - Name: Knative Kafka
263-
# File: serverless-kafka-developer
264-
# Admin guide
265-
#- Name: Administer
266-
# Dir: admin_guide
267-
# Topics:
268-
# - Name: Configuring Knative Eventing defaults
269-
# File: serverless-configuring-eventing-defaults
270-
# - Name: Knative Kafka
271-
# File: serverless-kafka-admin
272-
# - Name: High availability on OpenShift Serverless
273-
# File: serverless-ha
274-
# Functions
275-
#- Name: Functions
276-
# Dir: functions
277-
# Topics:
278-
# - Name: Setting up OpenShift Serverless Functions
279-
# File: serverless-functions-setup
280-
# - Name: Getting started with functions
281-
# File: serverless-functions-getting-started
282-
# - Name: Developing Node.js functions
283-
# File: serverless-developing-nodejs-functions
284-
# - Name: Developing TypeScript functions
285-
# File: serverless-developing-typescript-functions
286-
# - Name: Developing Golang functions
287-
# File: serverless-developing-go-functions
288-
# - Name: Developing Python functions
289-
# File: serverless-developing-python-functions
290-
# - Name: Developing Quarkus functions
291-
# File: serverless-developing-quarkus-functions
292-
# - Name: Using functions with Knative Eventing
293-
# File: serverless-functions-eventing
294-
# - Name: Function project configuration in func.yaml
295-
# File: serverless-functions-yaml
296-
# - Name: Accessing secrets and config maps from functions
297-
# File: serverless-functions-accessing-secrets-configmaps
298-
# - Name: Adding annotations to functions
299-
# File: serverless-functions-annotations
300-
# - Name: Functions development reference guide
301-
# File: serverless-functions-reference-guide
302-
#- Name: CLI tools
303-
# Dir: cli_tools
304-
# Topics:
305-
# - Name: Installing the Knative CLI
306-
# File: installing-kn
307-
# - Name: Knative CLI advanced configuration
308-
# File: advanced-kn-config
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: Creating an API server source
255+
# File: serverless-apiserversource
256+
# - Name: Creating a ping source
257+
# File: serverless-pingsource
258+
# - File: serverless-custom-event-sources
259+
# Name: Custom event sources
260+
# - Name: Creating channels
261+
# File: serverless-creating-channels
262+
# - Name: Creating subscriptions
263+
# File: serverless-subs
264+
# - Name: Brokers
265+
# File: serverless-using-brokers
266+
# - Name: Triggers
267+
# File: serverless-triggers
268+
# - Name: Knative Kafka
269+
# File: serverless-kafka-developer
270+
# # Admin guide
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: High availability on OpenShift Serverless
289+
# File: serverless-ha
290+
# - Name: Support
291+
# File: serverless-support
292+
# - Name: Security
293+
# Dir: security
294+
# Topics:
295+
# - Name: Configuring JSON Web Token authentication for Knative services
296+
# File: serverless-ossm-with-kourier-jwt
297+
# - Name: Configuring a custom domain for a Knative service
298+
# File: serverless-custom-domains
299+
# - Name: Using a custom TLS certificate for domain mapping
300+
# File: serverless-custom-tls-cert-domain-mapping
301+
# - Name: Security configuration for Knative Kafka
302+
# File: serverless-kafka-security
303+
# - Name: Functions
304+
# Dir: functions
305+
# Topics:
306+
# - Name: Setting up OpenShift Serverless Functions
307+
# File: serverless-functions-setup
308+
# - Name: Getting started with functions
309+
# File: serverless-functions-getting-started
310+
# - Name: Developing Node.js functions
311+
# File: serverless-developing-nodejs-functions
312+
# - Name: Developing TypeScript functions
313+
# File: serverless-developing-typescript-functions
314+
# - Name: Developing Golang functions
315+
# File: serverless-developing-go-functions
316+
# - Name: Developing Python functions
317+
# File: serverless-developing-python-functions
318+
# - Name: Developing Quarkus functions
319+
# File: serverless-developing-quarkus-functions
320+
# - Name: Using functions with Knative Eventing
321+
# File: serverless-functions-eventing
322+
# - Name: Function project configuration in func.yaml
323+
# File: serverless-functions-yaml
324+
# - Name: Accessing secrets and config maps from functions
325+
# File: serverless-functions-accessing-secrets-configmaps
326+
# - Name: Adding annotations to functions
327+
# File: serverless-functions-annotations
328+
# - Name: Functions development reference guide
329+
# File: serverless-functions-reference-guide
330+
# - Name: CLI tools
331+
# Dir: cli_tools
332+
# Topics:
333+
# - Name: Installing the Knative CLI
334+
# File: installing-kn
335+
# - Name: Knative CLI advanced configuration
336+
# File: advanced-kn-config
309337
---
310338
Name: Support
311339
Dir: support

modules/serverless-creating-broker-admin-web-console.adoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,25 @@
66
[id="serverless-creating-broker-admin-web-console_{context}"]
77
= Creating a broker by using the Administrator perspective
88

9-
If you have cluster administrator permissions, you can create a broker by using the Administrator perspective in the web console.
9+
ifdef::openshift-enterprise[]
10+
If you have cluster administrator permissions, you can create a broker by using the *Administrator* perspective in the web console.
11+
endif::[]
12+
13+
ifdef::openshift-dedicated[]
14+
If you have cluster or dedicated administrator permissions, you can create a broker by using the *Administrator* perspective in the web console.
15+
endif::[]
1016

1117
.Prerequisites
1218

1319
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
20+
21+
ifdef::openshift-enterprise[]
1422
* You have cluster administrator permissions for {product-title}.
23+
endif::[]
24+
25+
ifdef::openshift-dedicated[]
26+
* You have cluster or dedicated administrator permissions for {product-title}.
27+
endif::[]
1528

1629
.Procedure
1730

modules/serverless-creating-channel-admin-web-console.adoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,25 @@
66
[id="serverless-creating-channel-admin-web-console_{context}"]
77
= Creating a channel by using the Administrator perspective
88

9-
If you have cluster administrator permissions, you can create a channel by using the Administrator perspective in the web console.
9+
ifdef::openshift-enterprise[]
10+
If you have cluster administrator permissions, you can create a channel by using the *Administrator* perspective in the web console.
11+
endif::[]
12+
13+
ifdef::openshift-dedicated[]
14+
If you have cluster or dedicated administrator permissions, you can create a channel by using the *Administrator* perspective in the web console.
15+
endif::[]
1016

1117
.Prerequisites
1218

1319
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
20+
21+
ifdef::openshift-enterprise[]
1422
* You have cluster administrator permissions for {product-title}.
23+
endif::[]
24+
25+
ifdef::openshift-dedicated[]
26+
* You have cluster or dedicated administrator permissions for {product-title}.
27+
endif::[]
1528

1629
.Procedure
1730

modules/serverless-creating-event-source-admin-web-console.adoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,25 @@
66
[id="serverless-creating-event-source-admin-web-console_{context}"]
77
= Creating an event source by using the Administrator perspective
88

9-
If you have cluster administrator permissions, you can create an event source by using the Administrator perspective in the web console.
9+
ifdef::openshift-enterprise[]
10+
If you have cluster administrator permissions, you can create an event source by using the *Administrator* perspective in the web console.
11+
endif::[]
12+
13+
ifdef::openshift-dedicated[]
14+
If you have cluster or dedicated administrator permissions, you can create an event source by using the *Administrator* perspective in the web console.
15+
endif::[]
1016

1117
.Prerequisites
1218

1319
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
20+
21+
ifdef::openshift-enterprise[]
1422
* You have cluster administrator permissions for {product-title}.
23+
endif::[]
24+
25+
ifdef::openshift-dedicated[]
26+
* You have cluster or dedicated administrator permissions for {product-title}.
27+
endif::[]
1528

1629
.Procedure
1730

modules/serverless-creating-subscription-admin-web-console.adoc

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,26 @@
66
[id="serverless-creating-subscription-admin-web-console_{context}"]
77
= Creating a subscription by using the Administrator perspective
88

9-
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+
ifdef::openshift-enterprise[]
10+
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.
11+
endif::[]
12+
13+
ifdef::openshift-dedicated[]
14+
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.
15+
endif::[]
1016

1117
.Prerequisites
1218

1319
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
20+
21+
ifdef::openshift-enterprise[]
1422
* You have cluster administrator permissions for {product-title}.
23+
endif::[]
24+
25+
ifdef::openshift-dedicated[]
26+
* You have cluster or dedicated administrator permissions for {product-title}.
27+
endif::[]
28+
1529
* You have created a channel.
1630
* You have created a Knative service to use as a subscriber.
1731

modules/serverless-creating-trigger-admin-web-console.adoc

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,26 @@
66
[id="serverless-creating-trigger-admin-web-console_{context}"]
77
= Creating a trigger by using the Administrator perspective
88

9-
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+
ifdef::openshift-enterprise[]
10+
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.
11+
endif::[]
12+
13+
ifdef::openshift-dedicated[]
14+
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.
15+
endif::[]
1016

1117
.Prerequisites
1218

1319
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
20+
21+
ifdef::openshift-enterprise[]
1422
* You have cluster administrator permissions for {product-title}.
23+
endif::[]
24+
25+
ifdef::openshift-dedicated[]
26+
* You have cluster or dedicated administrator permissions for {product-title}.
27+
endif::[]
28+
1529
* You have created a broker.
1630
* You have created a Knative service to use as a subscriber.
1731

modules/serverless-domain-mapping-odc-admin.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,13 @@
66
[id="serverless-domain-mapping-odc-admin_{context}"]
77
= Mapping a custom domain to a service by using the Administrator perspective
88

9+
ifdef::openshift-enterprise[]
910
If you have cluster administrator permissions, you can create a `DomainMapping` custom resource (CR) by using the *Administrator* perspective in the {product-title} web console.
11+
endif::[]
12+
13+
ifdef::openshift-dedicated[]
14+
If you have cluster or dedicated administrator permissions, you can create a `DomainMapping` custom resource (CR) by using the *Administrator* perspective in the {product-title} web console.
15+
endif::[]
1016

1117
.Prerequisites
1218

0 commit comments

Comments
 (0)