Skip to content

Commit

Permalink
Merge pull request #11234 from hashicorp/docs-csi-demo
Browse files Browse the repository at this point in the history
docs: note demos/csi is unsupported
  • Loading branch information
schmichael authored Sep 29, 2021
2 parents 28bd7fe + de89aca commit 524ffbd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
5 changes: 5 additions & 0 deletions demo/csi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,17 @@
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
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.
2 changes: 2 additions & 0 deletions demo/csi/hostpath/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 524ffbd

Please sign in to comment.