leseb / lib-bucket-provisioner

Library for the dynamic provisioning of object store buckets to be used by object store providers.

DEPRECATION NOTICE:

There is a Kubernetes Enhancement Proposal under review which will significantly change this design and interfaces. This repo is not longer active and should not be used.

Bucket Provisioning Library

This repo is a temporary placeholder for a general purpose object-store bucket provisioning library, very similar to the Kubernetes sig-storage-lib-external-provisioner library. The goal is to eventually move this repo to a Kubernetes repo within sig-storage/, but this may never happen.

Repo Layout

The overall bucket provisioning library design describes the Custom Resource Definitions, interfaces, and workflows of an ObjectBucketClaim and an ObjectBucket. This documents is kept up-to-date and reflects the current design and implementation of bucket provisioning library. Future designs and considerations have been removed from the design document, and are tracked as Issues with the enhancement label.

There are examples showing how object-store provisioners can use this library.

Library contributors should look here for make and directions.

Provisioner developers should look here and here for some guidance/recommendations/tips on how to get started with creating your own Provisioner.

Feedback and Community Input

Please submit PRs against any section of this repo, especially the library design.