[WIP]: CNTRLPLANE-311: Add missing fields to auth config #2304

ShazaAldawamneh · 2025-05-02T11:06:55Z

Add new fields to the Authentication API

Signed-off-by: Shaza Aldawamneh <[email protected]>

openshift-ci · 2025-05-02T11:07:01Z

Hello @ShazaAldawamneh! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

openshift-ci · 2025-05-02T11:07:25Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ShazaAldawamneh
Once this PR has been reviewed and has the lgtm label, please assign joelspeed for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

openshift-ci-robot · 2025-05-02T11:08:40Z

@ShazaAldawamneh: This pull request references CNTRLPLANE-311 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set.

In response to this:

Add new fields to the Authentication API

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 openshift-eng/jira-lifecycle-plugin repository.

everettraven

These new fields will need to go behind a new feature-gate as well.

config/v1/types_authentication.go

…conventions Signed-off-by: Shaza Aldawamneh <[email protected]>

JoelSpeed · 2025-05-09T06:40:04Z

config/v1/types_authentication.go

-	// requiredClaim allows configuring a required claim name and its expected
-	// value
+	// requiredClaim allows configuring a required claim name and its expected value.
+	// RequiredClaim is used when type is RequiredClaim.


What happens if type: RequiredClaim and requiredClaim == nil today?

… those fields Signed-off-by: Shaza Aldawamneh <[email protected]>

openshift-merge-robot · 2025-05-11T22:32:46Z

PR needs rebase.

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-sigs/prow repository.

Signed-off-by: Shaza Aldawamneh <[email protected]>

config/v1/types_authentication.go

everettraven · 2025-05-12T15:24:43Z

config/v1/types_authentication.go

+	// +optional
+	// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? isURL(self) : true",message="discoveryURL must be a valid URL"
+	// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? url(self).scheme == 'https' : true",message="discoveryURL must use https scheme"
+	// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? url(self).query == '' : true",message="discoveryURL must not contain query parameters"


This would need to be:

Suggested change

// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? url(self).query == '' : true",message="discoveryURL must not contain query parameters"

// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? url(self).getQuery() == '' : true",message="discoveryURL must not contain query parameters"

everettraven · 2025-05-12T15:25:31Z

config/v1/types_authentication.go

+	// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? url(self).user == '' : true",message="discoveryURL must not contain user info"
+	// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? url(self).fragment == '' : true",message="discoveryURL must not contain a fragment"


There doesn't appear to be a helper for user or fragment pieces of the URL - we should try to implement a Regular Expression that gets us the same validation we are looking for.

Signed-off-by: Shaza Aldawamneh <[email protected]>

openshift-ci · 2025-05-16T11:18:36Z

@ShazaAldawamneh: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/e2e-aws-serial-techpreview	`8b450f7`	link	true	`/test e2e-aws-serial-techpreview`
ci/prow/e2e-aws-serial	`8b450f7`	link	true	`/test e2e-aws-serial`
ci/prow/verify-feature-promotion	`a9bdac7`	link	true	`/test verify-feature-promotion`
ci/prow/verify	`a9bdac7`	link	true	`/test verify`
ci/prow/unit	`a9bdac7`	link	true	`/test unit`
ci/prow/verify-deps	`a9bdac7`	link	true	`/test verify-deps`
ci/prow/verify-client-go	`a9bdac7`	link	true	`/test verify-client-go`
ci/prow/minor-images	`a9bdac7`	link	true	`/test minor-images`
ci/prow/e2e-aws-ovn-hypershift	`a9bdac7`	link	true	`/test e2e-aws-ovn-hypershift`
ci/prow/e2e-gcp	`a9bdac7`	link	false	`/test e2e-gcp`
ci/prow/e2e-aws-ovn	`a9bdac7`	link	true	`/test e2e-aws-ovn`
ci/prow/minor-e2e-upgrade-minor	`a9bdac7`	link	true	`/test minor-e2e-upgrade-minor`
ci/prow/build	`a9bdac7`	link	true	`/test build`
ci/prow/e2e-aws-serial-techpreview-2of2	`a9bdac7`	link	true	`/test e2e-aws-serial-techpreview-2of2`
ci/prow/e2e-upgrade	`a9bdac7`	link	true	`/test e2e-upgrade`
ci/prow/e2e-aws-serial-1of2	`a9bdac7`	link	true	`/test e2e-aws-serial-1of2`
ci/prow/e2e-upgrade-out-of-change	`a9bdac7`	link	true	`/test e2e-upgrade-out-of-change`
ci/prow/e2e-aws-serial-techpreview-1of2	`a9bdac7`	link	true	`/test e2e-aws-serial-techpreview-1of2`
ci/prow/e2e-aws-ovn-hypershift-conformance	`a9bdac7`	link	true	`/test e2e-aws-ovn-hypershift-conformance`
ci/prow/e2e-azure	`a9bdac7`	link	false	`/test e2e-azure`
ci/prow/lint	`a9bdac7`	link	true	`/test lint`
ci/prow/integration	`a9bdac7`	link	true	`/test integration`
ci/prow/images	`a9bdac7`	link	true	`/test images`
ci/prow/e2e-aws-serial-2of2	`a9bdac7`	link	true	`/test e2e-aws-serial-2of2`
ci/prow/verify-crd-schema	`a9bdac7`	link	true	`/test verify-crd-schema`
ci/prow/okd-scos-e2e-aws-ovn	`a9bdac7`	link	false	`/test okd-scos-e2e-aws-ovn`
ci/prow/e2e-aws-ovn-techpreview	`a9bdac7`	link	true	`/test e2e-aws-ovn-techpreview`

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.

