Add more information about Broker Developer Configuration Options #5993

pembebiri · 2024-05-23T22:14:54Z

#5526

… page

linux-foundation-easycla · 2024-05-23T22:14:58Z

The committers listed above are authorized under a signed CLA.

✅ login: 0ZeKa0 / name: Zehra Karakaya (f86d17b, 1529b43, 6f2d4c0, 98c62ea, 8c40897, 010bc96)

knative-prow · 2024-05-23T22:15:03Z

Welcome @0ZeKa0! It looks like this is your first PR to knative/docs 🎉

netlify · 2024-05-23T22:15:11Z

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`98c62ea`
🔍 Latest deploy log	https://app.netlify.com/sites/knative/deploys/6662a93ed36bb20008a8f72f
😎 Deploy Preview	https://deploy-preview-5993--knative.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

creydr

Hello @0ZeKa0,
thanks a lot for your work on this 👍
I left a few comments.
When I checked on your PR, I was thinking about merging the "Developer configuration options" and "Creating a Broker" page. Any objections on that? Otherwise we can continue with the split approach as in this PR to describe the needed options and then merge them later 🤷

creydr · 2024-05-28T06:25:21Z

docs/eventing/brokers/broker-developer-config-options.md

@@ -1,6 +1,6 @@
 # Developer configuration options

-## Broker configuration example
+## Broker configuration 


Should we move the full example to the end of the page. So we describe before the configuration options and give then a "full example"?

Moving the full example would be better because a section from options was repeated on the Developer Configuration Options.

creydr · 2024-05-28T06:26:04Z

docs/eventing/brokers/broker-developer-config-options.md

+
+###  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`.


Suggested change

- 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 policies` to define the delay strategy between retry attempts. It can be `exponantial` or `linear`.

creydr · 2024-05-28T06:26:17Z

docs/eventing/brokers/broker-developer-config-options.md

+###  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.


Suggested change

- You can set the `Backoff delay ` to specify the initial delay before retrying, using the ISO 8601 duration format.

- You can set the `Backoff delay` to specify the initial delay before retrying, using the ISO 8601 duration format.

creydr · 2024-05-28T06:26:51Z

docs/eventing/brokers/broker-developer-config-options.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).
+
+###  Advance broroker class options


Suggested change

### Advance broroker class options

### Advanced Broker class options

creydr · 2024-05-28T06:28:19Z

docs/eventing/brokers/broker-developer-config-options.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).
+
+###  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. 


Suggested change

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.

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.

aliok · 2024-05-28T11:44:05Z

Thanks @0ZeKa0 !

Cali0707 · 2024-05-28T14:04:47Z

docs/eventing/brokers/broker-developer-config-options.md

+
+###  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`.


nit:

Suggested change

