Added kafka features config map to kafka broker docs #5622

Cali0707 · 2023-07-10T18:51:19Z

Proposed Changes

Add info about the kafka features config map

netlify · 2023-07-10T18:51:25Z

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`9dac7ea`
🔍 Latest deploy log	https://app.netlify.com/sites/knative/deploys/651ecf18f4a6fb0008ef01ab
😎 Deploy Preview	https://deploy-preview-5622--knative.netlify.app/docs/eventing/brokers/broker-types/kafka-broker/configuring-kafka-features
📱 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.

Cali0707 · 2023-07-10T18:51:33Z

/cc @pierDipi

Cali0707 · 2023-07-11T18:14:13Z

/cc @Leo6Leo

docs/eventing/brokers/broker-types/kafka-broker/README.md

Co-authored-by: Leo Li <[email protected]>

Leo6Leo · 2023-07-11T18:22:00Z

docs/eventing/brokers/broker-types/kafka-broker/README.md

+## Configure Kafka features
+
+There are various kafka features/default values the Knative Kafka Broker uses when interacting with Kafka. You can configure these as follows:
+


I think you can add a line to say what is this sample config file will achieve. (What does it do if I choose to follow this configuration in general)

docs/eventing/brokers/broker-types/kafka-broker/README.md

pierDipi · 2023-07-12T09:10:27Z

docs/eventing/brokers/broker-types/kafka-broker/README.md

