Merge pull request #11234 from hashicorp/docs-csi-demo

docs: note demos/csi is unsupported
This commit is contained in:
Michael Schurter
2021-09-29 08:54:56 -07:00
committed by GitHub
2 changed files with 7 additions and 0 deletions

View File

@@ -3,6 +3,9 @@
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.
### Contributing
If you'd like to contribute an example, open a PR with a folder for the plugin
@@ -10,5 +13,7 @@ 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.
* A Nomad job file for the plugin.
* A [volume specification](https://www.nomadproject.io/docs/commands/volume/register#volume-specification) file.

View File

@@ -1,5 +1,7 @@
# Hostpath CSI Plugin
Author: @hashicorp/nomad-eng
This directory includes a demo using the [CSI host path
driver](https://github.com/kubernetes-csi/csi-driver-host-path) to create
local "host path" volumes that can be mounted via the Nomad CSI