provisioner

Documentation

Index

• Constants
• type BucketOptions
• type Provisioner

Constants

const Domain = "objectbucket.io"

Types

type BucketOptions

type BucketOptions struct {
	// ReclaimPolicy is the reclaimPolicy of the OBC's storage class
	ReclaimPolicy *corev1.PersistentVolumeReclaimPolicy
	// BucketName is the name of the bucket within the object store
	BucketName string
	// UserID is the id of the user associated with this OBC
	UserID string
	// ObjectBucketClaim is a copy of the reconciler's OBC
	ObjectBucketClaim *v1alpha1.ObjectBucketClaim
	// Parameters is a complete copy of the OBC's storage class Parameters field
	Parameters map[string]string
}

BucketOptions wraps all pertinent data that the Provisioner requires to create a bucket and the Reconciler requires to abstract that bucket in kubernetes

type Provisioner

type Provisioner interface {
	// GenerateUserID should deterministically generate a user ID for an OBC. This ID is used as an
	// idempotency key in order to ensure repeat calls to Provision or Grant are consistent.
	// Lib-bucket-provisioner may pass a non-nil ObjectBucket with the function as well. This will
	// be nil if the ObjectBucket does not yet exist, but it will be non-nil for existing buckets.
	// This may help provisioners recover the idempotency key from a pre-existing bucket.
	GenerateUserID(obc *v1alpha1.ObjectBucketClaim, ob *v1alpha1.ObjectBucket) (string, error)
	// Provision should be implemented to handle creation of object storage buckets.
	// Provision should NOT create the ObjectBucket resource. ObjectBucket resource creation is done
	// by this library's controller.
	// The Provision implementation must return an ObjectBucket struct with at least the Connection
	// spec filled in. All other ObjectBucket details will be filled in by this library's controller
	// before the ObjectBucket resource is created.
	// The Provision implementation may opt to specify the ObjectBucket spec's ReclaimPolicy in
	// cases where the provisioner wishes to set a different value from the one specified in the
	// ObjectBucketClaim's StorageClass.
	// The Provision implementation must be idempotent.
	// The Provision implementation does not need to clean up bucket or user resources when
	// returning an error.
	// The Provision implementation should return a nil ObjectBucket struct when returning an error.
	Provision(options *BucketOptions) (*v1alpha1.ObjectBucket, error)
	// Grant should be implemented to handle access to existing buckets.
	// The Grant implementation must be idempotent.
	Grant(options *BucketOptions) (*v1alpha1.ObjectBucket, error)
	// Delete should be implemented to handle bucket deletion
	Delete(ob *v1alpha1.ObjectBucket) error
	// Revoke should be implemented to handle removing bucket access
	Revoke(ob *v1alpha1.ObjectBucket) error
}

All provisioners must implement the Provisioner interface which defines the methods used to create and delete new buckets, and to grant or revoke access to buckets within the object store.