Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose OIDC audience of KafkaChannel in its status #3622

Conversation

creydr
Copy link
Contributor

@creydr creydr commented Jan 22, 2024

Fixes #3576

Proposed Changes

  • 🎁 Provision a KafkaChannels .status.address.audience and .status.addresses[*].audience field
  • 🧹 Update KafkaChannel CRD to align with latest SubscribableSpec and SubscribableStatus (include replyAudience, subscriberAudience, auth.serviceAccountName)
$ kubectl get kafkachannel my-kafka-channel -o yaml  
apiVersion: messaging.knative.dev/v1beta1
kind: KafkaChannel
metadata:
  name: my-kafka-channel
  namespace: default
  ...
spec:
  ...
status:
  address:
    audience: messaging.knative.dev/kafkachannel/default/my-kafka-channel
    name: http
    url: http://my-kafka-channel-kn-channel.default.svc.cluster.local
  addresses:
  - audience: messaging.knative.dev/kafkachannel/default/my-kafka-channel
    name: http
    url: http://my-kafka-channel-kn-channel.default.svc.cluster.local
...

Release Note

Expose the OIDC Audience of a KafkaChannel in its status

@knative-prow knative-prow bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. area/control-plane size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 22, 2024
@knative-prow knative-prow bot requested review from aliok and lionelvillard January 22, 2024 12:24
Copy link

knative-prow bot commented Jan 22, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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:

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

@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 22, 2024
Copy link

codecov bot commented Jan 22, 2024

Codecov Report

Attention: 8 lines in your changes are missing coverage. Please review.

Comparison is base (e80deca) 61.99% compared to head (8534113) 62.03%.
Report is 3 commits behind head on main.

Files Patch % Lines
control-plane/pkg/receiver/address.go 69.23% 4 Missing ⚠️
control-plane/pkg/reconciler/channel/controller.go 33.33% 2 Missing and 2 partials ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##               main    #3622      +/-   ##
============================================
+ Coverage     61.99%   62.03%   +0.04%     
+ Complexity      846      845       -1     
============================================
  Files           188      188              
  Lines         12634    12657      +23     
  Branches        273      273              
============================================
+ Hits           7832     7852      +20     
- Misses         4188     4190       +2     
- Partials        614      615       +1     
Flag Coverage Δ
java-unittests 74.46% <ø> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@knative-prow-robot knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 24, 2024
@creydr creydr force-pushed the kafka-channel-provision-oidc-audience branch from 22d143b to 3288691 Compare January 29, 2024 12:53
@knative-prow-robot knative-prow-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 29, 2024
@knative-prow knative-prow bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/test and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 29, 2024
@creydr creydr changed the title [WIP] Expose audience field of KafkaChannel Expose OIDC audience of KafkaChannel in its status Jan 29, 2024
@knative-prow knative-prow bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 29, 2024
@creydr
Copy link
Contributor Author

creydr commented Jan 29, 2024

@pierDipi this PR is ready for review

@creydr
Copy link
Contributor Author

creydr commented Jan 29, 2024

/retest-required

1 similar comment
@creydr
Copy link
Contributor Author

creydr commented Jan 29, 2024

/retest-required

@creydr
Copy link
Contributor Author

creydr commented Jan 29, 2024

/test reconciler-tests

@creydr creydr force-pushed the kafka-channel-provision-oidc-audience branch from 3288691 to 8534113 Compare January 29, 2024 17:11
@knative-prow knative-prow bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 29, 2024
@creydr
Copy link
Contributor Author

creydr commented Jan 29, 2024

Rebased after update-deps PR merged

@creydr
Copy link
Contributor Author

creydr commented Jan 29, 2024

/retest-required

@creydr creydr requested a review from Leo6Leo January 29, 2024 21:55
@Leo6Leo
Copy link
Contributor

Leo6Leo commented Jan 30, 2024

/lgtm

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jan 30, 2024
@creydr
Copy link
Contributor Author

creydr commented Jan 30, 2024

/retest-required

3 similar comments
@creydr
Copy link
Contributor Author

creydr commented Jan 30, 2024

/retest-required

@creydr
Copy link
Contributor Author

creydr commented Jan 30, 2024

/retest-required

@creydr
Copy link
Contributor Author

creydr commented Jan 31, 2024

/retest-required

@knative-prow knative-prow bot merged commit e558308 into knative-extensions:main Jan 31, 2024
37 checks passed
creydr added a commit to creydr/knative-eventing-kafka-broker that referenced this pull request Feb 4, 2024
…s#3622)

* Provision .status.address.audience and .status.addresses[*].audience in KafkaChannel

* Add kafka Channel e2e test to check if audience is provisioned

* Run goimport

* Update deps
creydr added a commit to creydr/knative-eventing-kafka-broker that referenced this pull request Feb 21, 2024
…s#3622)

* Provision .status.address.audience and .status.addresses[*].audience in KafkaChannel

* Add kafka Channel e2e test to check if audience is provisioned

* Run goimport

* Update deps
creydr added a commit to creydr/knative-eventing-kafka-broker that referenced this pull request Mar 18, 2024
…s#3622)

* Provision .status.address.audience and .status.addresses[*].audience in KafkaChannel

* Add kafka Channel e2e test to check if audience is provisioned

* Run goimport

* Update deps
creydr added a commit to creydr/knative-eventing-kafka-broker that referenced this pull request Apr 2, 2024
…s#3622)

* Provision .status.address.audience and .status.addresses[*].audience in KafkaChannel

* Add kafka Channel e2e test to check if audience is provisioned

* Run goimport

