Skip to content

Commit 4add08e

Browse files
authored
Merge pull request #32644 from abrennan89/SRVKE-801
[srvls][SRVKE-801] Add KafkaChannel note to docs
2 parents e7aaa85 + 63ce67f commit 4add08e

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

modules/serverless-create-kafka-channel-yaml.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ spec:
2828
numPartitions: 3
2929
replicationFactor: 1
3030
----
31+
+
32+
[IMPORTANT]
33+
====
34+
Only the `v1beta1` version of the API for `KafkaChannel` objects on {ServerlessProductName} is supported. Do not use the `v1alpha1` version of this API, as this version is now deprecated.
35+
====
3136
. Apply the YAML file:
3237
+
3338
[source,terminal]

modules/serverless-kafka-source-yaml.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,23 @@ You can create a Kafka event source by using YAML.
2121
apiVersion: sources.knative.dev/v1beta1
2222
kind: KafkaSource
2323
metadata:
24-
name: <source-name>
24+
name: <source_name>
2525
spec:
26-
consumerGroup: <group-name> <1>
26+
consumerGroup: <group_name> <1>
2727
bootstrapServers:
28-
- <list-of-bootstrap-servers>
28+
- <list_of_bootstrap_servers>
2929
topics:
30-
- <list-of-topics> <2>
30+
- <list_of_topics> <2>
3131
sink:
3232
----
3333
<1> A consumer group is a group of consumers that use the same group ID, and consume data from a topic.
3434
<2> A topic provides a destination for the storage of data. Each topic is split into one or more partitions.
3535
+
36+
[IMPORTANT]
37+
====
38+
Only the `v1beta1` version of the API for `KafkaSource` objects on {ServerlessProductName} is supported. Do not use the `v1alpha1` version of this API, as this version is now deprecated.
39+
====
40+
+
3641
.Example `KafkaSource` object
3742
[source,yaml]
3843
----

modules/serverless-rn-1-14-0.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
+
1919
[IMPORTANT]
2020
====
21-
Only the `v1beta1` version of the API for Knative Kafka on {ServerlessProductName} is supported. Do not use the `v1alpha1` version of the API, as this is deprecated.
21+
Only the `v1beta1` version of the APIs for `KafkaChannel` and `KafkaSource` objects on {ServerlessProductName} are supported. Do not use the `v1alpha1` version of these APIs, as this version is now deprecated.
2222
====
2323
* The Operator channel for installing and upgrading {ServerlessProductName} has been updated to `stable` for {product-title} 4.6 and newer versions.
2424
* {ServerlessProductName} is now supported on IBM Power Systems, IBM Z, and LinuxONE, except for the following features, which are not yet supported:

0 commit comments

Comments
 (0)