From 1529b434363b4edc988375431ce4a912767bd7ea Mon Sep 17 00:00:00 2001 From: zehra Date: Fri, 24 May 2024 01:08:51 +0300 Subject: [PATCH 1/6] broker class options page is moved to broker developer config options page --- .../broker-developer-config-options.md | 39 +++++++++++++++++++ docs/eventing/brokers/create-broker.md | 38 ------------------ 2 files changed, 39 insertions(+), 38 deletions(-) diff --git a/docs/eventing/brokers/broker-developer-config-options.md b/docs/eventing/brokers/broker-developer-config-options.md index 20fa1192173..68aa264f25b 100644 --- a/docs/eventing/brokers/broker-developer-config-options.md +++ b/docs/eventing/brokers/broker-developer-config-options.md @@ -36,3 +36,42 @@ spec: - You can set the `eventing.knative.dev/broker.class` annotation to change the class of the broker. The default broker class is `MTChannelBasedBroker`, but Knative also supports use of the `Kafka` and `RabbitMQBroker` broker class. For more information see the [Apache Kafka Broker](../brokers/broker-types/kafka-broker/README.md) or [RabbitMQ Broker](../brokers/broker-types/rabbitmq-broker/README.md) documentation. - `spec.config` is used to specify the default backing channel configuration for Channel based Broker implementations. For more information on configuring the default channel type, see the documentation on [Configure Broker defaults](../configuration/broker-configuration.md). - `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md). + + +## Broker class options + +When a Broker is created without a specified `eventing.knative.dev/broker.class` annotation, the default `MTChannelBasedBroker` Broker class is used, as specified by default in the `config-br-defaults` ConfigMap. + +In case you have multiple Broker classes installed in your cluster and want to use a non-default Broker class for a Broker, you can modify the `eventing.knative.dev/broker.class` annotation and `spec.config` for the Broker object. + +1. Set the `eventing.knative.dev/broker.class` annotation. Replace `MTChannelBasedBroker` in the following example with the class type you want to use. Be aware that the Broker class annoation is immutable and thus can't be updated after the Broker got created: + + ```yaml + apiVersion: eventing.knative.dev/v1 + kind: Broker + metadata: + annotations: + eventing.knative.dev/broker.class: MTChannelBasedBroker + name: default + namespace: default + ``` + +1. Configure the `spec.config` with the details of the ConfigMap that defines the required configuration for the Broker class (e.g. with some Channel configurations in case of the `MTChannelBasedBroker`): + + ```yaml + apiVersion: eventing.knative.dev/v1 + kind: Broker + metadata: + annotations: + eventing.knative.dev/broker.class: MTChannelBasedBroker + name: default + namespace: default + spec: + config: + apiVersion: v1 + kind: ConfigMap + name: config-br-default-channel + namespace: knative-eventing + ``` + +For further information about configuring a default Broker class cluster wide or on a per namespace basis, check the [Administrator configuration options](../configuration/broker-configuration.md#configuring-the-broker-class). diff --git a/docs/eventing/brokers/create-broker.md b/docs/eventing/brokers/create-broker.md index af7f8982494..460488e7606 100644 --- a/docs/eventing/brokers/create-broker.md +++ b/docs/eventing/brokers/create-broker.md @@ -76,41 +76,3 @@ You can create a Broker by using the `kn` CLI or by applying YAML files using `k ``` If the `READY` status is `False`, wait a few moments and then run the command again. - -## Broker class options - -When a Broker is created without a specified `eventing.knative.dev/broker.class` annotation, the default `MTChannelBasedBroker` Broker class is used, as specified by default in the `config-br-defaults` ConfigMap. - -In case you have multiple Broker classes installed in your cluster and want to use a non-default Broker class for a Broker, you can modify the `eventing.knative.dev/broker.class` annotation and `spec.config` for the Broker object. - -1. Set the `eventing.knative.dev/broker.class` annotation. Replace `MTChannelBasedBroker` in the following example with the class type you want to use. Be aware that the Broker class annoation is immutable and thus can't be updated after the Broker got created: - - ```yaml - apiVersion: eventing.knative.dev/v1 - kind: Broker - metadata: - annotations: - eventing.knative.dev/broker.class: MTChannelBasedBroker - name: default - namespace: default - ``` - -1. Configure the `spec.config` with the details of the ConfigMap that defines the required configuration for the Broker class (e.g. with some Channel configurations in case of the `MTChannelBasedBroker`): - - ```yaml - apiVersion: eventing.knative.dev/v1 - kind: Broker - metadata: - annotations: - eventing.knative.dev/broker.class: MTChannelBasedBroker - name: default - namespace: default - spec: - config: - apiVersion: v1 - kind: ConfigMap - name: config-br-default-channel - namespace: knative-eventing - ``` - -For further information about configuring a default Broker class cluster wide or on a per namespace basis, check the [Administrator configuration options](../configuration/broker-configuration.md#configuring-the-broker-class). From f86d17bf0c36376778294e4c80b1c522ae018823 Mon Sep 17 00:00:00 2001 From: zehra Date: Fri, 24 May 2024 19:02:12 +0300 Subject: [PATCH 2/6] Titles are ok --- .../broker-developer-config-options.md | 31 ++++++++++++++----- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/docs/eventing/brokers/broker-developer-config-options.md b/docs/eventing/brokers/broker-developer-config-options.md index 68aa264f25b..c7b25bd343e 100644 --- a/docs/eventing/brokers/broker-developer-config-options.md +++ b/docs/eventing/brokers/broker-developer-config-options.md @@ -1,6 +1,6 @@ # Developer configuration options -## Broker configuration example +## Broker configuration The following is a full example of a Channel based Broker object which shows the possible configuration options that you can modify: @@ -33,13 +33,8 @@ spec: - You can specify any valid `name` for your broker. Using `default` will create a broker named `default`. - The `namespace` must be an existing namespace in your cluster. Using `default` will create the broker in the `default` namespace. -- You can set the `eventing.knative.dev/broker.class` annotation to change the class of the broker. The default broker class is `MTChannelBasedBroker`, but Knative also supports use of the `Kafka` and `RabbitMQBroker` broker class. For more information see the [Apache Kafka Broker](../brokers/broker-types/kafka-broker/README.md) or [RabbitMQ Broker](../brokers/broker-types/rabbitmq-broker/README.md) documentation. -- `spec.config` is used to specify the default backing channel configuration for Channel based Broker implementations. For more information on configuring the default channel type, see the documentation on [Configure Broker defaults](../configuration/broker-configuration.md). -- `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md). - - -## Broker class options +### Advance broroker class options When a Broker is created without a specified `eventing.knative.dev/broker.class` annotation, the default `MTChannelBasedBroker` Broker class is used, as specified by default in the `config-br-defaults` ConfigMap. In case you have multiple Broker classes installed in your cluster and want to use a non-default Broker class for a Broker, you can modify the `eventing.knative.dev/broker.class` annotation and `spec.config` for the Broker object. @@ -75,3 +70,25 @@ In case you have multiple Broker classes installed in your cluster and want to u ``` For further information about configuring a default Broker class cluster wide or on a per namespace basis, check the [Administrator configuration options](../configuration/broker-configuration.md#configuring-the-broker-class). + + +### Event Delivery Options +- You can sets up a dead-letter sink, retry policies, and a backoff delay for event delivery. +- `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md). + +### Monitoring to Status Options + You can use the status of Broker to monitor its status. Here is example: +```yaml + status: + observedGeneration: 1 + conditions: + - type: Ready + status: "True" + reason: "BrokerReady" + message: "Broker is ready" + address: + url: + +``` + + From 6f2d4c0546c7252f5afb8acfc2bc92f86cbbd2d4 Mon Sep 17 00:00:00 2001 From: zehra Date: Sat, 25 May 2024 02:54:59 +0300 Subject: [PATCH 3/6] broker-developer-config-options --- .../broker-developer-config-options.md | 30 +++++-------------- 1 file changed, 7 insertions(+), 23 deletions(-) diff --git a/docs/eventing/brokers/broker-developer-config-options.md b/docs/eventing/brokers/broker-developer-config-options.md index c7b25bd343e..15d18dada49 100644 --- a/docs/eventing/brokers/broker-developer-config-options.md +++ b/docs/eventing/brokers/broker-developer-config-options.md @@ -30,10 +30,16 @@ spec: backoffPolicy: exponential backoffDelay: "2007-03-01T13:00:00Z/P1Y2M10DT2H30M" ``` - - You can specify any valid `name` for your broker. Using `default` will create a broker named `default`. - The `namespace` must be an existing namespace in your cluster. Using `default` will create the broker in the `default` namespace. +### Event Delivery Options +- You can use `dead-letter sink` for error handling and auditing of undelivered messages. Specify Kubernetes object reference where undelivered messages will be sent using `ref` and an optional URI to route undelivered messages using `uri`. +- You can set the `Backoff policies` to define the delay strategy between retry attempts. It can be `exponantial` or `linear`. +- You can set the `Backoff delay ` to specify the initial delay before retrying, using the ISO 8601 duration format. +- You can specify the number of retry attempts before sending the event to the dead-letter sink using the `retry` configuration. +- `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md). + ### Advance broroker class options When a Broker is created without a specified `eventing.knative.dev/broker.class` annotation, the default `MTChannelBasedBroker` Broker class is used, as specified by default in the `config-br-defaults` ConfigMap. @@ -70,25 +76,3 @@ In case you have multiple Broker classes installed in your cluster and want to u ``` For further information about configuring a default Broker class cluster wide or on a per namespace basis, check the [Administrator configuration options](../configuration/broker-configuration.md#configuring-the-broker-class). - - -### Event Delivery Options -- You can sets up a dead-letter sink, retry policies, and a backoff delay for event delivery. -- `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md). - -### Monitoring to Status Options - You can use the status of Broker to monitor its status. Here is example: -```yaml - status: - observedGeneration: 1 - conditions: - - type: Ready - status: "True" - reason: "BrokerReady" - message: "Broker is ready" - address: - url: - -``` - - From 8c4089790cd5c73dae42690c277f1045fda12a01 Mon Sep 17 00:00:00 2001 From: Zehra Karakaya <121049907+0ZeKa0@users.noreply.github.com> Date: Wed, 29 May 2024 06:50:45 +0300 Subject: [PATCH 4/6] Update broker-developer-config-options.md The full example moved to end of the page --- .../broker-developer-config-options.md | 67 ++++++------------- 1 file changed, 21 insertions(+), 46 deletions(-) diff --git a/docs/eventing/brokers/broker-developer-config-options.md b/docs/eventing/brokers/broker-developer-config-options.md index 15d18dada49..bb6f6d791fa 100644 --- a/docs/eventing/brokers/broker-developer-config-options.md +++ b/docs/eventing/brokers/broker-developer-config-options.md @@ -2,6 +2,27 @@ ## Broker configuration +- You can specify any valid `name` for your broker. Using `default` will create a broker named `default`. +- The `namespace` must be an existing namespace in your cluster. Using `default` will create the broker in the `default` namespace. + +### Event Delivery Options +- You can use `dead-letter sink` for error handling and auditing of undelivered messages. Specify Kubernetes object reference where undelivered messages will be sent using `ref` and an optional URI to route undelivered messages using `uri`. +- You can set the `Backoff policies` to define the delay strategy between retry attempts. It can be `exponantial` or `linear`. +- You can set the `Backoff delay ` to specify the initial delay before retrying, using the ISO 8601 duration format. +- You can specify the number of retry attempts before sending the event to the dead-letter sink using the `retry` configuration. +- `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md). + +### Advance broroker class options +When a Broker is created without a specified `eventing.knative.dev/broker.class` annotation, the default `MTChannelBasedBroker` Broker class is used, as specified by default in the `config-br-defaults` ConfigMap. + +In case you have multiple Broker classes installed in your cluster and want to use a non-default Broker class for a Broker, you can modify the `eventing.knative.dev/broker.class` annotation and `spec.config` for the Broker object. + +1. Set the `eventing.knative.dev/broker.class` annotation. Replace `MTChannelBasedBroker` in the following example with the class type you want to use. Be aware that the Broker class annoation is immutable and thus can't be updated after the Broker got created: + +2. Configure the `spec.config` with the details of the ConfigMap that defines the required configuration for the Broker class (e.g. with some Channel configurations in case of the `MTChannelBasedBroker`): + +For further information about configuring a default Broker class cluster wide or on a per namespace basis, check the [Administrator configuration options](../configuration/broker-configuration.md#configuring-the-broker-class). + The following is a full example of a Channel based Broker object which shows the possible configuration options that you can modify: ```yaml @@ -30,49 +51,3 @@ spec: backoffPolicy: exponential backoffDelay: "2007-03-01T13:00:00Z/P1Y2M10DT2H30M" ``` -- You can specify any valid `name` for your broker. Using `default` will create a broker named `default`. -- The `namespace` must be an existing namespace in your cluster. Using `default` will create the broker in the `default` namespace. - -### Event Delivery Options -- You can use `dead-letter sink` for error handling and auditing of undelivered messages. Specify Kubernetes object reference where undelivered messages will be sent using `ref` and an optional URI to route undelivered messages using `uri`. -- You can set the `Backoff policies` to define the delay strategy between retry attempts. It can be `exponantial` or `linear`. -- You can set the `Backoff delay ` to specify the initial delay before retrying, using the ISO 8601 duration format. -- You can specify the number of retry attempts before sending the event to the dead-letter sink using the `retry` configuration. -- `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md). - -### Advance broroker class options -When a Broker is created without a specified `eventing.knative.dev/broker.class` annotation, the default `MTChannelBasedBroker` Broker class is used, as specified by default in the `config-br-defaults` ConfigMap. - -In case you have multiple Broker classes installed in your cluster and want to use a non-default Broker class for a Broker, you can modify the `eventing.knative.dev/broker.class` annotation and `spec.config` for the Broker object. - -1. Set the `eventing.knative.dev/broker.class` annotation. Replace `MTChannelBasedBroker` in the following example with the class type you want to use. Be aware that the Broker class annoation is immutable and thus can't be updated after the Broker got created: - - ```yaml - apiVersion: eventing.knative.dev/v1 - kind: Broker - metadata: - annotations: - eventing.knative.dev/broker.class: MTChannelBasedBroker - name: default - namespace: default - ``` - -1. Configure the `spec.config` with the details of the ConfigMap that defines the required configuration for the Broker class (e.g. with some Channel configurations in case of the `MTChannelBasedBroker`): - - ```yaml - apiVersion: eventing.knative.dev/v1 - kind: Broker - metadata: - annotations: - eventing.knative.dev/broker.class: MTChannelBasedBroker - name: default - namespace: default - spec: - config: - apiVersion: v1 - kind: ConfigMap - name: config-br-default-channel - namespace: knative-eventing - ``` - -For further information about configuring a default Broker class cluster wide or on a per namespace basis, check the [Administrator configuration options](../configuration/broker-configuration.md#configuring-the-broker-class). From 010bc96644c2ca3d6db470b691d21df3f4fa96a9 Mon Sep 17 00:00:00 2001 From: zehra Date: Thu, 6 Jun 2024 13:28:23 +0300 Subject: [PATCH 5/6] changes are committed --- docs/eventing/brokers/broker-developer-config-options.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/eventing/brokers/broker-developer-config-options.md b/docs/eventing/brokers/broker-developer-config-options.md index bb6f6d791fa..de12baed04b 100644 --- a/docs/eventing/brokers/broker-developer-config-options.md +++ b/docs/eventing/brokers/broker-developer-config-options.md @@ -7,13 +7,13 @@ ### Event Delivery Options - You can use `dead-letter sink` for error handling and auditing of undelivered messages. Specify Kubernetes object reference where undelivered messages will be sent using `ref` and an optional URI to route undelivered messages using `uri`. -- You can set the `Backoff policies` to define the delay strategy between retry attempts. It can be `exponantial` or `linear`. -- You can set the `Backoff delay ` to specify the initial delay before retrying, using the ISO 8601 duration format. +- You can set the `Backoff policies` to define the delay strategy between retry attempts. It can be `exponential` or `linear`. +- You can set the `Backoff delay` to specify the initial delay before retrying, using the ISO 8601 duration format. - You can specify the number of retry attempts before sending the event to the dead-letter sink using the `retry` configuration. - `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md). -### Advance broroker class options -When a Broker is created without a specified `eventing.knative.dev/broker.class` annotation, the default `MTChannelBasedBroker` Broker class is used, as specified by default in the `config-br-defaults` ConfigMap. +### Advanced broker class options +When a Broker is created without a specified `eventing.knative.dev/broker.class` annotation, by default the `MTChannelBasedBroker` Broker class is used, as specified in the `config-br-defaults` ConfigMap. In case you have multiple Broker classes installed in your cluster and want to use a non-default Broker class for a Broker, you can modify the `eventing.knative.dev/broker.class` annotation and `spec.config` for the Broker object. From 98c62ea2d547d0644f7f96903ffdf0b6038881ab Mon Sep 17 00:00:00 2001 From: Zehra Karakaya <121049907+0ZeKa0@users.noreply.github.com> Date: Fri, 7 Jun 2024 09:31:24 +0300 Subject: [PATCH 6/6] Update docs/eventing/brokers/broker-developer-config-options.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Christoph Stäbler --- docs/eventing/brokers/broker-developer-config-options.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/eventing/brokers/broker-developer-config-options.md b/docs/eventing/brokers/broker-developer-config-options.md index de12baed04b..30195c32d63 100644 --- a/docs/eventing/brokers/broker-developer-config-options.md +++ b/docs/eventing/brokers/broker-developer-config-options.md @@ -23,6 +23,8 @@ In case you have multiple Broker classes installed in your cluster and want to u For further information about configuring a default Broker class cluster wide or on a per namespace basis, check the [Administrator configuration options](../configuration/broker-configuration.md#configuring-the-broker-class). +## Broker configuration example + The following is a full example of a Channel based Broker object which shows the possible configuration options that you can modify: ```yaml