- 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 policies` to define the delay strategy between retry attempts. It can be `exponential` or `linear`.

pembebiri · 2024-05-29T03:08:59Z

I thought that the expectation was merging just "Broker class options" section to "Developer Configuration Options" page. So let's continue with split approach. @creydr

The full example moved to end of the page

pembebiri

reviewed

creydr

one small nit. Looks LGTM otherwise

docs/eventing/brokers/broker-developer-config-options.md

Co-authored-by: Christoph Stäbler <[email protected]>

creydr

Thanks a lot @0ZeKa0 for fixing this 💪

/lgtm

Cali0707

/approve

knative-prow · 2024-06-07T15:52:48Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 0ZeKa0, Cali0707, creydr

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~docs/eventing/OWNERS~~ [Cali0707]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

broker class options page is moved to broker developer config options…

1529b43

… page

knative-prow bot requested review from Cali0707 and pierDipi May 23, 2024 22:15

knative-prow bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 23, 2024

pembebiri closed this May 23, 2024

pembebiri deleted the broker-dev branch May 23, 2024 23:08

pembebiri restored the broker-dev branch May 23, 2024 23:08

pembebiri reopened this May 23, 2024

pembebiri closed this May 24, 2024

pembebiri added 2 commits May 24, 2024 19:02

Titles are ok

f86d17b

broker-developer-config-options

6f2d4c0

pembebiri reopened this May 24, 2024

creydr suggested changes May 28, 2024

View reviewed changes

knative-prow bot assigned creydr May 28, 2024

creydr mentioned this pull request May 28, 2024

Add more information about Broker Developer Configuration Options #5526

Closed

Cali0707 reviewed May 28, 2024

View reviewed changes

Update broker-developer-config-options.md

8c40897

The full example moved to end of the page

pembebiri commented Jun 6, 2024

View reviewed changes

changes are committed

010bc96

creydr reviewed Jun 7, 2024

View reviewed changes

docs/eventing/brokers/broker-developer-config-options.md Show resolved Hide resolved

Update docs/eventing/brokers/broker-developer-config-options.md

98c62ea

Co-authored-by: Christoph Stäbler <[email protected]>

creydr approved these changes Jun 7, 2024

View reviewed changes

knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jun 7, 2024

Cali0707 approved these changes Jun 7, 2024

View reviewed changes

knative-prow bot assigned Cali0707 Jun 7, 2024

knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 7, 2024

knative-prow bot merged commit 946e2ae into knative:main Jun 7, 2024
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more information about Broker Developer Configuration Options #5993

Add more information about Broker Developer Configuration Options #5993

pembebiri commented May 23, 2024 •

edited

Loading

linux-foundation-easycla bot commented May 23, 2024 •

edited

Loading

knative-prow bot commented May 23, 2024

netlify bot commented May 23, 2024 •

edited

Loading

creydr left a comment

creydr May 28, 2024

pembebiri May 29, 2024 •

edited

Loading

creydr May 28, 2024

creydr May 28, 2024

creydr May 28, 2024

creydr May 28, 2024

aliok commented May 28, 2024

Cali0707 May 28, 2024

pembebiri commented May 29, 2024

pembebiri left a comment •

edited

Loading

creydr left a comment

creydr left a comment

Cali0707 left a comment

knative-prow bot commented Jun 7, 2024

	- 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 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 delay` to specify the initial delay before retrying, using the ISO 8601 duration format.

		- `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

	### Advance broroker class options
	### Advanced 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.
	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.

Add more information about Broker Developer Configuration Options #5993

Add more information about Broker Developer Configuration Options #5993

Conversation

pembebiri commented May 23, 2024 • edited Loading

linux-foundation-easycla bot commented May 23, 2024 • edited Loading

knative-prow bot commented May 23, 2024

netlify bot commented May 23, 2024 • edited Loading

✅ Deploy Preview for knative ready!

creydr left a comment

Choose a reason for hiding this comment

creydr May 28, 2024

Choose a reason for hiding this comment

pembebiri May 29, 2024 • edited Loading

Choose a reason for hiding this comment

creydr May 28, 2024

Choose a reason for hiding this comment

creydr May 28, 2024

Choose a reason for hiding this comment

creydr May 28, 2024

Choose a reason for hiding this comment

creydr May 28, 2024

Choose a reason for hiding this comment

aliok commented May 28, 2024

Cali0707 May 28, 2024

Choose a reason for hiding this comment

pembebiri commented May 29, 2024

pembebiri left a comment • edited Loading

Choose a reason for hiding this comment

creydr left a comment

Choose a reason for hiding this comment

creydr left a comment

Choose a reason for hiding this comment

Cali0707 left a comment

Choose a reason for hiding this comment

knative-prow bot commented Jun 7, 2024

pembebiri commented May 23, 2024 •

edited

Loading

linux-foundation-easycla bot commented May 23, 2024 •

edited

Loading

netlify bot commented May 23, 2024 •

edited

Loading

pembebiri May 29, 2024 •

edited

Loading

pembebiri left a comment •

edited

Loading