Add missing fields to auth config

7045b71

Signed-off-by: Shaza Aldawamneh <[email protected]>

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 2, 2025

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 2, 2025

openshift-ci bot requested review from deads2k and JoelSpeed May 2, 2025 11:07

ShazaAldawamneh changed the title ~~[WIP]Add missing fields to auth config~~ [WIP]: CNTRLPLANE-311: Add missing fields to auth config May 2, 2025

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 2, 2025

everettraven suggested changes May 2, 2025

View reviewed changes

Refine API validations, improve GoDocs, and align with CEL and union …

112a924

…conventions Signed-off-by: Shaza Aldawamneh <[email protected]>

openshift-ci 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 May 6, 2025

JoelSpeed reviewed May 9, 2025

View reviewed changes

added tests for new auth config fields and created a feature-gate for…

7408083

… those fields Signed-off-by: Shaza Aldawamneh <[email protected]>

openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 9, 2025

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 11, 2025

added fields behind the feature gate

f013825

Signed-off-by: Shaza Aldawamneh <[email protected]>

everettraven reviewed May 12, 2025

View reviewed changes

config/v1/types_authentication.go Outdated Show resolved Hide resolved

config/v1/types_authentication.go Show resolved Hide resolved

config/v1/types_authentication.go Outdated Show resolved Hide resolved

everettraven reviewed May 12, 2025

View reviewed changes

ShazaAldawamneh added 3 commits May 13, 2025 14:02

made adjusments to cover review comments

fd43f10

Signed-off-by: Shaza Aldawamneh <[email protected]>

made adjusments to cover review comments

8b450f7

Signed-off-by: Shaza Aldawamneh <[email protected]>

fixing tests

a9bdac7

Signed-off-by: Shaza Aldawamneh <[email protected]>

	// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? url(self).query == '' : true",message="discoveryURL must not contain query parameters"
	// +kubebuilder:validation:XValidation:rule="self.size() > 0 ? url(self).getQuery() == '' : true",message="discoveryURL must not contain query parameters"

[WIP]: CNTRLPLANE-311: Add missing fields to auth config #2304

Are you sure you want to change the base?

[WIP]: CNTRLPLANE-311: Add missing fields to auth config #2304

Uh oh!

Conversation

ShazaAldawamneh commented May 2, 2025

Uh oh!

openshift-ci bot commented May 2, 2025

Uh oh!

openshift-ci bot commented May 2, 2025

Uh oh!

openshift-ci-robot commented May 2, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

everettraven left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JoelSpeed May 9, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-merge-robot commented May 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

everettraven May 12, 2025

Choose a reason for hiding this comment

Uh oh!

everettraven May 12, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented May 16, 2025

Uh oh!

Uh oh!

openshift-ci-robot commented May 2, 2025 •

edited by openshift-ci bot

Loading