From e9080d83e2780abb6115709c3b6c5bb34edef707 Mon Sep 17 00:00:00 2001 From: Antoine Cotten Date: Mon, 6 Sep 2021 16:01:43 +0200 Subject: [PATCH] Fix inaccurate description of `default-br-config` (#4182) * Fix inaccurate description of `default-br-config` * (review) Apply requested changes --- docs/admin/eventing/broker-configuration.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/admin/eventing/broker-configuration.md b/docs/admin/eventing/broker-configuration.md index 0a827f6cf..22c63cdf7 100644 --- a/docs/admin/eventing/broker-configuration.md +++ b/docs/admin/eventing/broker-configuration.md @@ -13,7 +13,7 @@ metadata: labels: eventing.knative.dev/release: devel data: - # Configuration for defaulting Channels that do not specify CRD implementations. + # Configures the default for any Broker that does not specify a spec.config or Broker class. default-br-config: | clusterDefault: brokerClass: MTChannelBasedBroker @@ -56,7 +56,7 @@ metadata: labels: eventing.knative.dev/release: devel data: - # Configuration for defaulting Channels that do not specify CRD implementations. + # Configures the default for any Broker that does not specify a spec.config or Broker class. default-br-config: | clusterDefault: brokerClass: MTChannelBasedBroker @@ -86,7 +86,7 @@ metadata: labels: eventing.knative.dev/release: devel data: - # Configuration for defaulting Channels that do not specify CRD implementations. + # Configures the default for any Broker that does not specify a spec.config or Broker class. default-br-config: | clusterDefault: brokerClass: MTChannelBasedBroker @@ -170,7 +170,7 @@ the backing Channel for the Broker class: ``` ### Configuring the default BrokerClass for the cluster -​ + You can configure the `clusterDefault` Broker class so that any Broker created in the cluster that does not have a `BrokerClass` annotation uses this default class. #### Example @@ -184,18 +184,18 @@ metadata: labels: eventing.knative.dev/release: devel data: - # Configuration for defaulting Channels that do not specify CRD implementations. + # Configures the default for any Broker that does not specify a spec.config or Broker class. default-br-config: | clusterDefault: brokerClass: MTChannelBasedBroker ``` -​ + ### Configuring the default BrokerClass for namespaces -​ + You can modify the default Broker class for one or more namespaces. For example, if you want to use a `KafkaBroker` class for all other Brokers created on the cluster, but you want to use the `MTChannelBasedBroker` class for Brokers created in `namespace-1` and `namespace-2`, you would use the following ConfigMap settings: -​ + ```yaml apiVersion: v1 kind: ConfigMap @@ -205,7 +205,7 @@ metadata: labels: eventing.knative.dev/release: devel data: - # Configuration for defaulting Channels that do not specify CRD implementations. + # Configures the default for any Broker that does not specify a spec.config or Broker class. default-br-config: | clusterDefault: brokerClass: KafkaBroker