* Update deps
openshift-merge-bot bot pushed a commit to openshift-knative/eventing-kafka-broker that referenced this pull request Apr 3, 2024
* Update contract with fields for OIDC information (knative-extensions#3632)

* Update contract to include OIDC information

* Run hack/update-codegen.sh

* Move OIDC SA to egress

* Expose OIDC audience of KafkaChannel in its status (knative-extensions#3622)

* Provision .status.address.audience and .status.addresses[*].audience in KafkaChannel

* Add kafka Channel e2e test to check if audience is provisioned

* Run goimport

* Update deps

* Auto generate Triggers OIDC identity service account and expose in its status (knative-extensions#3604)

* Support auto generation of Triggers identity service account and expose in AuthStatus

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* fix unit test

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* make ServiceAccountLister public

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* add oidc unit test

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* fix unit test

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* integrate oidc unit test

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* add some logic to reconcile triggers, if the features config map gets updated

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* fix unit test

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* revert vendor/knative.dev/pkg/webhook/resourcesemantics/defaulting/controller.go

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* fix unit test

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* fix Verify Deps and Codegen test

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* fix unit test and reconcile triggers, in case of the features configmap changes

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

---------

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>

* Create KafkaSources OIDC service account and expose in its status (knative-extensions#3660)

* Create KafkaSources OIDC service account and expose in its status

* Run goimport

* Provision contract with OIDC information (knative-extensions#3646)

* Provision contract with OIDC information

* Add DLS audience in KafkaChannel CRD

* Update KafkaSource to expose its sinks audience in status

* Update Trigger test to include OIDC SA in contract

* Propagate KafkaSources OIDC serviceAccountName to consumer and consumergroup

* Propagate triggerv2s serviceAccountName to consumergroup

* Fix unit test

* [data-plane] Add the caching for OIDC JWT token to tokenprovider (knative-extensions#3663)

* Add the caching to tokenprovider

* Add the boiler

* Running the codegen

* Running the codegen

* Revert "Running the codegen"

This reverts commit 0ccf69c.

* Use constant, set buffer before token expire, remove unnecessary change

* Codegen changes

* Codegen changes

* Update data-plane/core/src/main/java/dev/knative/eventing/kafka/broker/core/oidc/TokenProvider.java

Co-authored-by: Christoph Stäbler <cstabler@redhat.com>

* Fix the review comments

* Run codegen

* Codegen changes

* Code gen again

---------

Co-authored-by: Christoph Stäbler <cstabler@redhat.com>

* Receiver reject requests for wrong audience (knative-extensions#3675)

* Receiver: reject request for wrong audience

* Switch to AuthenticationHandler

* Fix "Request has already been read" issue

* Change TokenVerifier to an interface

* Initialize TokenVerifier in main

* Add test for AuthenticationHandler

* Only initialize OIDC discovery config in main and create a TokenVerifier per verticle instance.

* Rerun hack/update-codegen.sh

* Move TokenVerifier setup into setup() to prevent null pointer exception when vertx is null

* Update KafkaChannel OIDC e2e tests, to run OIDC conformance tests so the receiver is tested too.

* Run OIDC e2e tests as part of the reconciler suite

* Fix KafkaChannelOIDC e2e test

* Fix lint issue

* Address review comments

* Dispatcher authenticate requests (knative-extensions#3677)

* Change TokenProvider to return future to get a token

* Dispatcher add OIDC to token, when target has an audience set

* Add e2e test

* Support exposing the Audience of a Broker (knative-extensions#3600)

* Support exposing the Audience of a Broker

* fix formatting

* fix formatting

* test fixes

* Populate broker.status.addresses[*].audience field too

* Run goimports and gofmt

* Fix unit test

---------

Co-authored-by: Christoph Stäbler <cstabler@redhat.com>

* Add broker OIDC e2e tests (knative-extensions#3685)

* Add broker OIDC e2e tests

* Fix broker template to allow TLS & OIDC configuration on dead letter sink

* Remove unneeded check when setting broker audience (knative-extensions#3708)

* Check status code of OIDC discovery response (knative-extensions#3707)

* Check status code of OIDC discovery endpoint

* Run update-codegen.sh

* Only allow 200 status code on OIDC discovery endpoint

* Run update-deps.sh

* Add OIDC tests to encryption/auth test suite

* run make generate-release

* TokenVerifier: execute blocking calls in parallel (knative-extensions#3728)

* TokenVerifier: execute blocking calls in parallel

* Revert "TokenVerifier: execute blocking calls in parallel"

This reverts commit f3dbde9.

* Revert: removed changes in contract.pb.go

* Cancel receiver pod start on invalid OIDC config only if authentication.oidc is enabled (knative-extensions#3761)

* Cancel pod start on invalid OIDC config only if authentication.oidc is enabled

* Update namespaced broker to copy features configmap too.

* Add unit test for FeaturesConfig class (knative-extensions#3771)

* Add unit test for FeaturesConfig class

* Update data-plane/core/src/test/java/dev/knative/eventing/kafka/broker/core/features/FeaturesConfigTest.java

Co-authored-by: Calum Murray <cmurray@redhat.com>

---------

Co-authored-by: Calum Murray <cmurray@redhat.com>

* Run make generate-release again

---------

Signed-off-by: pingjiang <xiangpingjiang1998@gmail.com>
Co-authored-by: cola <45722758+xiangpingjiang@users.noreply.github.com>
Co-authored-by: Leo Li <leoli@redhat.com>
Co-authored-by: Gunish Matta <33680363+gunishmatta@users.noreply.github.com>
Co-authored-by: Partha Ghosh <112557191+parth721@users.noreply.github.com>
Co-authored-by: Calum Murray <cmurray@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/control-plane area/test lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[control-plane]: Support exposing the Audience of a KafkaChannel
3 participants