feat(KonnectGatewayControlPlane)!: add v1alpha2 version of KonnectGatewayControlPlane #502

alacuku · 2025-07-04T09:54:22Z

What this PR does / why we need it:
KonnectGatewayControlPlane v1alpha2 has been introduced.
The CreateControlPlaneRequest fields (name, description, clusterType, authType, cloudGateway, proxyUrls, labels) have been moved from the top level of spec into a new structured field: spec.createControlPlaneRequest.

Action required:

Update any manifests or code that reference these fields to use the new nested structure, e.g.:

spec:
  createControlPlaneRequest:
    name: my-control-plane
    clusterType: CLUSTER_TYPE_CONTROL_PLANE
    # ...other fields...

The old flat field layout is no longer supported in v1alpha2.

Which issue this PR fixes

Fixes:

Special notes for your reviewer:

PR Readiness Checklist:

Complete these before marking the PR as ready to review:

the CHANGELOG.md release notes have been updated to reflect significant changes

alacuku · 2025-07-04T10:00:46Z

These test failures for KonnectGatewayControlPlane v1alpha1 are related to the CRD's storage version (v1alpha2) and the absence of a conversion method between versions:

=== Failed
=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane/updates_not_allowed_for_status_conditions/konnect.authRef_change_is_allowed_when_cp_is_not_Programmed=True_nor_APIAuthValid=True (1.10s)
    testcase.go:165: 
                Error Trace:    /home/aldo/repos/kubernetes-configuration/test/crdsvalidation/common/testcase.go:178
                                                        /home/aldo/sdk/go1.24.4/src/runtime/asm_amd64.s:1700
                Error:          Received unexpected error:
                                KonnectGatewayControlPlane.konnect.konghq.com "test-jjtm2" is invalid: spec: Invalid value: "object": Name must be set for type Origin
    testcase.go:165: 
                Error Trace:    /home/aldo/repos/kubernetes-configuration/test/crdsvalidation/common/testcase.go:165
                Error:          Condition never satisfied
                Test:           TestKonnectGatewayControlPlane/updates_not_allowed_for_status_conditions/konnect.authRef_change_is_allowed_when_cp_is_not_Programmed=True_nor_APIAuthValid=True

=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane/updates_not_allowed_for_status_conditions (0.01s)

=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane/restriction_on_cluster_types/cluster_type_is_immutable_when_having_it_set_and_then_trying_to_unset_it (1.09s)
    testcase.go:165: 
                Error Trace:    /home/aldo/repos/kubernetes-configuration/test/crdsvalidation/common/testcase.go:175
                                                        /home/aldo/sdk/go1.24.4/src/runtime/asm_amd64.s:1700
                Error:          "KonnectGatewayControlPlane.konnect.konghq.com \"test-9rqb8\" is invalid: [<nil>: Invalid value: \"object\": no such key: status evaluating rule: spec.konnect.authRef is immutable when an entity is already Programmed, <nil>: Invalid value: \"object\": no such key: status evaluating rule: spec.konnect.authRef is immutable when an entity refers to a Valid API Auth Configuration]" does not contain "spec.cluster_type is immutable"
    testcase.go:165: 
                Error Trace:    /home/aldo/repos/kubernetes-configuration/test/crdsvalidation/common/testcase.go:165
                Error:          Condition never satisfied
                Test:           TestKonnectGatewayControlPlane/restriction_on_cluster_types/cluster_type_is_immutable_when_having_it_set_and_then_trying_to_unset_it

=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane/restriction_on_cluster_types (0.01s)

=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane (2.49s)

alacuku · 2025-07-04T11:02:12Z

These test failures for KonnectGatewayControlPlane v1alpha1 are related to the CRD's storage version (v1alpha2) and the absence of a conversion method between versions:

