Skip to content

Commit 2e73ce1

Browse files
authored
Merge pull request #58597 from gabriel-rh/SRVKE-1421-renaming-kafka-broker-2
SRVKE-1421 rename Knative Kafka
2 parents 3bbcd7c + 88bec16 commit 2e73ce1

File tree

45 files changed

+89
-86
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+89
-86
lines changed

_topic_maps/_topic_map.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3846,7 +3846,7 @@ Topics:
38463846
File: installing-knative-serving
38473847
- Name: Installing Knative Eventing
38483848
File: installing-knative-eventing
3849-
- Name: Configuring Knative Kafka
3849+
- Name: Configuring Knative for Apache Kafka
38503850
File: serverless-kafka-admin
38513851
- Name: Configuring Serverless Functions
38523852
File: configuring-serverless-functions
@@ -3976,7 +3976,7 @@ Topics:
39763976
File: serverless-apiserversource
39773977
- Name: Creating a ping source
39783978
File: serverless-pingsource
3979-
- Name: Kafka source
3979+
- Name: Source for Apache Kafka
39803980
File: serverless-kafka-developer-source
39813981
- Name: Custom event sources
39823982
File: serverless-custom-event-sources
@@ -3989,7 +3989,7 @@ Topics:
39893989
File: serverless-event-sinks
39903990
- Name: Creating event sinks
39913991
File: serverless-creating-sinks
3992-
- Name: Kafka sink
3992+
- Name: Sink for Apache Kafka
39933993
File: serverless-kafka-developer-sink
39943994
- Name: Brokers
39953995
Dir: brokers
@@ -4004,7 +4004,7 @@ Topics:
40044004
File: serverless-broker-backing-channel-default
40054005
- Name: Configuring the default broker class
40064006
File: serverless-global-config-broker-class-default
4007-
- Name: Kafka broker
4007+
- Name: Knative broker for Apache Kafka
40084008
File: kafka-broker
40094009
- Name: Managing brokers
40104010
File: serverless-using-brokers-managing-brokers
@@ -4040,7 +4040,7 @@ Topics:
40404040
File: connecting-channels-sinks
40414041
- Name: Default channel implementation
40424042
File: serverless-channel-default
4043-
- Name: Security configuration for Knative Kafka channels
4043+
- Name: Security configuration for channels
40444044
File: serverless-kafka-admin-security-channels
40454045
- Name: Subscriptions
40464046
Dir: subscriptions

_topic_maps/_topic_map_osd.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ Topics:
399399
File: installing-knative-serving
400400
- Name: Installing Knative Eventing
401401
File: installing-knative-eventing
402-
- Name: Configuring Knative Kafka
402+
- Name: Configuring Knative for Apache Kafka
403403
File: serverless-kafka-admin
404404
- Name: Configuring Serverless Functions
405405
File: configuring-serverless-functions
@@ -529,7 +529,7 @@ Topics:
529529
File: serverless-apiserversource
530530
- Name: Creating a ping source
531531
File: serverless-pingsource
532-
- Name: Kafka source
532+
- Name: Source for Apache Kafka
533533
File: serverless-kafka-developer-source
534534
- Name: Custom event sources
535535
File: serverless-custom-event-sources
@@ -542,7 +542,7 @@ Topics:
542542
File: serverless-event-sinks
543543
- Name: Creating event sinks
544544
File: serverless-creating-sinks
545-
- Name: Kafka sink
545+
- Name: Sink for Apache Kafka
546546
File: serverless-kafka-developer-sink
547547
- Name: Brokers
548548
Dir: brokers
@@ -557,7 +557,7 @@ Topics:
557557
File: serverless-broker-backing-channel-default
558558
- Name: Configuring the default broker class
559559
File: serverless-global-config-broker-class-default
560-
- Name: Kafka broker
560+
- Name: Knative broker for Apache Kafka
561561
File: kafka-broker
562562
- Name: Managing brokers
563563
File: serverless-using-brokers-managing-brokers
@@ -593,7 +593,7 @@ Topics:
593593
File: connecting-channels-sinks
594594
- Name: Default channel implementation
595595
File: serverless-channel-default
596-
- Name: Security configuration for Knative Kafka channels
596+
- Name: Security configuration for channels
597597
File: serverless-kafka-admin-security-channels
598598
- Name: Subscriptions
599599
Dir: subscriptions

