Broker class based defaults

[Leo6Leo]

Fixes #5992

Proposed Changes

• Allowing users to set the default configuration for the namespaces adds more flexibility, in case they want to have the different configuration settings for different namespaces. Corner cases - what will happen if the user do these:

Pre-review Checklist

• [ ] At least 80% unit test coverage
• [ ] E2E tests for any new behavior
• [ ] Docs PR for any user-facing impact
• [ ] Spec PR for any new API feature
• [ ] Conformance test for any change to the spec

Release Note

Docs

[knative-prow[bot]]

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

[knative-prow[bot]]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Leo6Leo

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~~ [Leo6Leo]

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

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 85.00000% with 9 lines in your changes missing coverage. Please review.

Project coverage is 67.88%. Comparing base (332d974) to head (0e62b00). Report is 53 commits behind head on main.

Files	Patch %	Lines
pkg/apis/config/defaults.go	79.54%	4 Missing and 5 partials :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7631      +/-   ##
==========================================
- Coverage   67.92%   67.88%   -0.04%     
==========================================
  Files         367      368       +1     
  Lines       17323    17586     +263     
==========================================
+ Hits        11767    11939     +172     
- Misses       4823     4897      +74     
- Partials      733      750      +17     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[Leo6Leo]

/cc @pierDipi @Cali0707 @creydr

[Cali0707]

/test upgrade-tests

[Leo6Leo]

/hold currently trying to manually test the functionality

[Leo6Leo]

Manually creating the broker and test it, some problem occurs: the config from the brokerClasses cannot be used. Currently investigating

[github-actions[bot]]

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

[Cali0707]

Hey @Leo6Leo anything I can help with on this PR?

[Leo6Leo]

/remove-lifecycle stale

Resume working on the issue

[Leo6Leo]

Currently, the table unit test Created broker with DLQ and no Cluster Reference namespace for rabbitmq is failing.

broker_test.go:1289: Extra event: Warning InternalError broker.spec.config.[name, namespace] are required

Note: this is where clusterReference.Namespace is set.

@creydr @pierDipi @Cali0707 Do you guys know how to run the tests in the eventing-rabbitmq repo locally with the changes I have made in this PR?

[creydr]

Currently, the table unit test Created broker with DLQ and no Cluster Reference namespace for rabbitmq is failing.

broker_test.go:1289: Extra event: Warning InternalError broker.spec.config.[name, namespace] are required

Note: this is where clusterReference.Namespace is set.

@creydr @pierDipi @Cali0707 Do you guys know how to run the tests in the eventing-rabbitmq repo locally with the changes I have made in this PR?

Not sure, if there is a simple way, but you can use your branch to eventing-core in eventing-rabbitsmqs go.mod file via a replace directive. E.g. something like this:

replace (
    knative.dev/eventing => github.com/Leo6Leo/eventing default-broker-class
)

and then run ./hack/update-deps.sh

[Leo6Leo]

Steps to test

1. Apply the following default br config

# Copyright 2020 The Knative Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: v1
kind: ConfigMap
metadata:
  name: config-br-defaults
  namespace: knative-eventing
  labels:

data:
  default-br-config: |
    clusterDefault:
      brokerClass: default-cluster-class
      apiVersion: v1
      kind: ConfigMap
      name: config-default-cluster-class
      namespace: knative-eventing
      delivery:
        retry: 3
        deadLetterSink:
          ref:
            apiVersion: serving.knative.dev/v1
            kind: Service
            name: mt-handle-error
            namespace: knative-eventing
        backoffPolicy: exponential
        backoffDelay: PT0.2S
      brokerClasses:
        cluster-class-2:
          delivery:
            retry: 3
            deadLetterSink:
              ref:
                apiVersion: serving.knative.dev/v1
                kind: Service
                name: mt-handle-error
                namespace: knative-eventing
            backoffPolicy: exponential
            backoffDelay: PT0.2S

          apiVersion: v1
          kind: ConfigMap
          name: config-cluster-class-2
          namespace: knative-eventing

        shared-class:
          delivery:
            retry: 3
            deadLetterSink:
              ref:
                apiVersion: serving.knative.dev/v1
                kind: Service
                name: kafka-handle-error
                namespace: knative-eventing
            backoffPolicy: exponential
            backoffDelay: PT0.2S

          apiVersion: v1
          kind: ConfigMap
          name: config-shared-class
          namespace: knative-eventing


    namespaceDefaults:
      namespace-1:
        brokerClass: namespace-1-class
        apiVersion: v1
        kind: ConfigMap
        name: config-namespace-1-class
        namespace: namespace-1
        delivery:
          retry: 5
          deadLetterSink:
            ref:
              apiVersion: serving.knative.dev/v1
              kind: Service
              name: someother-handle-error
              namespace: knative-eventing
          backoffPolicy: linear
          backoffDelay: PT0.2S
        brokerClasses:
          namespace-1-class-2:
            delivery:
              retry: 3
              deadLetterSink:
                ref:
                  apiVersion: serving.knative.dev/v1
                  kind: Service
                  name: mt-handle-error
                  namespace: knative-eventing
              backoffPolicy: exponential
              backoffDelay: PT0.2S

            apiVersion: v1
            kind: ConfigMap
            name: config-namespace-1-class-2
            namespace: knative-eventing

          shared-class:
            delivery:
              retry: 3
              deadLetterSink:
                ref:
                  apiVersion: serving.knative.dev/v1
                  kind: Service
                  name: kafka-handle-error
                  namespace: knative-eventing
              backoffPolicy: exponential
              backoffDelay: PT0.2S

            apiVersion: v1
            kind: ConfigMap
            name: config-shared-class-in-namespace-1
            namespace: knative-eventing

      namespace-2:
        brokerClass: default-namespace-2-class


      namespace-3:

2. Create brokers and then describe it to see whether the correct broker config is used.

[Leo6Leo]

/unhold The PR is ready for review.

[Cali0707]

@Leo6Leo is there a plan to add a rekt test for this feature? Maybe in another PR?

[Leo6Leo]

Note: Thanks to @Cali0707 's suggestion , now trying to gradually deprecate the deafult broker class and config here.

Current behavior:

• When the same broker class appears in both brokerClass and brokerClasses:
  • The brokerClasses map takes precedence and overwrites the default.

Future plan:

• We will transition to using only the brokerClasses map for storing default configurations for different broker classes.

Rationale:

• In cases where a broker class is defined in both places, it's more intuitive and maintainable to have a single source of truth.
• Using only the brokerClasses map allows for consistent handling of default configurations across all broker classes.

This change simplifies the configuration model and reduces potential confusion or conflicts between the two ways of specifying default broker configurations.

[Cali0707]

@Leo6Leo I think it's worth still having a "default" class available, just maybe not also a config. Then the default class is just referring to the one of the classes in the brokerClasses map. So, basically the default config would become brokerClasses[defaultClassName]

[Leo6Leo]

The documentation is written here in this PR https://github.com/knative/docs/pull/6069

[knative-prow[bot]]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Leo6Leo, 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~~ [Leo6Leo,pierDipi]

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