=== Failed
=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane/updates_not_allowed_for_status_conditions/konnect.authRef_change_is_allowed_when_cp_is_not_Programmed=True_nor_APIAuthValid=True (1.10s)
    testcase.go:165: 
                Error Trace:    /home/aldo/repos/kubernetes-configuration/test/crdsvalidation/common/testcase.go:178
                                                        /home/aldo/sdk/go1.24.4/src/runtime/asm_amd64.s:1700
                Error:          Received unexpected error:
                                KonnectGatewayControlPlane.konnect.konghq.com "test-jjtm2" is invalid: spec: Invalid value: "object": Name must be set for type Origin
    testcase.go:165: 
                Error Trace:    /home/aldo/repos/kubernetes-configuration/test/crdsvalidation/common/testcase.go:165
                Error:          Condition never satisfied
                Test:           TestKonnectGatewayControlPlane/updates_not_allowed_for_status_conditions/konnect.authRef_change_is_allowed_when_cp_is_not_Programmed=True_nor_APIAuthValid=True

=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane/updates_not_allowed_for_status_conditions (0.01s)

=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane/restriction_on_cluster_types/cluster_type_is_immutable_when_having_it_set_and_then_trying_to_unset_it (1.09s)
    testcase.go:165: 
                Error Trace:    /home/aldo/repos/kubernetes-configuration/test/crdsvalidation/common/testcase.go:175
                                                        /home/aldo/sdk/go1.24.4/src/runtime/asm_amd64.s:1700
                Error:          "KonnectGatewayControlPlane.konnect.konghq.com \"test-9rqb8\" is invalid: [<nil>: Invalid value: \"object\": no such key: status evaluating rule: spec.konnect.authRef is immutable when an entity is already Programmed, <nil>: Invalid value: \"object\": no such key: status evaluating rule: spec.konnect.authRef is immutable when an entity refers to a Valid API Auth Configuration]" does not contain "spec.cluster_type is immutable"
    testcase.go:165: 
                Error Trace:    /home/aldo/repos/kubernetes-configuration/test/crdsvalidation/common/testcase.go:165
                Error:          Condition never satisfied
                Test:           TestKonnectGatewayControlPlane/restriction_on_cluster_types/cluster_type_is_immutable_when_having_it_set_and_then_trying_to_unset_it

=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane/restriction_on_cluster_types (0.01s)

=== FAIL: test/crdsvalidation/konnect.konghq.com TestKonnectGatewayControlPlane (2.49s)

Skipping failing test in: c004108

test/crdsvalidation/konnect.konghq.com/konnectgatewaycontrolplane_test.go

api/konnect/v1alpha2/konnect_gateway_controlplane_types.go

CHANGELOG.md

pmalek

Looks good.

2 points I think we need to cover:

let's update the sample manifests in this repo with a note stating that this (v1alpha) API is deprecated and it shouldn't be used
let's make sure that we update the sample manifests in KGO when we change the controller logic to account for the new version

alacuku · 2025-07-07T09:26:15Z

let's make sure that we update the sample manifests in KGO when we change the controller logic to account for the new version

I'm already working on updating the controller logic and use the new API version. I would block this PR until I have the changes in place in the controller logic.

WDYT?

pmalek · 2025-07-07T09:31:13Z

let's make sure that we update the sample manifests in KGO when we change the controller logic to account for the new version

I'm already working on updating the controller logic and use the new API version. I would block this PR until I have the changes in place in the controller logic.

WDYT?

Sounds good.

This is a broader problem that I think we should tackle (get an agreed approach on), namely:

dev A makes breaking changes in kcfg and merges them (result commit C1)
he moves on to work on controller changes for this API change
dev B makes changes (breaking or not) in kcfg and merges them (result commit C2)
now dev B needs to wait for dev to update the kcfg dependency to C1 (or newer)

mlavacca

🚢

…ewayControlPlane `KonnectGatewayControlPlane` `v1alpha2` has been introduced. The `CreateControlPlaneRequest` fields (`name`, `description`, `clusterType`, `authType`, `cloudGateway`, `proxyUrls`, `labels`) have been moved from the top level of `spec` into a new structured field: `spec.createControlPlaneRequest`. **Action required:** - Update any manifests or code that reference these fields to use the new nested structure, e.g.: ```yaml spec: createControlPlaneRequest: name: my-control-plane clusterType: CLUSTER_TYPE_CONTROL_PLANE # ...other fields... ``` - The old flat field layout is no longer supported in `v1alpha2`. Signed-off-by: Aldo Lacuku <[email protected]>

test/crdsvalidation/konnect.konghq.com/konnectgatewaycontrolplane_test.go

api/konnect/v1alpha2/konnect_gateway_controlplane_types.go

api/konnect/v1alpha2/konnect_conditions.go

