From 5ce49a94aa2b59d252f8d739f71e6edaa35c73f1 Mon Sep 17 00:00:00 2001 From: Yiannis Gkoufas Date: Thu, 18 Feb 2021 15:13:44 +0000 Subject: [PATCH 1/2] first readme draft --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index c8b6bfd..7b13f41 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,43 @@ # Container Object Storage Controller Container Object Storage Interface (COSI) controller 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 makes the necessary gRPC calls to the associated [provisioner](https://github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar) + +## 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](https://github.com/kubernetes-sigs/container-object-storage-interface-api/blob/master/apis/objectstorage.k8s.io/v1alpha1/types.go) +- The Spec of the COSI objects [sigs.k8s.io/container-object-storage-interface-spec](https://github.com/kubernetes-sigs/container-object-storage-interface-spec) + +A good starting point towards understanding the functionality of this repo would be to study the tests: + +- [BucketRequest Test](./pkg/bucketrequest/bucketrequest_test.go) +- [BucketAccessRequest Test](./pkg/bucketaccessrequest/bucketaccessrequest_test.go) + +### Build and Test + +In order to build and generate a Docker image execute: +```bash +make container +``` + +In order to run the tests execute: +```bash +make test +``` + +## References + +- [Documentation](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/index.md) +- [Deployment Guide](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/deployment-guide.md) +- [Weekly Meetings](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/meetings.md) +- [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/8) ## Community, discussion, contribution, and support From 4dd818ac6da44ffa99128f6213dd59514dbf226e Mon Sep 17 00:00:00 2001 From: Yiannis Gkoufas Date: Tue, 23 Feb 2021 15:02:54 +0000 Subject: [PATCH 2/2] fix for CRDs generation --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b13f41..d83e2bf 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,10 @@ 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 makes the necessary gRPC calls to the associated [provisioner](https://github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar) +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