Container Object Storage Controller

Container Object Storage Interface (COSI) controller is responsible to manage lifecycle of COSI objects. Specifically, this controller monitors the lifecycle of the user-facing CRDs:

• BucketRequest - Represents a request to provision a Bucket
• BucketAccessRequest - Represents a request to access a Bucket

and generates the associated CRDs:

• Bucket - Represents a Bucket or its equivalent in the storage backend
• BucketAccess - Represents a access token or service account in the storage backend

Developer Guide

Before diving into the code of this repo, we suggest that you familiarize yourself with:

• The Spec of CRDs in objectstorage.k8s.io/v1alpha1/types.go
• The Spec of the COSI objects sigs.k8s.io/container-object-storage-interface-spec

A good starting point towards understanding the functionality of this repo would be to study the tests:

• BucketClaim Test

Build and Test

In order to build and generate a Docker image execute:

make container

In order to run the tests execute:

make test

References

• Documentation
• Deployment Guide
• Weekly Meetings
• Roadmap

Community, discussion, contribution, and support

You can reach the maintainers of this project at:

• #sig-storage-cosi slack channel
• container-object-storage-interface mailing list

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.