Signed-off-by: Aldo Lacuku <[email protected]>

alacuku force-pushed the kcl/konnect-konnectGatewayControlPlane-v1alpha2 branch 3 times, most recently from 33d0676 to c004108 Compare July 4, 2025 11:00

alacuku marked this pull request as ready for review July 4, 2025 11:05

alacuku requested a review from a team as a code owner July 4, 2025 11:05

pmalek requested changes Jul 4, 2025

View reviewed changes

pmalek reviewed Jul 7, 2025

View reviewed changes

alacuku force-pushed the kcl/konnect-konnectGatewayControlPlane-v1alpha2 branch from 7a25cce to 9ffddfb Compare July 8, 2025 07:43

alacuku mentioned this pull request Jul 8, 2025

feat(api): bump KonnectGatewayControlPlane to v1alpha2 Kong/kong-operator#1825

Merged

1 task

alacuku force-pushed the kcl/konnect-konnectGatewayControlPlane-v1alpha2 branch from 9ffddfb to c395eca Compare July 9, 2025 09:21

alacuku requested a review from pmalek July 9, 2025 09:39

alacuku force-pushed the kcl/konnect-konnectGatewayControlPlane-v1alpha2 branch 7 times, most recently from 4e1b5dc to 48dbfee Compare July 15, 2025 09:01

mlavacca self-assigned this Jul 15, 2025

mlavacca previously approved these changes Jul 15, 2025

View reviewed changes

programmer04 enabled auto-merge July 15, 2025 12:45

programmer04 removed the request for review from pmalek July 16, 2025 07:02

programmer04 disabled auto-merge July 16, 2025 07:03

alacuku force-pushed the kcl/konnect-konnectGatewayControlPlane-v1alpha2 branch from 996da7f to 1868c10 Compare July 21, 2025 08:15

alacuku force-pushed the kcl/konnect-konnectGatewayControlPlane-v1alpha2 branch from 1868c10 to 4dba134 Compare July 21, 2025 10:47

pmalek reviewed Jul 21, 2025

View reviewed changes

test/crdsvalidation/konnect.konghq.com/konnectgatewaycontrolplane_test.go Outdated Show resolved Hide resolved

api/konnect/v1alpha2/konnect_gateway_controlplane_types.go Outdated Show resolved Hide resolved

api/konnect/v1alpha2/konnect_conditions.go Outdated Show resolved Hide resolved

chore: apply review suggestions

9013f1d

Signed-off-by: Aldo Lacuku <[email protected]>

alacuku dismissed mlavacca’s stale review via 9013f1d July 21, 2025 15:50

chore: revert changes to condition types in v1alpha2

8c96f6f

Signed-off-by: Aldo Lacuku <[email protected]>

alacuku requested a review from pmalek July 22, 2025 08:37

pmalek approved these changes Jul 22, 2025

View reviewed changes

alacuku added this pull request to the merge queue Jul 22, 2025

Merged via the queue into main with commit c188bac Jul 22, 2025
25 checks passed

alacuku deleted the kcl/konnect-konnectGatewayControlPlane-v1alpha2 branch July 22, 2025 10:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(KonnectGatewayControlPlane)!: add v1alpha2 version of KonnectGatewayControlPlane #502

feat(KonnectGatewayControlPlane)!: add v1alpha2 version of KonnectGatewayControlPlane #502

alacuku commented Jul 4, 2025 •

edited

Loading

Uh oh!

alacuku commented Jul 4, 2025

Uh oh!

alacuku commented Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmalek left a comment •

edited

Loading

Uh oh!

alacuku commented Jul 7, 2025

Uh oh!

pmalek commented Jul 7, 2025

Uh oh!

mlavacca left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat(KonnectGatewayControlPlane)!: add v1alpha2 version of KonnectGatewayControlPlane #502

feat(KonnectGatewayControlPlane)!: add v1alpha2 version of KonnectGatewayControlPlane #502

Conversation

alacuku commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alacuku commented Jul 4, 2025

Uh oh!

alacuku commented Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmalek left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alacuku commented Jul 7, 2025

Uh oh!

pmalek commented Jul 7, 2025

Uh oh!

mlavacca left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alacuku commented Jul 4, 2025 •

edited

Loading

pmalek left a comment •

edited

Loading