Skip to content

Feature - Directory Bucket Support (S3 Express) #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Feature - Directory Bucket Support (S3 Express) #187

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6e7373d
Remove Ignored Fields, modify locationConstraint override and generat…
Itai-Melamed Oct 22, 2025
060d4ba
fix "type_" scheme override
Itai-Melamed Oct 22, 2025
be57139
modify management operations that are not supported for Directory buc…
Itai-Melamed Oct 23, 2025
41b0082
support tagging operations
Itai-Melamed Oct 23, 2025
eb542a7
fix attribution file mismatch check
Itai-Melamed Oct 29, 2025
80c851e
better validation for invalid Directory Bucket configuration
Itai-Melamed Oct 29, 2025
03dc43d
remove unnecessary operation override in generator.yaml (customFindBu…
Itai-Melamed Oct 29, 2025
b1dde85
regenerate code using s3-controller
Itai-Melamed Oct 29, 2025
0ba503e
Add unit test for IsDirectoryBucketName function
Itai-Melamed Oct 29, 2025
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
12 changes: 6 additions & 6 deletions apis/v1alpha1/ack-generate-metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
ack_generate_info:
build_date: "2025-09-19T17:20:43Z"
build_hash: 6b4211163dcc34776b01da9a18217bac0f4103fd
go_version: go1.24.6
version: v0.52.0
api_directory_checksum: 2108338a86d704419192e545c0bfb433bab8c836
build_date: "2025-10-23T09:42:09Z"
build_hash: eaabefb6bd7b2be8a1baf4478f22b3310e6921c8
go_version: go1.25.3
version: v0.52.0-6-geaabefb-dirty
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you need to modify the ackgenerate tool to make these changes? If not could you rebuild the controller with an unmodified version.

Copy link
Author

Choose a reason for hiding this comment

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

I'm not sure what caused this change, I assumed the ack-generate tool updated some metadata and didn't think much of it. I don't think it is crucial to the implementation.

Could you maybe elaborate on how to know what the actual values should be?

api_directory_checksum: e4d609df16764c73dfe31eed33d0e3ab120af8e9
api_version: v1alpha1
aws_sdk_go_version: v1.32.6
generator_config_info:
file_checksum: 00a96da29786586c7a3a59666d5546468e616b48
file_checksum: c00ccde5df5a3b78d6da668d949f58e1551c3826
original_file_name: generator.yaml
last_modification:
reason: API generation
16 changes: 14 additions & 2 deletions apis/v1alpha1/generator.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,17 @@ ignore:
- "VersioningConfiguration.MFADelete"
# This subfield struct has no members...
- "NotificationConfiguration.EventBridgeConfiguration"
- CreateBucketInput.CreateBucketConfiguration.Location
- CreateBucketInput.CreateBucketConfiguration.Bucket
- LoggingEnabled.TargetObjectKeyFormat
operations:
ListDirectoryBuckets:
Copy link
Contributor

Choose a reason for hiding this comment

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

With customFindBucket being used is this still needed?

Copy link
Author

Choose a reason for hiding this comment

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

Don't think it is. it was probably here since a previous iteration when the SDK automatically assumed ListBucket as the list operation which is not supported for directory buckets.

operation_type:
- List
resource_name:
- Bucket
resources:
Bucket:
find_operation:
custom_method_name: customFindBucket
fields:
Name:
is_primary_key: true
Expand Down Expand Up @@ -58,6 +64,12 @@ resources:
# Forcing CRD field to "uRI" to avoid breaking change following
# fix in aws-controller-k8s/pkg dependency for URI -> uri.
go_tag: json:"uRI,omitempty"
CreateBucketConfiguration.Bucket.Type:
# Override json tag to use "type" instead of "type_" to avoid underscore in CRD
go_tag: json:"type,omitempty"
CreateBucketConfiguration.Location.Type:
# Override json tag to use "type" instead of "type_" to avoid underscore in CRD
go_tag: json:"type,omitempty"
Metrics:
custom_field:
list_of: MetricsConfiguration
Expand Down
54 changes: 38 additions & 16 deletions apis/v1alpha1/types.go
View file
Open in desktop

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

100 changes: 60 additions & 40 deletions apis/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

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

30 changes: 29 additions & 1 deletion config/crd/bases/s3.services.k8s.aws_buckets.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.2
controller-gen.kubebuilder.io/version: v0.19.0
name: buckets.s3.services.k8s.aws
spec:
group: s3.services.k8s.aws
Expand Down Expand Up @@ -171,6 +171,34 @@ spec:
createBucketConfiguration:
description: The configuration information for the bucket.
properties:
bucket:
description: |-
Specifies the information about the bucket that will be created. For more
information about directory buckets, see Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)
in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.
properties:
dataRedundancy:
type: string
type:
type: string
type: object
location:
description: |-
Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone or Local Zone.
For more information about directory buckets, see Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)
in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.
properties:
name:
type: string
type:
type: string
type: object
locationConstraint:
type: string
type: object
Expand Down
16 changes: 14 additions & 2 deletions generator.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,17 @@ ignore:
- "VersioningConfiguration.MFADelete"
# This subfield struct has no members...
- "NotificationConfiguration.EventBridgeConfiguration"
- CreateBucketInput.CreateBucketConfiguration.Location
- CreateBucketInput.CreateBucketConfiguration.Bucket
- LoggingEnabled.TargetObjectKeyFormat
operations:
ListDirectoryBuckets:
operation_type:
- List
resource_name:
- Bucket
resources:
Bucket:
find_operation:
custom_method_name: customFindBucket
fields:
Name:
is_primary_key: true
Expand Down Expand Up @@ -58,6 +64,12 @@ resources:
# Forcing CRD field to "uRI" to avoid breaking change following
# fix in aws-controller-k8s/pkg dependency for URI -> uri.
go_tag: json:"uRI,omitempty"
CreateBucketConfiguration.Bucket.Type:
# Override json tag to use "type" instead of "type_" to avoid underscore in CRD
go_tag: json:"type,omitempty"
CreateBucketConfiguration.Location.Type:
# Override json tag to use "type" instead of "type_" to avoid underscore in CRD
go_tag: json:"type,omitempty"
Metrics:
custom_field:
list_of: MetricsConfiguration
Expand Down
Loading