open-nomad/demo/csi/README.md

20 lines
825 B
Markdown
Raw Normal View History

2020-08-12 14:38:49 +00:00
# Container Storage Interface (CSI) examples
This directory contains examples of registering CSI plugin jobs and volumes
for those plugins.
Contributions are welcome but demos are *not supported* by the core Nomad
development team. Please tag demo authors when filing issues about CSI demos.
2020-08-12 14:38:49 +00:00
### Contributing
If you'd like to contribute an example, open a PR with a folder for the plugin
in this directory. This folder should include:
* A `README.md` with any added instructions a user might need to use the
plugin. Please include a link to the CSI plugin's source repository.
* Add an `Author: @<Github Username>` field at the top so you can be tagged
on issues.
2020-08-12 14:38:49 +00:00
* A Nomad job file for the plugin.
* A [volume specification](https://www.nomadproject.io/docs/commands/volume/register#volume-specification) file.