kubelock

type AcquireOptions struct {
	// Owner is an arbitrary string representing owner of the lock.
	Owner string
	// TTL is time to live for the lock.
	TTL time.Duration
}

type Config struct {
	DynClient dynamic.Interface

	// GVR defines a resource that the lock will be
	// created on with use of the dynamic Kubernetes client. This object
	// will be passed directly in the dynamic client API calls.
	//
	// E.g. for Namespace resource it can be instantiated like:
	//
	//	schema.GroupVersionResource{
	//		Group:    "",
	//		Version:  "v1",
	//		Resource: "namespaces",
	//	}
	//
	// E.g. for CR defined by a CRD defined in
	// https://github.com/giantswarm/apiextensions/ repository it can be
	// instantiated like:
	//
	//	schema.GroupVersionResource{
	//		Group:    v1alpha1.NewAWSConfigCRD().Spec.Group,
	//		Version:  v1alpha1.NewAWSConfigCRD().Spec.Version,
	//		Resource: v1alpha1.NewAWSConfigCRD().Spec.Names.Plural,
	//	}
	GVR schema.GroupVersionResource
}

type Interface interface {
	// Lock creates a lock with the given name. The name will be used to
	// create annotation prefixed with "kubelock.giantswarm.io/" on the
	// Kubernetes resource. Value of this annotation stores the lock data.
	//
	// NOTE: The name parameter is not validated but it must (together with
	// the annotation prefix mentioned) be a valid annotation key.
	Lock(name string) NamespaceableLock
}

type KubeLock struct {
	// contains filtered or unexported fields
}

type Lock interface {
	// Acquire tries to acquire the lock on a Kubernetes resource with the
	// given name.
	//
	// This method returns an error matched by IsAlreadyExists if the lock
	// already exists on the resource, it is not expired and it has the same
	// owner (set in options).
	//
	// This method returns an error matched by IsOwnerMismatch if the lock
	// already exists on the resource and it is not expired but was acquired
	// by a different owner (set in options).
	Acquire(ctx context.Context, name string, options AcquireOptions) error
	// Release tries to release the lock on a Kubernetes resource with the
	// given name.
	//
	// This method returns an error matched by IsNotFound if the lock
	// does not exist on the resource or it is expired.
	//
	// This method returns an error matched by IsOwnerMismatch if the lock
	// already exists and it is not expired but it was acquired by
	// a different owner (set in options).
	Release(ctx context.Context, name string, options ReleaseOptions) error
}

type NamespaceableLock interface {
	Lock

	// Namespace creates a lock that can be acquired on Kubernetes
	// resources in the given namespace.
	Namespace(ns string) Lock
}

type ReleaseOptions struct {
	// Owner is an arbitrary string representing owner of the lock.
	Owner string
}