_topic_maps/_topic_map_rosa.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ Topics:
594594
File: installing-knative-serving
595595
- Name: Installing Knative Eventing
596596
File: installing-knative-eventing
597-
- Name: Configuring Knative Kafka
597+
- Name: Configuring Knative for Apache Kafka
598598
File: serverless-kafka-admin
599599
- Name: Configuring Serverless Functions
600600
File: configuring-serverless-functions
@@ -724,7 +724,7 @@ Topics:
724724
File: serverless-apiserversource
725725
- Name: Creating a ping source
726726
File: serverless-pingsource
727-
- Name: Kafka source
727+
- Name: Source for Apache Kafka
728728
File: serverless-kafka-developer-source
729729
- Name: Custom event sources
730730
File: serverless-custom-event-sources
@@ -737,7 +737,7 @@ Topics:
737737
File: serverless-event-sinks
738738
- Name: Creating event sinks
739739
File: serverless-creating-sinks
740-
- Name: Kafka sink
740+
- Name: Sink for Apache Kafka
741741
File: serverless-kafka-developer-sink
742742
- Name: Brokers
743743
Dir: brokers
@@ -752,7 +752,7 @@ Topics:
752752
File: serverless-broker-backing-channel-default
753753
- Name: Configuring the default broker class
754754
File: serverless-global-config-broker-class-default
755-
- Name: Kafka broker
755+
- Name: Knative broker for Apache Kafka
756756
File: kafka-broker
757757
- Name: Managing brokers
758758
File: serverless-using-brokers-managing-brokers
@@ -788,7 +788,7 @@ Topics:
788788
File: connecting-channels-sinks
789789
- Name: Default channel implementation
790790
File: serverless-channel-default
791-
- Name: Security configuration for Knative Kafka channels
791+
- Name: Security configuration for channels
792792
File: serverless-kafka-admin-security-channels
793793
- Name: Subscriptions
794794
Dir: subscriptions

modules/serverless-channel-default.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
* You have administrator permissions on {product-title}.
1212
* You have installed the {ServerlessOperatorName} and Knative Eventing on your cluster.
13-
* If you want to use Kafka channels as the default channel implementation, you must also install the `KnativeKafka` CR on your cluster.
13+
* If you want to use Knative channels for Apache Kafka as the default channel implementation, you must also install the `KnativeKafka` CR on your cluster.
1414
1515
.Procedure
1616

modules/serverless-config-replicas-kafka.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_content-type: PROCEDURE
66
[id="serverless-config-replicas-kafka_{context}"]
7-
= Configuring high availability replicas for Knative Kafka
7+
= Configuring high availability replicas for the Knative broker implementation for Apache Kafka
88

9-
High availability (HA) is available by default for the Knative Kafka `kafka-controller` and `kafka-webhook-eventing` components, which are configured to have two each replicas by default. You can change the number of replicas for these components by modifying the `spec.high-availability.replicas` value in the `KnativeKafka` custom resource (CR).
9+
High availability (HA) is available by default for the Knative broker implementation for Apache Kafka components `kafka-controller` and `kafka-webhook-eventing`, which are configured to have two each replicas by default. You can change the number of replicas for these components by modifying the `spec.high-availability.replicas` value in the `KnativeKafka` custom resource (CR).
1010

1111
.Prerequisites
1212

@@ -18,7 +18,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
1818
* You have access to an {product-title} account with cluster administrator or dedicated administrator access.
1919
endif::[]
2020

