Keystone: Endpoint controller by winiciusallan · Pull Request #614 · k-orc/openstack-resource-controller

winiciusallan · 2025-12-17T14:27:21Z

This PR introduces the Keystone Endpoint controller.

Fixes: #592

Reviewer notes:

At this time, Gophercloud requires the Name field on creation, and name is deprecated according to the docs, so since I can't omit it for now, I have decided to implement the controller with this field. I opened a PR to address it
Also, we couldn't set a value for the enabled field on creation neither on update, so I have to omit it mainly in the tests. This PR was opened to fix it,

go run ./cmd/scaffold-controller \ -interactive=false \ -kind Endpoint \ -gophercloud-client NewIdentityV3 \ -gophercloud-module github.com/gophercloud/gophercloud/v2/openstack/identity/v3/endpoints \ -required-create-dependency Service Signed-off-by: Winicius Silva <winiciusab12@gmail.com>

Signed-off-by: Winicius Silva <winiciusab12@gmail.com>

mandre

I wasn't sure at first, but I now believe we should wait for the next gophercloud release to avoid the introduction of a backward incompatible change in the API when we drop the Name field.

mandre · 2026-01-02T09:48:11Z

api/v1alpha1/endpoint_types.go

+	// +kubebuilder:default:=true
 	// +optional
-	Description *string `json:"description,omitempty"`
+	Enabled *bool `json:"enabled,omitempty"`


It feels like the Enabled field shouldn't be there until your gophercloud PR adding support for it makes it to a gophercloud release we can use in ORC. I see you've dropped Description that has the same issue.

