Merge pull request kubernetes-retired#9 from rrati/bucket-controller

Added bucket controller

Author: k8s-ci-robot

pkg/controller/bucket/bucket_controller.go

@@ -0,0 +1,200 @@
+/*
+Copyright 2020 The Kubernetes 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 bucket
+
+import (
+	"context"
+	"fmt"
+	"strings"
+	"time"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	utilversion "k8s.io/apimachinery/pkg/util/version"
+
+	kubeclientset "k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/util/retry"
+	"k8s.io/client-go/util/workqueue"
+
+	"github.com/kubernetes-sigs/container-object-storage-interface-api/apis/objectstorage.k8s.io/v1alpha1"
+	bucketclientset "github.com/kubernetes-sigs/container-object-storage-interface-api/clientset"
+	"github.com/kubernetes-sigs/container-object-storage-interface-api/controller"
+
+	osspec "github.com/kubernetes-sigs/container-object-storage-interface-spec"
+
+	"k8s.io/klog"
+
+	"golang.org/x/time/rate"
+)
+
+// bucketListener manages Bucket objects
+type bucketListener struct {
+	kubeClient        kubeclientset.Interface
+	bucketClient      bucketclientset.Interface
+	provisionerClient osspec.ProvisionerClient
+
+	// The name of the provisioner for which this controller dynamically
+	// provisions buckets.
+	provisionerName string
+	kubeVersion     *utilversion.Version
+}
+
+// NewBucketController returns a controller that manages Bucket objects
+func NewBucketController(provisionerName string, client osspec.ProvisionerClient) (*controller.ObjectStorageController, error) {
+	rateLimit := workqueue.NewMaxOfRateLimiter(
+		workqueue.NewItemExponentialFailureRateLimiter(5*time.Second, 60*time.Minute),
+		&workqueue.BucketRateLimiter{Limiter: rate.NewLimiter(rate.Limit(10), 100)},
+	)
+
+	identity := fmt.Sprintf("object-storage-sidecar-%s", provisionerName)
+	bc, err := controller.NewObjectStorageController(identity, "bucket-controller", 5, rateLimit)
+	if err != nil {
+		return nil, err
+	}
+
+	bl := bucketListener{
+		provisionerName:   provisionerName,
+		provisionerClient: client,
+	}
+	bc.AddBucketListener(&bl)
+
+	return bc, nil
+}
+
+// InitializeKubeClient initializes the kubernetes client
+func (bl *bucketListener) InitializeKubeClient(k kubeclientset.Interface) {
+	bl.kubeClient = k
+
+	serverVersion, err := k.Discovery().ServerVersion()
+	if err != nil {
+		klog.Errorf("unable to get server version: %v", err)
+	} else {
+		bl.kubeVersion = utilversion.MustParseSemantic(serverVersion.GitVersion)
+	}
+}
+
+// InitializeBucketClient initializes the object storage bucket client
+func (bl *bucketListener) InitializeBucketClient(bc bucketclientset.Interface) {
+	bl.bucketClient = bc
+}
+
+// Add will call the provisioner and add a bucket
+func (bl *bucketListener) Add(ctx context.Context, obj *v1alpha1.Bucket) error {
+	klog.V(1).Infof("bucketListener: add called for bucket %s", obj.Name)
+
+	// Verify this bucket is for this provisioner
+	if !strings.EqualFold(obj.Spec.Provisioner, bl.provisionerName) {
+		return nil
+	}
+
+	req := osspec.ProvisionerCreateBucketRequest{
+		BucketName:    obj.Name,
+		BucketContext: obj.Spec.Parameters,
+	}
+
+	req.BucketContext["ProtocolVersion"] = obj.Spec.Protocol.Version
+
+	if obj.Spec.AnonymousAccessMode.Private {
+		req.AnonymousBucketAccessMode = osspec.ProvisionerCreateBucketRequest_BUCKET_PRIVATE
+	} else if obj.Spec.AnonymousAccessMode.PublicReadOnly {
+		req.AnonymousBucketAccessMode = osspec.ProvisionerCreateBucketRequest_BUCKET_READ_ONLY
+	} else if obj.Spec.AnonymousAccessMode.PublicReadWrite {
+		req.AnonymousBucketAccessMode = osspec.ProvisionerCreateBucketRequest_BUCKET_WRITE_ONLY
+	} else if obj.Spec.AnonymousAccessMode.PublicWriteOnly {
+		req.AnonymousBucketAccessMode = osspec.ProvisionerCreateBucketRequest_BUCKET_READ_WRITE
+	}
+
+	// TODO set grpc timeout
+	rsp, err := bl.provisionerClient.ProvisionerCreateBucket(ctx, &req)
+	if err != nil {
+		klog.Errorf("error calling ProvisionerCreateBucket: %v", err)
+		return err
+	}
+	klog.V(1).Infof("provisioner returned create bucket response %v", rsp)
+
+	// TODO update the bucket protocol in the bucket spec
+
+	// update bucket availability to true
+	return bl.updateStatus(ctx, obj.Name, "Bucket Provisioned", true)
+}
+
+// Update does nothing
+func (bl *bucketListener) Update(ctx context.Context, old, new *v1alpha1.Bucket) error {
+	klog.V(1).Infof("bucketListener: update called for bucket %s", old.Name)
+	return nil
+}
+
+// Delete will call the provisioner and delete a bucket
+func (bl *bucketListener) Delete(ctx context.Context, obj *v1alpha1.Bucket) error {
+	klog.V(1).Infof("bucketListener: delete called for bucket %s", obj.Name)
+
+	// Verify this bucket is for this provisioner
+	if !strings.EqualFold(obj.Spec.Provisioner, bl.provisionerName) {
+		return nil
+	}
+
+	req := osspec.ProvisionerDeleteBucketRequest{
+		BucketContext: obj.Spec.Parameters,
+	}
+
+	switch obj.Spec.Protocol.Name {
+	case v1alpha1.ProtocolNameS3:
+		req.BucketName = obj.Spec.Protocol.S3.BucketName
+		req.BucketContext["Region"] = obj.Spec.Protocol.S3.Region
+		req.BucketContext["SignatureVersion"] = string(obj.Spec.Protocol.S3.SignatureVersion)
+		req.BucketContext["Endpoint"] = obj.Spec.Protocol.S3.Endpoint
+	case v1alpha1.ProtocolNameAzure:
+		req.BucketName = obj.Spec.Protocol.AzureBlob.ContainerName
+		req.BucketContext["StorageAccount"] = obj.Spec.Protocol.AzureBlob.StorageAccount
+	case v1alpha1.ProtocolNameGCS:
+		req.BucketName = obj.Spec.Protocol.GCS.BucketName
+		req.BucketContext["ServiceAccount"] = obj.Spec.Protocol.GCS.ServiceAccount
+		req.BucketContext["PrivateKeyName"] = obj.Spec.Protocol.GCS.PrivateKeyName
+		req.BucketContext["ProjectID"] = obj.Spec.Protocol.GCS.ProjectID
+	default:
+		return fmt.Errorf("unknown protocol: %s", obj.Spec.Protocol.Name)
+	}
+
+	req.BucketContext["ProtocolVersion"] = obj.Spec.Protocol.Version
+
+	// TODO set grpc timeout
+	rsp, err := bl.provisionerClient.ProvisionerDeleteBucket(ctx, &req)
+	if err != nil {
+		klog.Errorf("error calling ProvisionerDeleteBucket: %v", err)
+		obj.Status.Message = "Bucket Deleting"
+		obj.Status.BucketAvailable = false
+		_, err = bl.bucketClient.ObjectstorageV1alpha1().Buckets().UpdateStatus(ctx, obj, metav1.UpdateOptions{})
+		return err
+	}
+	klog.V(1).Infof("provisioner returned delete bucket response %v", rsp)
+
+	// update bucket availability to false
+	return bl.updateStatus(ctx, obj.Name, "Bucket Deleted", false)
+}
+
+func (bl *bucketListener) updateStatus(ctx context.Context, name, msg string, state bool) error {
+	err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
+		bucket, err := bl.bucketClient.ObjectstorageV1alpha1().Buckets().Get(ctx, name, metav1.GetOptions{})
+		if err != nil {
+			return err
+		}
+		bucket.Status.Message = msg
+		bucket.Status.BucketAvailable = state
+		_, err = bl.bucketClient.ObjectstorageV1alpha1().Buckets().UpdateStatus(ctx, bucket, metav1.UpdateOptions{})
+		return err
+	})
+	return err
+}