21-
* The {ServerlessOperatorName} and Knative Kafka are installed on your cluster.
21+
* The {ServerlessOperatorName} and Knative broker for Apache Kafka are installed on your cluster.
2222
2323
.Procedure
2424

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:_content-type: PROCEDURE
77
[id="serverless-create-kafka-channel-yaml_{context}"]
8-
= Creating a Kafka channel by using YAML
8+
= Creating a channel for Apache Kafka by using YAML
99

1010
Creating Knative resources by using YAML files uses a declarative API, which enables you to describe channels declaratively and in a reproducible manner. You can create a Knative Eventing channel that is backed by Kafka topics by creating a Kafka channel. To create a Kafka channel by using YAML, you must create a YAML file that defines a `KafkaChannel` object, then apply it by using the `oc apply` command.
1111

modules/serverless-creating-a-kafka-event-sink.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@
44

55
:_content-type: PROCEDURE
66
[id="serverless-creating-a-kafka-event-sink_{context}"]
7-
= Creating a Kafka sink by using the {product-title} web console
7+
= Creating an event sink for Apache Kafka by using the {product-title} web console
88

99
You can create a Kafka sink that sends events to a Kafka topic by using the *Developer* perspective in the {product-title} web console. By default, a Kafka sink uses the binary content mode, which is more efficient than the structured mode.
1010

11+
12+
As a developer, you can create an event sink to receive events from a particular source and send them to a Kafka topic.
13+
1114
.Prerequisites
1215

13-
* You have installed the {ServerlessOperatorName}, with Knative Serving, Knative Eventing, and Knative Kafka APIs, from the OperatorHub.
16+
* You have installed the {ServerlessOperatorName}, with Knative Serving, Knative Eventing, and Knative broker for Apache Kafka APIs, from the OperatorHub.
1417
* You have created a Kafka topic in your Kafka environment.
1518
1619
.Procedure

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ endif::[]
3030
+
3131
[NOTE]
3232
====
33-
Currently only `InMemoryChannel` channel objects are supported by default. Kafka channels are available if you have installed Knative Kafka on {ServerlessProductName}.
33+
Currently only `InMemoryChannel` channel objects are supported by default. Knative channels for Apache Kafka are available if you have installed the Knative broker implementation for Apache Kafka on {ServerlessProductName}.
3434
====
3535
. Click *Create*.

modules/serverless-creating-subscriptions-kn.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ $ kn subscription create <subscription_name> \
2525
--sink <sink_prefix>:<sink_name> \ <2>
2626
--sink-dead-letter <sink_prefix>:<sink_name> <3>
2727
----
28-
<1> `--channel` specifies the source for cloud events that should be processed. You must provide the channel name. If you are not using the default `InMemoryChannel` channel that is backed by the `Channel` custom resource, you must prefix the channel name with the `<group:version:kind>` for the specified channel type. For example, this will be `messaging.knative.dev:v1beta1:KafkaChannel` for a Kafka backed channel.
28+
<1> `--channel` specifies the source for cloud events that should be processed. You must provide the channel name. If you are not using the default `InMemoryChannel` channel that is backed by the `Channel` custom resource, you must prefix the channel name with the `<group:version:kind>` for the specified channel type. For example, this will be `messaging.knative.dev:v1beta1:KafkaChannel` for an Apache Kafka backed channel.
2929
<2> `--sink` specifies the target destination to which the event should be delivered. By default, the `<sink_name>` is interpreted as a Knative service of this name, in the same namespace as the subscription. You can specify the type of the sink by using one of the following prefixes:
3030
`ksvc`:: A Knative service.
3131
`channel`:: A channel that should be used as destination. Only default channel types can be referenced here.

modules/serverless-event-delivery-component-behaviors.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Different channel and broker types have their own behavior patterns that are followed for event delivery.
1010

1111
[id="serverless-event-delivery-component-behaviors-kafka_{context}"]
12-
== Knative Kafka channels and brokers
12+
== Knative channels and brokers for Apache Kafka
1313

1414
If an event is successfully delivered to a Kafka channel or broker receiver, the receiver responds with a `202` status code, which means that the event has been safely stored inside a Kafka topic and is not lost.
1515

0 commit comments

Comments
 (0)