Alternatively, we wait a bit for the next gophercloud release so that we have a clean PR from the start (we can include gophercloud/gophercloud#3581 in it too).

mandre · 2026-01-02T10:13:12Z

api/v1alpha1/endpoint_types.go

@@ -23,46 +23,43 @@ type EndpointResourceSpec struct {
 	// +optional
 	Name *OpenStackName `json:"name,omitempty"`


I'd prefer we do not merge this until we have removed the requirement for Name in gophercloud because this will be a breaking change in the ORC API. This is another argument for waiting for the next gophecloud release where you've had several improvements to the support of endpoint.

Since we bump for the new gophercloud release, I've removed the requirement for the name. Now, the endpoint controller is a NoNamedResource. I've removed references for this field on tests as well.

mandre · 2026-01-02T10:22:31Z

api/v1alpha1/endpoint_types.go

-	// description is a human-readable description for the resource.
+	// enabled indicates whether the endpoint is enabled or not.
+	// +optional
+	Enabled *bool `json:"enabled,omitempty"`


We can drop the pointer in the status.

I need to stop copy pasting field definitions on status 😅. Done!

mandre · 2026-01-02T10:24:31Z

api/v1alpha1/endpoint_types.go

+	Enabled *bool `json:"enabled,omitempty"`
+
+	// interface indicates the visibility of the endpoint.
+	// +kubebuilder:validation:Enum:=admin;internal;public


I think we want to drop the enum validation in the status and instead return whatever OpenStack gives us. We still want to have a MaxLength validation.

Yeah, it makes sense. Done!

README.md

cmd/resource-generator/main.go

...nal/controllers/endpoint/tests/endpoint-import-dependency/03-delete-import-dependencies.yaml

winiciusallan · 2026-01-07T13:11:01Z

Hey, sorry for the delay. Now that we have a new gophercloud release, can we get this one #628?

Once merged, I'll focus on addressing your comments and taking it further.

Also add redirects for pages we moved to that we don't break bookmarks.

Signed-off-by: Winicius Silva <winiciusab12@gmail.com>

This avoids issues when the resource name conflicts with existing resources and we can't use shortcuts in kubectl commands (e.g. service or role).

Signed-off-by: Winicius Silva <winiciusab12@gmail.com>

winiciusallan · 2026-01-07T23:49:18Z

@mandre I noticed that I missed a pointer on Description in endpoint.UpdateOpts 😅, so we are not able to unset that field; tests has been falling on endpoint-update. When we pass the zero-value, it omits the field and does not update it =/. I opened a PR for it.

Is it okay if we ignore it for now and implement it later (considering that a gophercloud release was launched recently)?

https://github.com/gophercloud/gophercloud/blob/main/openstack/identity/v3/endpoints/requests.go#L137

mandre · 2026-01-08T07:54:24Z

@mandre I noticed that I missed a pointer on Description in endpoint.UpdateOpts 😅, so we are not able to unset that field; tests has been falling on endpoint-update. When we pass the zero-value, it omits the field and does not update it =/. I opened a PR for it.

Is it okay if we ignore it for now and implement it later (considering that a gophercloud release was launched recently)?

Absolutely, let's make Description immutable for now. While your gophercloud patch is good, it's going to take time before we can consume your fix as we won't be able to backport to v2.

github-actions · 2026-01-10T01:15:59Z

Failed to assess the semver bump. See logs for details.

github-actions · 2026-01-10T01:20:18Z

Failed to assess the semver bump. See logs for details.

winiciusallan · 2026-01-10T01:37:01Z

I made a bit of mess with the commits here, sorry about that. I made a rebase instead of merging with the main branch. I think now it is good.

winiciusallan · 2026-01-10T01:42:33Z

I have amended the merge with the main branch in the last commit, it could be hard to review. I can revert and separate them if you prefer, sorry about that too =/.

mandre · 2026-02-05T07:38:59Z

Hey @winiciusallan, are you still working on this branch? From what I can tell, there are 3 significant commits:

e367bc0 (endpoint: generate code with scaffolding tool)
2783f0e (keystone: endpoint controller implementation)
50f2218 (change: drop name field, add description and enabled)

If you rebase on main, you should be able to drop the extra commits and fix the merge conflict on internal/controllers/port/actuator.go. If you feel this PR is ready to go, you might want to squash the last 2 commits together as well.

Let me know when this is ready for a final review.

winiciusallan · 2026-02-05T07:49:29Z

@mandre Hey, I'll work on the final adjustments today or tomorrow at the latest. I'll let you know when it'll be ready.

github-actions bot added the semver:major Breaking change label Dec 17, 2025

winiciusallan force-pushed the endpoint-controller branch from 635e6e1 to 16996dd Compare December 17, 2025 16:51

keystone: endpoint controller implementation

2783f0e

Signed-off-by: Winicius Silva <winiciusab12@gmail.com>

winiciusallan force-pushed the endpoint-controller branch from 16996dd to 2783f0e Compare December 17, 2025 17:14

mandre reviewed Jan 2, 2026

View reviewed changes

mandre and others added 6 commits January 7, 2026 13:26

README: fix broken link to dev docs

afefbc4

Also add redirects for pages we moved to that we don't break bookmarks.

port: add adminStateUp field

f79aa05

Signed-off-by: Winicius Silva <winiciusab12@gmail.com>

Get orc resources via their full names

ace2512

This avoids issues when the resource name conflicts with existing resources and we can't use shortcuts in kubectl commands (e.g. service or role).

port: add macaddress field

03823af

Signed-off-by: Winicius Silva <winiciusab12@gmail.com>

remove duplicated MACAddress and AdminStateUp status writing

95e605b

bump: gophercloud to v2.10.0

8712a02

github-actions bot removed the semver:major Breaking change label Jan 10, 2026

winiciusallan force-pushed the endpoint-controller branch from b59f331 to 8e505db Compare January 10, 2026 01:25

github-actions bot added the semver:major Breaking change label Jan 10, 2026

change: drop name field, add description and enabled

50f2218

winiciusallan force-pushed the endpoint-controller branch from 8e505db to 50f2218 Compare January 10, 2026 01:35

		@@ -23,46 +23,43 @@ type EndpointResourceSpec struct {
		// +optional
		Name *OpenStackName `json:"name,omitempty"`

Conversation

winiciusallan commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mandre left a comment

Choose a reason for hiding this comment

Uh oh!

mandre Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

mandre Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

winiciusallan Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

mandre Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

winiciusallan Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

mandre Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

winiciusallan Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

winiciusallan commented Jan 7, 2026

Uh oh!

winiciusallan commented Jan 7, 2026

Uh oh!

mandre commented Jan 8, 2026

Uh oh!

github-actions bot commented Jan 10, 2026

Uh oh!

github-actions bot commented Jan 10, 2026

Uh oh!

winiciusallan commented Jan 10, 2026

Uh oh!

winiciusallan commented Jan 10, 2026

Uh oh!

mandre commented Feb 5, 2026

Uh oh!

winiciusallan commented Feb 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

winiciusallan commented Dec 17, 2025 •

edited

Loading