controller

type BucketStore interface {
	// StoreBucket makes sure a bucket is saved to Kubernetes API server.
	// If no error is returned, caller can assume that PV was saved or
	// is being saved in background.
	// In error is returned, no PV was saved and corresponding PVC needs
	// to be re-queued (so whole provisioning needs to be done again).
	StoreBucket(bucketRequest *v1alpha1.BucketRequest, bucket *v1alpha1.Bucket) error

	// Runs any background goroutines for implementation of the interface.
	Run(ctx context.Context, threadiness int)
}

type IgnoredError struct {
	Reason string
}

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

type ProvisionOptions struct {
	// BucketClass is a reference to the storage class that is used for
	// provisioning for this bucket
	BucketClass *v1alpha1.BucketClass

	// Bucket.Name of the appropriate Bucket. Used to generate cloud
	// bucket name.
	BucketName string

	// bucketRequest is reference to the claim that lead to provisioning of a new bucket.
	// Provisioners *must* create a bucket that would be matched by this bucketRequest,
	// i.e. with required capacity, accessMode, labels matching bucketRequest.Selector and
	// so on.
	BucketRequest *v1alpha1.BucketRequest

	// Node selected by the scheduler for the bucket.
	SelectedNode *v1.Node
}

type Provisioner interface {
	// Provision creates a bucket i.e. the storage asset and returns a bucket object
	// for the bucket. The provisioner can return an error (e.g. timeout) and state
	// ProvisioningInBackground to tell the controller that provisioning may be in
	// progress after Provision() finishes. The controller will call Provision()
	// again with the same parameters, assuming that the provisioner continues
	// provisioning the bucket. The provisioner must return either final error (with
	// ProvisioningFinished) or success eventually, otherwise the controller will try
	// forever (unless FailedProvisionThreshold is set).
	Provision(context.Context, ProvisionOptions) (*v1alpha1.Bucket, ProvisioningState, error)
}

type ProvisioningState string

type Qualifier interface {
	// ShouldProvision returns whether provisioning for the claim should
	// be attempted.
	ShouldProvision(context.Context, *v1alpha1.BucketRequest) bool
}