From 62dff8c0222c5e5a23b50a07ff2b18d93ba8f9c0 Mon Sep 17 00:00:00 2001 From: Hamed Karbasi Date: Fri, 19 Jan 2024 21:26:16 +0330 Subject: [PATCH] add description for the types --- api/v1alpha1/s3bucket_types.go | 2 +- api/v1alpha1/s3user_types.go | 1 + api/v1alpha1/s3userclaim_types.go | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/api/v1alpha1/s3bucket_types.go b/api/v1alpha1/s3bucket_types.go index 2b6f733..9356dbe 100644 --- a/api/v1alpha1/s3bucket_types.go +++ b/api/v1alpha1/s3bucket_types.go @@ -52,7 +52,7 @@ type S3BucketStatus struct { // +kubebuilder:printcolumn:name="S3USERREF",type=string,JSONPath=`.spec.s3UserRef` // +kubebuilder:resource:shortName=s3b -// S3Bucket is the Schema for the s3buckets API +// S3 Bucket Instance type S3Bucket struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` diff --git a/api/v1alpha1/s3user_types.go b/api/v1alpha1/s3user_types.go index 071e1fd..534f244 100644 --- a/api/v1alpha1/s3user_types.go +++ b/api/v1alpha1/s3user_types.go @@ -48,6 +48,7 @@ type S3UserStatus struct { // +kubebuilder:printcolumn:name="MAX BUCKETS",type=string,JSONPath=`.spec.quota.maxBuckets` // +kubebuilder:printcolumn:name="AGE",type=date,JSONPath=`.metadata.creationTimestamp` +// S3 User is created by the S3 User Claim instance. It's not applicable for the operator user. type S3User struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` diff --git a/api/v1alpha1/s3userclaim_types.go b/api/v1alpha1/s3userclaim_types.go index c9e0071..9719bac 100644 --- a/api/v1alpha1/s3userclaim_types.go +++ b/api/v1alpha1/s3userclaim_types.go @@ -61,6 +61,7 @@ type S3UserClaimStatus struct { // +kubebuilder:printcolumn:name="AGE",type=date,JSONPath=`.metadata.creationTimestamp` // +kubebuilder:resource:shortName=s3u +// S3 User Claim Instance type S3UserClaim struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"`