docs icon indicating copy to clipboard operation
docs copied to clipboard

Improve documentation on configuring the default BrokerClass

Open matzew opened this issue 3 years ago • 2 comments

The doc https://knative.dev/docs/eventing/configuration/broker-configuration/#configuring-the-default-brokerclass-for-namespaces

is a little misleading or not fully correct.

  • KafkaBroker -> there is no such class, the Kafka-based broker impl does use Kafka instead
  • The config just contains the brokerClass field, usually each broker has different configuration, captured in a config map. This should be reflected in the doc as well. An example for some better Kafka config would go like:
apiVersion: operator.knative.dev/v1alpha1
kind: KnativeEventing
metadata:
  name: knative-eventing
  namespace: knative-eventing
spec:
  defaultBrokerClass: Kafka
  config:
    config-br-defaults:
      default-br-config: |
        clusterDefault:
          apiVersion: v1
          kind: ConfigMap
          name: kafka-broker-config
          namespace: knative-eventing

matzew avatar Mar 15 '22 07:03 matzew

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

github-actions[bot] avatar Jun 27 '22 01:06 github-actions[bot]

RE apiVersion: operator.knative.dev/v1alpha1 - this isn't the same as the docs provided at the link because it's updating the eventing CR via the Operator rather than modifying the config map directly. IMO this needs to be updated here instead: https://knative.dev/docs/install/operator/configuring-eventing-cr/#configuring-the-default-broker-class

abrennan89 avatar Jul 15 '22 13:07 abrennan89

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

github-actions[bot] avatar Jan 24 '23 01:01 github-actions[bot]