Skip to content

Commit d60254c

Browse files
abrennan89abrennan89
committed
SRVCOM-1451: Add serverless docs for OSD
1 parent c7fae1c commit d60254c

9 files changed

+134
-0
lines changed

‎_topic_maps/_topic_map_osd.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,60 @@ Topics:
202202
File: policy-understand-availability
203203
- Name: Update life cycle
204204
File: osd-life-cycle
205+
# serverless commented out til 1.21.0 release
206+
#---
207+
#Name: Serverless
208+
#Dir: serverless
209+
#Distros: openshift-dedicated
210+
#Topics:
211+
#- Name: Release notes
212+
# File: serverless-release-notes
213+
#- Name: Discover
214+
# Dir: discover
215+
# Topics:
216+
# - Name: About OpenShift Serverless
217+
# File: about-serverless
218+
# - Name: Event sources
219+
# File: knative-event-sources
220+
# - Name: Channels and subscriptions
221+
# File: serverless-channels
222+
#- Name: CLI tools
223+
# Dir: cli_tools
224+
# Topics:
225+
# - Name: Knative CLI advanced configuration
226+
# File: advanced-kn-config
227+
#- Name: Develop
228+
# Dir: develop
229+
# Topics:
230+
# - Name: Event sinks
231+
# File: serverless-event-sinks
232+
# - Name: Event delivery
233+
# File: serverless-event-delivery
234+
# - Name: Creating an API server source
235+
# File: serverless-apiserversource
236+
# - Name: Creating a ping source
237+
# File: serverless-pingsource
238+
# - File: serverless-custom-event-sources
239+
# Name: Custom event sources
240+
# - Name: Creating channels
241+
# File: serverless-creating-channels
242+
# - Name: Creating subscriptions
243+
# File: serverless-subs
244+
# Brokers
245+
# - Name: Brokers
246+
# File: serverless-using-brokers
247+
# Triggers
248+
# - Name: Triggers
249+
# File: serverless-triggers
250+
# - Name: Knative Kafka
251+
# File: serverless-kafka-developer
252+
#- Name: Administer
253+
# Dir: admin_guide
254+
# Topics:
255+
# - Name: Configuring Knative Eventing defaults
256+
# File: serverless-configuring-eventing-defaults
257+
# - Name: Knative Kafka
258+
# File: serverless-kafka-admin
205259
---
206260
Name: Support
207261
Dir: support

‎modules/serverless-channel-default.adoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,14 @@ You can make changes to the `knative-eventing` namespace config maps, including
1212

1313
.Prerequisites
1414

15+
ifdef::openshift-enterprise[]
1516
* You have cluster administrator permissions on {product-title}.
17+
endif::[]
18+
19+
ifdef::openshift-dedicated[]
20+
* You have cluster or dedicated administrator permissions on {product-title}.
21+
endif::[]
22+
1623
* You have installed the {ServerlessOperatorName} and Knative Eventing on your cluster.
1724
1825
.Procedure

‎modules/serverless-install-kafka-odc.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,17 @@ The `replicationFactor` value must be less than or equal to the number of nodes
4646

4747
* You have installed the {ServerlessOperatorName} and Knative Eventing on your cluster.
4848
* You have access to a Red Hat AMQ Streams cluster.
49+
50+
// OCP
51+
ifdef::openshift-enterprise[]
4952
* You have cluster administrator permissions on {product-title}.
53+
endif::[]
54+
55+
// OSD
56+
ifdef::openshift-dedicated[]
57+
* You have cluster or dedicated administrator permissions on {product-title}.
58+
endif::[]
59+
5060
* You are logged in to the {product-title} web console.
5161
5262
.Procedure

‎modules/serverless-kafka-broker-sasl-default-config.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,25 @@
66
[id="serverless-kafka-broker-sasl-default-config_{context}"]
77
= Configuring SASL authentication for Kafka brokers
88

9+
// OCP
10+
ifdef::openshift-enterprise[]
911
As a cluster administrator, you can set up _Simple Authentication and Security Layer_ (SASL) authentication for Kafka brokers by modifying the `KnativeKafka` custom resource (CR).
1012

1113
.Prerequisites
1214

1315
* You have cluster administrator permissions on {product-title}.
16+
endif::[]
17+
18+
// OSD
19+
ifdef::openshift-dedicated[]
20+
As a cluster or dedicated administrator, you can set up _Simple Authentication and Security Layer_ (SASL) authentication for Kafka brokers by modifying the `KnativeKafka` custom resource (CR).
21+
22+
.Prerequisites
23+
24+
* You have cluster or dedicated administrator permissions on {product-title}.
25+
endif::[]
26+
27+
// universal
1428
* The {ServerlessOperatorName}, Knative Eventing, and the `KnativeKafka` CR are installed on your {product-title} cluster.
1529
* 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}.
1630
* You have a username and password for a Kafka cluster.

‎modules/serverless-kafka-broker-tls-default-config.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,25 @@
66
[id="serverless-kafka-broker-tls-default-config_{context}"]
77
= Configuring TLS authentication for Kafka brokers
88

9+
// OCP
10+
ifdef::openshift-enterprise[]
911
As a cluster administrator, you can set up _Transport Layer Security_ (TLS) authentication for Kafka brokers by modifying the `KnativeKafka` custom resource (CR).
1012

