[feat] Add ObjectStorageKey (#426)

Author: bcm820

PROJECT

@@ -153,4 +153,16 @@ resources:
     conversion: true
     validation: true
     webhookVersion: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: cluster.x-k8s.io
+  group: infrastructure
+  kind: LinodeObjectStorageKey
+  path: github.com/linode/cluster-api-provider-linode/api/v1alpha2
+  version: v1alpha2
+  webhooks:
+    validation: true
+    webhookVersion: v1
 version: "3"

api/v1alpha2/linodeobjectstoragekey_types.go

@@ -0,0 +1,129 @@
+/*
+Copyright 2023 Akamai Technologies, Inc.
+
+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 v1alpha2
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+)
+
+const (
+	// ObjectStorageKeyFinalizer allows ReconcileLinodeObjectStorageKey to clean up Linode resources associated
+	// with LinodeObjectStorageKey before removing it from the apiserver.
+	ObjectStorageKeyFinalizer = "linodeobjectstoragekey.infrastructure.cluster.x-k8s.io"
+)
+
+type BucketAccessRef struct {
+	BucketName  string `json:"bucketName"`
+	Permissions string `json:"permissions"`
+	Region      string `json:"region"`
+}
+
+// LinodeObjectStorageKeySpec defines the desired state of LinodeObjectStorageKey
+type LinodeObjectStorageKeySpec struct {
+	// BucketAccess is the list of object storage bucket labels which can be accessed using the key
+	// +kubebuilder:validation:MinItems=1
+	BucketAccess []BucketAccessRef `json:"bucketAccess"`
+
+	// CredentialsRef is a reference to a Secret that contains the credentials to use for generating access keys.
+	// If not supplied then the credentials of the controller will be used.
+	// +optional
+	CredentialsRef *corev1.SecretReference `json:"credentialsRef"`
+
+	// KeyGeneration may be modified to trigger a rotation of the access key.
+	// +kubebuilder:default=0
+	KeyGeneration int `json:"keyGeneration"`
+
+	// SecretType instructs the controller what type of secret to generate containing access key details.
+	// +kubebuilder:validation:Enum=Opaque;addons.cluster.x-k8s.io/resource-set
+	// +kubebuilder:default=Opaque
+	// +optional
+	SecretType corev1.SecretType `json:"secretType,omitempty"`
+}
+
+// LinodeObjectStorageKeyStatus defines the observed state of LinodeObjectStorageKey
+type LinodeObjectStorageKeyStatus struct {
+	// Ready denotes that the key has been provisioned.
+	// +optional
+	// +kubebuilder:default=false
+	Ready bool `json:"ready"`
+
+	// FailureMessage will be set in the event that there is a terminal problem
+	// reconciling the Object Storage Key and will contain a verbose string
+	// suitable for logging and human consumption.
+	// +optional
+	FailureMessage *string `json:"failureMessage,omitempty"`
+
+	// Conditions specify the service state of the LinodeObjectStorageKey.
+	// +optional
+	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
+
+	// CreationTime specifies the creation timestamp for the secret.
+	// +optional
+	CreationTime *metav1.Time `json:"creationTime,omitempty"`
+
+	// LastKeyGeneration tracks the last known value of .spec.keyGeneration.
+	// +optional
+	LastKeyGeneration *int `json:"lastKeyGeneration,omitempty"`
+
+	// SecretName specifies the name of the Secret containing access key data.
+	// +optional
+	SecretName *string `json:"secretName,omitempty"`
+
+	// AccessKeyRef stores the ID for Object Storage key provisioned.
+	// +optional
+	AccessKeyRef *int `json:"accessKeyRef,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:path=linodeobjectstoragekeys,scope=Namespaced,categories=cluster-api,shortName=lobjkey
+// +kubebuilder:subresource:status
+// +kubebuilder:metadata:labels="clusterctl.cluster.x-k8s.io/move-hierarchy=true"
+// +kubebuilder:printcolumn:name="ID",type="string",JSONPath=".status.accessKeyRef",description="The ID assigned to the access key"
+// +kubebuilder:printcolumn:name="Secret",type="string",JSONPath=".status.secretName",description="The name of the Secret containing access key data"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.ready",description="Whether the access key is synced in the Linode API"
+
+// LinodeObjectStorageKey is the Schema for the linodeobjectstoragekeys API
+type LinodeObjectStorageKey struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   LinodeObjectStorageKeySpec   `json:"spec,omitempty"`
+	Status LinodeObjectStorageKeyStatus `json:"status,omitempty"`
+}
+
+func (b *LinodeObjectStorageKey) GetConditions() clusterv1.Conditions {
+	return b.Status.Conditions
+}
+
+func (b *LinodeObjectStorageKey) SetConditions(conditions clusterv1.Conditions) {
+	b.Status.Conditions = conditions
+}
+
+// +kubebuilder:object:root=true
+
+// LinodeObjectStorageKeyList contains a list of LinodeObjectStorageKey
+type LinodeObjectStorageKeyList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []LinodeObjectStorageKey `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&LinodeObjectStorageKey{}, &LinodeObjectStorageKeyList{})
+}

api/v1alpha2/zz_generated.deepcopy.go

@@ -65,6 +65,7 @@ func validateObjectStorageBucketScopeParams(params ObjectStorageBucketScopeParam
 	return nil
 }
 
+//nolint:dupl // TODO: Remove fields related to key provisioning from the bucket resource.
 func NewObjectStorageBucketScope(ctx context.Context, apiKey string, params ObjectStorageBucketScopeParams) (*ObjectStorageBucketScope, error) {
 	if err := validateObjectStorageBucketScopeParams(params); err != nil {
 		return nil, err

cloud/scope/object_storage_bucket.go

@@ -296,7 +296,7 @@ func TestObjectStorageBucketScopeMethods(t *testing.T) {
 	}
 }
 
-func TestGenerateKeySecret(t *testing.T) {
+func TestGenerateKeySecretBucket(t *testing.T) {
 	t.Parallel()
 	tests := []struct {
 		name        string