@@ -257,6 +257,46 @@ spec:
 !!! note
    When using an external topic, the Knative Kafka Broker does not own the topic and is not responsible for managing the topic. This includes the topic lifecycle or its general validity. Other restrictions for general access to the topic may apply. See the documentation about using [Access Control Lists (ACLs)](https://kafka.apache.org/documentation/#security_authz).

+## Configure Kafka features
+
+There are various kafka features/default values the Knative Kafka Broker uses when interacting with Kafka. You can configure these as follows:


We probably need to link to https://knative.dev/docs/eventing/experimental-features/ and clarify what each feature is about and how each feature works, etc.

This seems overly generic for a user to grasp.

It might be worth considering a separate page that is linked to this one

@pierDipi would all of the features in this config map be considered experimental features then?

The term experimental is used wrongly in that doc, they are really just features, each at different maturity level (alpha, beta, or stable)

Co-authored-by: Pierangelo Di Pilato <[email protected]>

Cali0707 · 2023-07-14T19:33:48Z

@pierDipi I've made a new page to group the kafka config options together. WDYT?

docs/eventing/brokers/broker-types/kafka-broker/configuring-kafka-features.md

Co-authored-by: Pierangelo Di Pilato <[email protected]>

Signed-off-by: Calum Murray <[email protected]>

Cali0707 · 2023-09-22T17:44:11Z

/test

knative-prow · 2023-09-22T17:44:14Z

@Cali0707: No presubmit jobs available for knative/docs@main

In response to this:

/test

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Cali0707 · 2023-09-22T17:44:25Z

/retest

pierDipi · 2023-09-25T14:43:31Z

@Cali0707 the deploy preview failed

pierDipi · 2023-09-25T14:44:35Z

config/nav.yml

+            - Apache Kafka: 
+              - About Apache Kafka Broker: eventing/brokers/broker-types/kafka-broker/README.md
+              - Configuring Kafka features: eventing/brokers/broker-types/kafka-broker/configuring-kafka-features.md


I wonder if this breaks existing links to https://knative.dev/docs/eventing/brokers/broker-types/kafka-broker/

When I build these changes locally, it seemed to still work fine

Thanks for double checking

Cali0707 · 2023-09-25T14:45:09Z

@Cali0707 the deploy preview failed

The error seems to be:

2:49:21 PM: ERROR: Could not install packages due to an EnvironmentError: HTTPSConnectionPool(host='files.pythonhosted.org', port=443): Max retries exceeded with url: /packages/89/58/aa3301b23966a71d7f8e55233f467b3cec94a651434e9cd9053811342539/mkdocs-1.5.3-py3-none-any.whl (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSConnection object at 0x7f40fc558c10>: Failed to establish a new connection: [Errno 101] Network is unreachable'))

I don't think my changes caused this, but I don't have the ability to re-run the deploy preview. Any ideas @pierDipi ?

pierDipi · 2023-09-25T16:10:53Z

@Cali0707 the deploy preview failed

The error seems to be:

2:49:21 PM: ERROR: Could not install packages due to an EnvironmentError: HTTPSConnectionPool(host='files.pythonhosted.org', port=443): Max retries exceeded with url: /packages/89/58/aa3301b23966a71d7f8e55233f467b3cec94a651434e9cd9053811342539/mkdocs-1.5.3-py3-none-any.whl (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSConnection object at 0x7f40fc558c10>: Failed to establish a new connection: [Errno 101] Network is unreachable'))

I don't think my changes caused this, but I don't have the ability to re-run the deploy preview. Any ideas @pierDipi ?

me neither 🤔 can you just rebase/force push as a workaround?

Cali0707 · 2023-09-26T13:58:09Z

@pierDipi the deploy preview worked this time :)

pierDipi · 2023-10-05T14:55:53Z

Signed-off-by: Calum Murray <[email protected]>

Cali0707 · 2023-10-05T15:00:26Z

@pierDipi whoops - a bracket issue 🤦

pierDipi

/lgtm
/approve

knative-prow · 2023-10-05T15:57:01Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Cali0707, pierDipi

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:

~~OWNERS~~ [Cali0707,pierDipi]

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

pierDipi · 2023-10-05T15:57:03Z

Thank @Cali0707

pierDipi · 2023-10-06T10:07:49Z

/cherry-pick release-1.11

knative-prow-robot · 2023-10-06T10:08:37Z

@pierDipi: new pull request created: #5705

In response to this:

/cherry-pick release-1.11

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Added kafka features config map to kafka broker docs

0b1e7e7

knative-prow bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 10, 2023

knative-prow bot requested review from csantanapr and pierDipi July 10, 2023 18:51

knative-prow bot requested a review from Leo6Leo July 11, 2023 18:14

Leo6Leo reviewed Jul 11, 2023

View reviewed changes

Cali0707 and others added 5 commits July 11, 2023 14:20

Update docs/eventing/brokers/broker-types/kafka-broker/README.md

d287336

Co-authored-by: Leo Li <[email protected]>

Update docs/eventing/brokers/broker-types/kafka-broker/README.md

ec26be3

Co-authored-by: Leo Li <[email protected]>

Update docs/eventing/brokers/broker-types/kafka-broker/README.md

75c42fe

Co-authored-by: Leo Li <[email protected]>

Update docs/eventing/brokers/broker-types/kafka-broker/README.md

6edda01

Co-authored-by: Leo Li <[email protected]>

Update docs/eventing/brokers/broker-types/kafka-broker/README.md

600c99a

Co-authored-by: Leo Li <[email protected]>

Leo6Leo reviewed Jul 11, 2023

View reviewed changes

pierDipi reviewed Jul 12, 2023

View reviewed changes

Cali0707 and others added 2 commits July 12, 2023 09:41

Update docs/eventing/brokers/broker-types/kafka-broker/README.md

ef97b63

Co-authored-by: Pierangelo Di Pilato <[email protected]>

Moved kafka features config info to new page

1b29c60

knative-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 14, 2023

pierDipi reviewed Jul 17, 2023

View reviewed changes

Cali0707 and others added 2 commits August 23, 2023 13:38

Apply suggestions from code review

9e1b169

Co-authored-by: Pierangelo Di Pilato <[email protected]>

Follow example from serving for documenting configmap keys

1cbf666

Signed-off-by: Calum Murray <[email protected]>

knative-prow bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 20, 2023

Cali0707 requested a review from pierDipi September 20, 2023 18:49

pierDipi reviewed Sep 25, 2023

View reviewed changes

Merge branch 'main' into document-custom-kafka-topics

da73284

knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 26, 2023

Cali0707 requested a review from pierDipi October 5, 2023 14:34

Fix macro

9dac7ea

Signed-off-by: Calum Murray <[email protected]>

pierDipi approved these changes Oct 5, 2023

View reviewed changes

knative-prow bot assigned pierDipi Oct 5, 2023

knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Oct 5, 2023

knative-prow bot merged commit 76afdd5 into knative:main Oct 5, 2023
19 checks passed

knative-prow-robot mentioned this pull request Oct 6, 2023

[release-1.11] Added kafka features config map to kafka broker docs #5705

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added kafka features config map to kafka broker docs #5622

Added kafka features config map to kafka broker docs #5622

Cali0707 commented Jul 10, 2023

netlify bot commented Jul 10, 2023 •

edited

Loading

Cali0707 commented Jul 10, 2023

Cali0707 commented Jul 11, 2023

Leo6Leo Jul 11, 2023

pierDipi Jul 12, 2023 •

edited

Loading

Cali0707 Jul 12, 2023

pierDipi Jul 12, 2023

Cali0707 commented Jul 14, 2023

Cali0707 commented Sep 22, 2023

knative-prow bot commented Sep 22, 2023

Cali0707 commented Sep 22, 2023

pierDipi commented Sep 25, 2023

pierDipi Sep 25, 2023

Cali0707 Sep 25, 2023

pierDipi Sep 25, 2023

Cali0707 commented Sep 25, 2023

pierDipi commented Sep 25, 2023

Cali0707 commented Sep 26, 2023

pierDipi commented Oct 5, 2023

Cali0707 commented Oct 5, 2023

pierDipi left a comment

knative-prow bot commented Oct 5, 2023

pierDipi commented Oct 5, 2023

pierDipi commented Oct 6, 2023

knative-prow-robot commented Oct 6, 2023

		## Configure Kafka features

		There are various kafka features/default values the Knative Kafka Broker uses when interacting with Kafka. You can configure these as follows:

Added kafka features config map to kafka broker docs #5622

Added kafka features config map to kafka broker docs #5622

Conversation

Cali0707 commented Jul 10, 2023

Proposed Changes

netlify bot commented Jul 10, 2023 • edited Loading

✅ Deploy Preview for knative ready!

Cali0707 commented Jul 10, 2023

Cali0707 commented Jul 11, 2023

Leo6Leo Jul 11, 2023

Choose a reason for hiding this comment

pierDipi Jul 12, 2023 • edited Loading

Choose a reason for hiding this comment

Cali0707 Jul 12, 2023

Choose a reason for hiding this comment

pierDipi Jul 12, 2023

Choose a reason for hiding this comment

Cali0707 commented Jul 14, 2023

Cali0707 commented Sep 22, 2023

knative-prow bot commented Sep 22, 2023

Cali0707 commented Sep 22, 2023

pierDipi commented Sep 25, 2023

pierDipi Sep 25, 2023

Choose a reason for hiding this comment

Cali0707 Sep 25, 2023

Choose a reason for hiding this comment

pierDipi Sep 25, 2023

Choose a reason for hiding this comment

Cali0707 commented Sep 25, 2023

pierDipi commented Sep 25, 2023

Cali0707 commented Sep 26, 2023

pierDipi commented Oct 5, 2023

Cali0707 commented Oct 5, 2023

pierDipi left a comment

Choose a reason for hiding this comment

knative-prow bot commented Oct 5, 2023

pierDipi commented Oct 5, 2023

pierDipi commented Oct 6, 2023

knative-prow-robot commented Oct 6, 2023

netlify bot commented Jul 10, 2023 •

edited

Loading

pierDipi Jul 12, 2023 •

edited

Loading