chore: add v2alpha1 group and add ControlPlane type - #441
Merged
Conversation
pmalek
force-pushed
the
ko-controlplane-crd
branch
3 times, most recently
from
May 28, 2025 14:48
a60ec58 to
179dde6
Compare
pmalek
force-pushed
the
ko-controlplane-crd
branch
from
May 28, 2025 14:55
179dde6 to
72293bb
Compare
pmalek
marked this pull request as ready for review
May 28, 2025 15:04
pmalek
commented
Jun 2, 2025
programmer04
approved these changes
Jun 2, 2025
Co-authored-by: Jakub Warczarek <jakub.warczarek@gmail.com>
Member
Author
|
Letting @mlavacca chip in on the review and thus leaving this unmerged for now. |
Co-authored-by: Jintao Zhang <zhangjintao9020@gmail.com>
tao12345666333
approved these changes
Jun 3, 2025
pmalek
commented
Jun 3, 2025
mlavacca
requested changes
Jun 3, 2025
randmonkey
reviewed
Jun 4, 2025
mlavacca
reviewed
Jun 4, 2025
…at enabled is set for controllers and featureGates
pmalek
force-pushed
the
ko-controlplane-crd
branch
from
June 6, 2025 11:18
45fa28a to
01289db
Compare
pmalek
force-pushed
the
ko-controlplane-crd
branch
from
June 6, 2025 11:31
01289db to
bc8a3b1
Compare
Member
Author
|
@mlavacca This is ready for review once more. PTAL. |
pmalek
commented
Jun 6, 2025
Comment on lines
+164
to
+168
| // ControlPlaneDataPlaneTargetManagedByType indicates that the DataPlane target | ||
| // is managed by the owner of the ControlPlane. | ||
| // This is the case when using a Gateway resource to manage the DataPlane | ||
| // and the ControlPlane is responsible for configuring it. | ||
| ControlPlaneDataPlaneTargetManagedByType ControlPlaneDataPlaneTargetType = "managedByOwner" |
Member
Author
There was a problem hiding this comment.
I've tried constraining the created ControlPlane with this target type to ensure that it has an owner set but CEL doesn't allow it for some reason:
The CustomResourceDefinition "controlplanes.gateway-operator.konghq.com" is invalid: spec.versions[1].schema.openAPIV3Schema.x-kubernetes-validations[0].rule: Invalid value: apiextensions.ValidationRule{Rule:"self.spec.dataplane.type != 'managedByOwner' || self.ownerReferences[0].kind == 'Gateway'", Message:"X", MessageExpression:"", Reason:(*apiextensions.FieldValueErrorReason)(nil), FieldPath:"", OptionalOldSelf:(*bool)(nil)}: compilation failed: ERROR: <input>:1:53: undefined field 'ownerReferences'
| self.spec.dataplane.type != 'managedByOwner' || self.ownerReferences[0].kind == 'Gateway'
| ....................................................^
slack thread asking about the reason and the comprehensive list of allowed metadata fields to use in CEL: https://kubernetes.slack.com/archives/C0EG7JC6T/p1749212565802129
Member
Author
There was a problem hiding this comment.
This is explained in https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/
The apiVersion, kind, metadata.name and metadata.generateName are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.
So we can't do this validation (at this moment) via CEL.
mlavacca
reviewed
Jun 6, 2025
mlavacca
left a comment
mlavacca
left a comment
Member
There was a problem hiding this comment.
Mostly lgtm, just one nit about validation
This was
linked to
issues
Jun 6, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR adds a
ControlPlaneversion:v2alpha1which contains the following breaking changes with respect tov1beta1:deploymentfielddataplanefield from*stringto a typed union field which can be set to either a url (of Admin API) or a name ofDataPlaneresource (the same use case as with olddataplanefield)featureGates,controllersandadminAPIfields. The first 2 have string based arrays instead of strongly types fields (most likely the direction we'll move forward with but can potentially be changed based on feedback).CRD validation tests have not been added (yet) to allow feedback which could influence the design.
Which issue this PR fixes
Part of Kong/kong-operator#1358
Special notes for your reviewer:
Further changes to the new
v2alpha1API (like new, individual fields) will be added when this PR gets reviewed so that throw away work is avoided.PR Readiness Checklist:
Complete these before marking the PR as
ready to review:CHANGELOG.mdrelease notes have been updated to reflect significant changes