SwiftContainer: add controller#824
Open
eshulman2 wants to merge 7 commits into
Open
Conversation
winiciusallan
left a comment
winiciusallan
left a comment
Member
There was a problem hiding this comment.
Hey @eshulman2, thanks for the PR!
I did a round of review through the API and left other comments inline. Will take some time to look how CRUD operations are being performed and the tests :).
| // comma-separated list of account/container combinations. | ||
| // +kubebuilder:validation:MaxLength:=256 | ||
| // +optional | ||
| ContainerWrite *string `json:"containerWrite,omitempty"` |
| } | ||
|
|
||
| // SwiftContainerResourceSpec contains the desired state of a Swift container. | ||
| type SwiftContainerResourceSpec struct { |
Member
There was a problem hiding this comment.
There are other fields that we could implement in the ResourceSpec, but I'm okay leaving as it is and add them later.
eshulman2
force-pushed
the
swiftcontainer-controller
branch
from
2fb1881 to
c85a5da
Compare
Scaffold the SwiftContainer controller using the controller generator: $ go run ./cmd/scaffold-controller -interactive=false -kind=SwiftContainer -gophercloud-client=NewObjectStorageV1 -gophercloud-module=github.com/gophercloud/gophercloud/v2/openstack/objectstorage/v1/containers -gophercloud-type=Container -openstack-json-object=container
Add the SwiftContainer API, generated clients, OpenStack client wrapper, controller wiring, status writer, and reconciliation logic. Swift containers are name-addressed, so the controller uses the container name as the ORC status ID and adds custom import handling for name-based imports.
Add unit coverage for Swift container import, adoption, creation, validation, and OpenStack client behavior. Add KUTTL suites for minimal and full creation, import success and failure, updates, and name validation, and enable Swift in the E2E environment.
Document SwiftContainer in the resource matrix and generated CRD reference, and add example manifests for create and import workflows.
eshulman2
force-pushed
the
swiftcontainer-controller
branch
from
222add3 to
ab62b5d
Compare
| // and 256 characters long and must not contain forward slashes. | ||
| // +kubebuilder:validation:MinLength:=1 | ||
| // +kubebuilder:validation:MaxLength:=256 | ||
| // +kubebuilder:validation:Pattern:=`^[^/]+$` |
Member
There was a problem hiding this comment.
What do you think of adding a XValidation here instead of a Pattern so we can return a clear message to the user? Something like:
// +kubebuilder:validation:XValidation:rule="self.matches('^[^/]+$')",message="names must no contain forward slashes"
Comment on lines
+197
to
+207
| createOpts := containers.CreateOpts{} | ||
|
|
||
| if resource.ContainerRead != "" { | ||
| createOpts.ContainerRead = resource.ContainerRead | ||
| } | ||
| if resource.ContainerWrite != "" { | ||
| createOpts.ContainerWrite = resource.ContainerWrite | ||
| } | ||
| if resource.StoragePolicy != "" { | ||
| createOpts.StoragePolicy = resource.StoragePolicy | ||
| } |
Member
There was a problem hiding this comment.
I think we can extract this code to the following
Suggested change
| createOpts := containers.CreateOpts{} | |
| if resource.ContainerRead != "" { | |
| createOpts.ContainerRead = resource.ContainerRead | |
| } | |
| if resource.ContainerWrite != "" { | |
| createOpts.ContainerWrite = resource.ContainerWrite | |
| } | |
| if resource.StoragePolicy != "" { | |
| createOpts.StoragePolicy = resource.StoragePolicy | |
| } | |
| createOpts := containers.CreateOpts{ | |
| ContainerRead: resource.ContainerRead | |
| ContainerWrite: resource.ContainerWrite | |
| StoragePolicy: resource.StoragePolicy | |
| } |
If the field is an empty string, it won't be parsed into a map in Gophercloud.
https://github.com/gophercloud/gophercloud/blob/main/params.go#L495
| // that when specifying an import by name, the resource MUST already exist. | ||
| // The ORC object will enter an error state if the resource does not exist. | ||
| // +optional | ||
| Name *SwiftContainerName `json:"name,omitempty"` |
Member
There was a problem hiding this comment.
Would you mind explain what is the difference between this Name here (spec.import.name) and in spec.import.filter.name?
Member
There was a problem hiding this comment.
I believe this file is useless for us since we have committed this directory with changes.
Comment on lines
+178
to
+185
| // Swift treats '/' as a path separator in container names, making the name | ||
| // invalid at the API level. Validate explicitly to provide a clear error | ||
| // message rather than a confusing HTTP error from gophercloud. | ||
| if strings.Contains(name, "/") { | ||
| return nil, progress.WrapError( | ||
| orcerrors.Terminal(orcv1alpha1.ConditionReasonInvalidConfiguration, | ||
| "container name must not contain forward slashes")) | ||
| } |
Member
There was a problem hiding this comment.
I believe this is already caught by the CEL validation in the API.
| // MaxLength:=256 marker counts Unicode code points, not bytes, so a name | ||
| // with multi-byte UTF-8 characters can pass API validation yet exceed the | ||
| // byte limit. Validate explicitly here to produce a clear error message. | ||
| if len(name) > 256 { |
Member
There was a problem hiding this comment.
The same as the above validation.
| that the observed state corresponds to the spec. | ||
|
|
||
| Also validate that the OpenStack resource uses the name of the ORC object when | ||
| `spec.resource.name` is not specified (SC-001). |
Member
There was a problem hiding this comment.
I believe this is a downstream reference
Suggested change
| `spec.resource.name` is not specified (SC-001). | |
| `spec.resource.name` is not specified. |
| metadata: | ||
| name: swiftcontainer-create-minimal | ||
| status: | ||
| resource: |
Member
There was a problem hiding this comment.
We're missing storagePolicy here. IIRC, a fresh devstack install use Policy-0 when no default policy is configured.
|
|
||
| Validates that: | ||
| - The OpenStack resource uses the name from `spec.resource.name` when it is | ||
| specified, rather than the ORC object name (SC-002). |
Member
There was a problem hiding this comment.
Downstream reference
Suggested change
| specified, rather than the ORC object name (SC-002). | |
| specified, rather than the ORC object name. |
| - The import filter matches the container with exact name (not a superstring). | ||
| - `status.id` is populated with the imported container name. | ||
| - Adoption from unmanaged import to available state works without recreating | ||
| the container (SC-003). |
Member
There was a problem hiding this comment.
From my search I think this is the last one :)
Suggested change
| the container (SC-003). | |
| the container. |
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
2 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.
Summary