Skip to content
This repository was archived by the owner on Dec 3, 2024. It is now read-only.

Readme update #37

Merged
merged 2 commits into from
Mar 3, 2021
Merged

Readme update #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ce49a9
first readme draft
YiannisGkoufas Feb 18, 2021
4dd818a
fix for CRDs generation
YiannisGkoufas Feb 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,46 @@
# 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 generates the associated CRDs:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wlan0 fixed the error


- 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](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

Expand Down