1113
.Prerequisites
1214

1315
* You have cluster administrator permissions on {product-title}.
16+
endif::[]
17+
18+
// OSD
19+
ifdef::openshift-dedicated[]
20+
As a cluster or dedicated administrator, you can set up _Transport Layer Security_ (TLS) authentication for Kafka brokers by modifying the `KnativeKafka` custom resource (CR).
21+
22+
.Prerequisites
23+
24+
* You have cluster or dedicated administrator permissions on {product-title}.
25+
endif::[]
26+
27+
// universal
1428
* The {ServerlessOperatorName}, Knative Eventing, and the `KnativeKafka` CR are installed on your {product-title} cluster.
1529
* 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}.
1630
* You have a Kafka cluster CA certificate stored as a `.pem` file.

‎serverless/admin_guide/serverless-configuring-eventing-defaults.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
:_content-type: ASSEMBLY
12
[id="serverless-configuring-eventing-defaults"]
23
= Configuring Knative Eventing defaults
34
include::modules/common-attributes.adoc[]
@@ -6,6 +7,13 @@ include::modules/serverless-document-attributes.adoc[]
67

78
toc::[]
89

10+
ifdef::openshift-enterprise[]
911
If you have cluster administrator permissions, you can set default options for Knative Eventing components, either for the whole cluster or for a specific namespace.
12+
endif::[]
13+
14+
ifdef::openshift-dedicated[]
15+
If you have cluster or dedicated administrator permissions, you can set default options for Knative Eventing components, either for the whole cluster or for a specific namespace.
16+
endif::[]
17+
1018

1119
include::modules/serverless-channel-default.adoc[leveloffset=+1]

‎serverless/admin_guide/serverless-kafka-admin.adoc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,20 @@ include::modules/serverless-document-attributes.adoc[]
77

88
toc::[]
99

10+
// OCP
11+
ifdef::openshift-enterprise[]
1012
In addition to the Knative Eventing components that are provided as part of a core {ServerlessProductName} installation, cluster administrators can install the `KnativeKafka` custom resource (CR).
1113

1214
[NOTE]
1315
====
1416
Knative Kafka is not currently supported for IBM Z and IBM Power.
1517
====
18+
endif::[]
19+
20+
// OSD
21+
ifdef::openshift-dedicated[]
22+
In addition to the Knative Eventing components that are provided as part of a core {ServerlessProductName} installation, cluster or dedicated administrators can install the `KnativeKafka` custom resource (CR).
23+
endif::[]
1624

1725
The `KnativeKafka` CR provides users with additional options, such as:
1826

@@ -28,7 +36,15 @@ include::modules/serverless-install-kafka-odc.adoc[leveloffset=+1]
2836
[id="serverless-kafka-admin-default-configs"]
2937
== Configuring default settings for Kafka components
3038

39+
// OCP
40+
ifdef::openshift-enterprise[]
3141
If you have cluster administrator permissions, you can set default options for Knative Kafka components, either for the whole cluster or for a specific namespace.
42+
endif::[]
43+
44+
// OSD
45+
ifdef::openshift-dedicated[]
46+
If you have cluster or dedicated administrator permissions, you can set default options for Knative Kafka components, either for the whole cluster or for a specific namespace.
47+
endif::[]
3248

3349
include::modules/serverless-kafka-broker-tls-default-config.adoc[leveloffset=+2]
3450
include::modules/serverless-kafka-broker-sasl-default-config.adoc[leveloffset=+2]

‎serverless/discover/about-serverless.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,12 @@ You can propagate an event from an xref:../../serverless/discover/knative-event-
3131

3232
The set of supported features, configurations, and integrations for {ServerlessProductName}, current and past versions, are available at the link:https://access.redhat.com/articles/4912821[Supported Configurations page].
3333

34+
// only included for OCP currently until CRD docs are available in OSD
35+
ifdef::openshift-online[]
3436
[id="additional-resources_about-serverless"]
3537
== Additional resources
3638

3739
* For more information about CRDs, see xref:../../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Extending the Kubernetes API with custom resource definitions].
3840

3941
* For more information about CRs, see xref:../../operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Managing resources from custom resource definitions].
42+
endif::[]

‎serverless/serverless-release-notes.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,18 @@ include::modules/serverless-api-versions.adoc[leveloffset=+1]
2222

2323
// Deprecated and removed feature trackers
2424
// OCP
25+
ifdef::openshift-enterprise[]
2526
include::modules/serverless-deprecated-removed-features.adoc[leveloffset=+1]
27+
endif::[]
28+
// Add OSD
2629

2730
// Release notes included, most to least recent
31+
// OCP + OSD
2832
// include::modules/serverless-rn-1-21-0.adoc[leveloffset=+1]
33+
34+
// OCP only
35+
ifdef::openshift-enterprise[]
2936
include::modules/serverless-rn-1-20-0.adoc[leveloffset=+1]
3037
include::modules/serverless-rn-1-19-0.adoc[leveloffset=+1]
3138
include::modules/serverless-rn-1-18-0.adoc[leveloffset=+1]
39+
endif::[]

0 commit comments

Comments
 (0)