Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(main): Add scope #2

Merged
merged 4 commits into from
Dec 23, 2023
Merged
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CSI Quickstart

The goals of this project are

- [ ] Create a quickstart project for the [CSI specification](https://github.com/container-storage-interface/spec/blob/master/spec.md)
- [ ] Easy to read guide summarizing the requirements of a basic CSI plugin. Simulating something like [`emptyDir`](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir)/[`hostPath`](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) - to be decided.
- [ ] Code implementing the bare minimum plugin described the guide.
- [ ] References helpful for learning the supplementary knowledge not directly related to Kubernetes/CSI.
- [ ] Document every decision, resource and changes in the project.

## Stretch Goals
- [ ] Examples describing different scenarios. Different branches/subdirectories for each example, that are as much self-contained as possible.
- [ ] Volume created external to Kubernetes, manually.
- [ ] Have a simple API providing a volume that can be invoked by the CSI plugin.
- [ ] Volume from a public cloud provider.