Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions PROJECT
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ resources:
kind: Domain
path: github.com/k-orc/openstack-resource-controller/api/v1alpha1
version: v1alpha1
- api:
crdVersion: v1
namespaced: true
domain: k-orc.cloud
group: openstack
kind: Endpoint
path: github.com/k-orc/openstack-resource-controller/api/v1alpha1
version: v1alpha1
- api:
crdVersion: v1
namespaced: true
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ kubectl delete -f $ORC_RELEASE
| **controller** | **1.x** | **2.x** | **main** |
|:---------------------------:|:-------:|:-------:|:--------:|
| domain | | ✔ | ✔ |
| endpoint | | ◐ | ◐ |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we can make it a ✔ when we're based on a newer gophercloud.

| flavor | | ✔ | ✔ |
| floating ip | | ◐ | ◐ |
| group | | ✔ | ✔ |
Expand All @@ -87,7 +88,6 @@ kubectl delete -f $ORC_RELEASE
| volume type | | ◐ | ◐ |



✔: mostly implemented

◐: partially implemented
Expand Down
90 changes: 90 additions & 0 deletions api/v1alpha1/endpoint_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
/*
Copyright 2025 The ORC Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1alpha1

// EndpointResourceSpec contains the desired state of the resource.
type EndpointResourceSpec struct {
// name will be the name of the created resource. If not specified, the
// name of the ORC object will be used.
// +optional
Name *OpenStackName `json:"name,omitempty"`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


// enabled indicates whether the endpoint is enabled or not.
// +kubebuilder:default:=true
// +optional
Enabled *bool `json:"enabled,omitempty"`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).


// interface indicates the visibility of the endpoint.
// +kubebuilder:validation:Enum:=admin;internal;public
// +required
Interface string `json:"interface,omitempty"`

// url is the endpoint URL.
// +kubebuilder:validation:MaxLength=1024
// +required
URL string `json:"url"`

// serviceRef is a reference to the ORC Service which this resource is associated with.
// +required
// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="serviceRef is immutable"
ServiceRef KubernetesNameRef `json:"serviceRef,omitempty"`
}

// EndpointFilter defines an existing resource by its properties
// +kubebuilder:validation:MinProperties:=1
type EndpointFilter struct {
// interface of the existing endpoint.
// +kubebuilder:validation:Enum:=admin;internal;public
// +optional
Interface string `json:"interface,omitempty"`

// serviceRef is a reference to the ORC Service which this resource is associated with.
// +optional
ServiceRef *KubernetesNameRef `json:"serviceRef,omitempty"`

// url is the URL of the existing endpoint.
// +kubebuilder:validation:MaxLength=1024
// +optional
URL string `json:"url,omitempty"`
}

// EndpointResourceStatus represents the observed state of the resource.
type EndpointResourceStatus struct {
// name is a Human-readable name for the resource. Might not be unique.
// +kubebuilder:validation:MaxLength=1024
// +optional
Name string `json:"name,omitempty"`

// enabled indicates whether the endpoint is enabled or not.
// +optional
Enabled *bool `json:"enabled,omitempty"`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can drop the pointer in the status.


// interface indicates the visibility of the endpoint.
// +kubebuilder:validation:Enum:=admin;internal;public
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

// +optional
Interface string `json:"interface,omitempty"`

// url is the endpoint URL.
// +kubebuilder:validation:MaxLength=1024
// +optional
URL string `json:"url,omitempty"`

// serviceID is the ID of the Service to which the resource is associated.
// +kubebuilder:validation:MaxLength=1024
// +optional
ServiceID string `json:"serviceID,omitempty"`
}
212 changes: 212 additions & 0 deletions api/v1alpha1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading