instance.go

/*
Copyright 2018 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 servicecatalog

import (
	"fmt"
	"math"
	"time"

	"github.com/kubernetes-sigs/service-catalog/pkg/apis/servicecatalog/v1beta1"
	"github.com/pkg/errors"
	apierrors "k8s.io/apimachinery/pkg/api/errors"
	"k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/fields"
	"k8s.io/apimachinery/pkg/util/sets"
	"k8s.io/apimachinery/pkg/util/wait"
)

const (
	// FieldServicePlanRef is the jsonpath to an instance's plan name (Kubernetes name).
	FieldServicePlanRef = "spec.clusterServicePlanRef.name"
)

// RetrieveInstances lists all instances in a namespace.
func (sdk *SDK) RetrieveInstances(ns, classFilter, planFilter string) (*v1beta1.ServiceInstanceList, error) {
	instances, err := sdk.ServiceCatalog().ServiceInstances(ns).List(v1.ListOptions{})
	if err != nil {
		return nil, errors.Wrapf(err, "unable to list instances in %s", ns)
	}

	if classFilter == "" && planFilter == "" {
		return instances, nil
	}

	filtered := v1beta1.ServiceInstanceList{
		Items: []v1beta1.ServiceInstance{},
	}

	for _, instance := range instances.Items {
		if classFilter != "" && instance.Spec.GetSpecifiedClusterServiceClass() != classFilter {
			continue
		}

		if planFilter != "" && instance.Spec.GetSpecifiedClusterServicePlan() != planFilter {
			continue
		}

		filtered.Items = append(filtered.Items, instance)
	}

	return &filtered, nil
}

// RetrieveInstance gets an instance by its name.
func (sdk *SDK) RetrieveInstance(ns, name string) (*v1beta1.ServiceInstance, error) {
	instance, err := sdk.ServiceCatalog().ServiceInstances(ns).Get(name, v1.GetOptions{})
	if err != nil {
		return nil, fmt.Errorf("unable to get instance '%s.%s' (%s)", ns, name, err)
	}
	return instance, nil
}

// RetrieveInstanceByBinding retrieves the parent instance for a binding.
func (sdk *SDK) RetrieveInstanceByBinding(b *v1beta1.ServiceBinding,
) (*v1beta1.ServiceInstance, error) {
	ns := b.Namespace
	instName := b.Spec.InstanceRef.Name
	inst, err := sdk.ServiceCatalog().ServiceInstances(ns).Get(instName, v1.GetOptions{})
	if err != nil {
		return nil, err
	}
	return inst, nil
}

// RetrieveInstancesByPlan retrieves all instances of a plan.
func (sdk *SDK) RetrieveInstancesByPlan(plan Plan) ([]v1beta1.ServiceInstance, error) {
	planOpts := v1.ListOptions{
		FieldSelector: fields.OneTermEqualSelector(FieldServicePlanRef, plan.GetName()).String(),
	}
	instances, err := sdk.ServiceCatalog().ServiceInstances("").List(planOpts)
	if err != nil {
		return nil, fmt.Errorf("unable to list instances (%s)", err)
	}

	return instances.Items, nil
}

// InstanceParentHierarchy retrieves all ancestor resources of an instance.
func (sdk *SDK) InstanceParentHierarchy(instance *v1beta1.ServiceInstance,
) (*v1beta1.ClusterServiceClass, *v1beta1.ClusterServicePlan, *v1beta1.ClusterServiceBroker, error) {
	class, plan, err := sdk.InstanceToServiceClassAndPlan(instance)
	if err != nil {
		return nil, nil, nil, err
	}

	broker, err := sdk.RetrieveBrokerByClass(class)
	if err != nil {
		return nil, nil, nil, err
	}

	return class, plan, broker, nil
}

// InstanceToServiceClassAndPlan retrieves the parent class and plan for an instance.
func (sdk *SDK) InstanceToServiceClassAndPlan(instance *v1beta1.ServiceInstance,
) (*v1beta1.ClusterServiceClass, *v1beta1.ClusterServicePlan, error) {
	classID := instance.Spec.ClusterServiceClassRef.Name
	classCh := make(chan *v1beta1.ClusterServiceClass)
	classErrCh := make(chan error)
	go func() {
		class, err := sdk.ServiceCatalog().ClusterServiceClasses().Get(classID, v1.GetOptions{})
		if err != nil {
			classErrCh <- err
			return
		}
		classCh <- class
	}()

	planID := instance.Spec.ClusterServicePlanRef.Name
	planCh := make(chan *v1beta1.ClusterServicePlan)
	planErrCh := make(chan error)
	go func() {
		plan, err := sdk.ServiceCatalog().ClusterServicePlans().Get(planID, v1.GetOptions{})
		if err != nil {
			planErrCh <- err
			return
		}
		planCh <- plan
	}()

	var class *v1beta1.ClusterServiceClass
	var plan *v1beta1.ClusterServicePlan
	for {
		select {
		case cl := <-classCh:
			class = cl
			if class != nil && plan != nil {
				return class, plan, nil
			}
		case err := <-classErrCh:
			return nil, nil, err
		case pl := <-planCh:
			plan = pl
			if class != nil && plan != nil {
				return class, plan, nil
			}
		case err := <-planErrCh:
			return nil, nil, err

		}
	}
}

// Provision creates an instance of a specific service class and plan specified
// by their k8s names. Depending on provisionClusterInstance, it will create either
// an instance of a cluster class/plan or a namespaced class/plan
func (sdk *SDK) Provision(instanceName, classKubeName, planKubeName string, provisionClusterInstance bool, opts *ProvisionOptions) (*v1beta1.ServiceInstance, error) {
	var request *v1beta1.ServiceInstance
	if provisionClusterInstance {
		request = &v1beta1.ServiceInstance{
			ObjectMeta: v1.ObjectMeta{
				Name:      instanceName,
				Namespace: opts.Namespace,
			},
			Spec: v1beta1.ServiceInstanceSpec{
				ExternalID: opts.ExternalID,
				PlanReference: v1beta1.PlanReference{
					ClusterServiceClassName: classKubeName,
					ClusterServicePlanName:  planKubeName,
				},
				Parameters:     BuildParameters(opts.Params),
				ParametersFrom: BuildParametersFrom(opts.Secrets),
			},
		}
	} else {
		request = &v1beta1.ServiceInstance{
			ObjectMeta: v1.ObjectMeta{
				Name:      instanceName,
				Namespace: opts.Namespace,
			},
			Spec: v1beta1.ServiceInstanceSpec{
				ExternalID: opts.ExternalID,
				PlanReference: v1beta1.PlanReference{
					ServiceClassName: classKubeName,
					ServicePlanName:  planKubeName,
				},
				Parameters:     BuildParameters(opts.Params),
				ParametersFrom: BuildParametersFrom(opts.Secrets),
			},
		}
	}
	result, err := sdk.ServiceCatalog().ServiceInstances(opts.Namespace).Create(request)
	if err != nil {
		return nil, fmt.Errorf("provision request failed (%s)", err)
	}
	return result, nil
}

// Deprovision deletes an instance.
func (sdk *SDK) Deprovision(namespace, instanceName string) error {
	err := sdk.ServiceCatalog().ServiceInstances(namespace).Delete(instanceName, &v1.DeleteOptions{})
	if err != nil {
		return fmt.Errorf("deprovision request failed (%s)", err)
	}
	return nil
}

// TouchInstance increments the updateRequests field on an instance to make
// service process it again (might be an update, delete, or noop)
func (sdk *SDK) TouchInstance(ns, name string, retries int) error {
	for j := 0; j < retries; j++ {
		inst, err := sdk.RetrieveInstance(ns, name)
		if err != nil {
			return err
		}

		inst.Spec.UpdateRequests = inst.Spec.UpdateRequests + 1

		_, err = sdk.ServiceCatalog().ServiceInstances(ns).Update(inst)
		if err == nil {
			return nil
		}
		// if we didn't get a conflict, no idea what happened
		if !apierrors.IsConflict(err) {
			return fmt.Errorf("could not touch instance (%s)", err)
		}
	}

	// conflict after `retries` tries
	return fmt.Errorf("could not sync service broker after %d tries", retries)
}

// WaitForInstanceToNotExist waits for the specified instance to no longer exist.
func (sdk *SDK) WaitForInstanceToNotExist(ns, name string, interval time.Duration, timeout *time.Duration) (instance *v1beta1.ServiceInstance, err error) {
	if timeout == nil {
		notimeout := time.Duration(math.MaxInt64)
		timeout = &notimeout
	}

	err = wait.PollImmediate(interval, *timeout,
		func() (bool, error) {
			instance, err = sdk.ServiceCatalog().ServiceInstances(ns).Get(name, v1.GetOptions{})
			if err != nil {
				if apierrors.IsNotFound(err) {
					err = nil
				}
				return true, err
			}
			return false, err
		})
	return instance, err
}

// WaitForInstance waits for the instance to complete the current operation (or fail).
func (sdk *SDK) WaitForInstance(ns, name string, interval time.Duration, timeout *time.Duration) (instance *v1beta1.ServiceInstance, err error) {
	if timeout == nil {
		notimeout := time.Duration(math.MaxInt64)
		timeout = &notimeout
	}

	err = wait.PollImmediate(interval, *timeout,
		func() (bool, error) {
			instance, err = sdk.RetrieveInstance(ns, name)
			if nil != err {
				return false, err
			}

			if len(instance.Status.Conditions) == 0 {
				return false, nil
			}

			isDone := (sdk.IsInstanceReady(instance) || sdk.IsInstanceFailed(instance)) && !instance.Status.AsyncOpInProgress
			return isDone, nil
		},
	)

	return instance, err
}

// IsInstanceReady returns if the instance is in the Ready status.
func (sdk *SDK) IsInstanceReady(instance *v1beta1.ServiceInstance) bool {
	return sdk.InstanceHasStatus(instance, v1beta1.ServiceInstanceConditionReady)
}

// IsInstanceFailed returns if the instance is in the Failed status.
func (sdk *SDK) IsInstanceFailed(instance *v1beta1.ServiceInstance) bool {
	return sdk.InstanceHasStatus(instance, v1beta1.ServiceInstanceConditionFailed)
}

// InstanceHasStatus returns if the instance is in the specified status.
func (sdk *SDK) InstanceHasStatus(instance *v1beta1.ServiceInstance, status v1beta1.ServiceInstanceConditionType) bool {
	for _, cond := range instance.Status.Conditions {
		if cond.Type == status &&
			cond.Status == v1beta1.ConditionTrue {
			return true
		}
	}

	return false
}

// RemoveFinalizerForInstance removes v1beta1.FinalizerServiceCatalog from the specified instance.
func (sdk *SDK) RemoveFinalizerForInstance(ns, name string) error {
	instance, err := sdk.RetrieveInstance(ns, name)
	if err != nil {
		return err
	}

	finalizers := sets.NewString(instance.Finalizers...)
	finalizers.Delete(v1beta1.FinalizerServiceCatalog)
	instance.Finalizers = finalizers.List()
	_, err = sdk.ServiceCatalog().ServiceInstances(instance.Namespace).UpdateStatus(instance)
	if err != nil {
		return err
	}
	return nil
}