Skip to content

Add more detail to cluster volumes docs#43754

Merged
thaJeztah merged 1 commit intomoby:masterfrom
dperny:update-cluster-volumes-docs
Jun 30, 2022
Merged

Add more detail to cluster volumes docs#43754
thaJeztah merged 1 commit intomoby:masterfrom
dperny:update-cluster-volumes-docs

Conversation

@dperny
Copy link
Copy Markdown
Contributor

@dperny dperny commented Jun 29, 2022

Adds more detail to the existing docs/cluster_volumes.md documentation, explaining in more detail how to create a plugin.

Signed-off-by: Drew Erny <derny@mirantis.com>
Comment on lines +48 to +54
## Creating a Docker CSI Plugin

Most CSI plugins are shipped with configuration specific to Kubernetes. They
are often provided in the form of Helm charts, and installation information may
include Kubernetes-specific steps. Docker CSI Plugins use the same binaries as
those for Kubernetes, but in a different environment and sometimes with
different configuration.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we need an example of how to configure a CSI plugin that would otherwise normally have configured that is Kubernetes-specific to run in Docker Swarm.

Can we pick a CSI plugin that's fairly simple, like maybe a CSI plugin for NFS or something non-cloud-specific and use that as an example to help support this improved documentation?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think a fork for Docker CSI of this one https://github.com/kubernetes-csi/csi-driver-host-path would make sense for CI

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'd been hacking on the democratic-csi plugin to come up with these docs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hmm, looking at the project, that might be a nice choice for people to get started with new drivers. If you have anything to try out or where we can help, let us know :)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh brilliant! 🙃

Copy link
Copy Markdown
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@thaJeztah
Copy link
Copy Markdown
Member

CI failure is unrelated; as discussed we can make further enhancements to this docs later (and also look at integrating docs into docs.docker.com)

@thaJeztah thaJeztah merged commit 3cfa12e into moby:master Jun 30, 2022
should be set as such.
related interfaces that CSI plugins can expose.

* `docker.csicontroller/1.0` is used for CSI Controller plugins.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think a link directly to the code/definition of the interface would help make this easier as this is namespaced with docker.* .

As someone that is new to moby/moby I am still having a hard time finding my way around things, but as people seem to be willing to spend some time in investigating how to build CSI plugins, it would go a long way to be more specific here :).

Comment on lines +48 to +54
## Creating a Docker CSI Plugin

Most CSI plugins are shipped with configuration specific to Kubernetes. They
are often provided in the form of Helm charts, and installation information may
include Kubernetes-specific steps. Docker CSI Plugins use the same binaries as
those for Kubernetes, but in a different environment and sometimes with
different configuration.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think a fork for Docker CSI of this one https://github.com/kubernetes-csi/csi-driver-host-path would make sense for CI

Comment on lines +48 to +54
## Creating a Docker CSI Plugin

Most CSI plugins are shipped with configuration specific to Kubernetes. They
are often provided in the form of Helm charts, and installation information may
include Kubernetes-specific steps. Docker CSI Plugins use the same binaries as
those for Kubernetes, but in a different environment and sometimes with
different configuration.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hmm, looking at the project, that might be a nice choice for people to get started with new drivers. If you have anything to try out or where we can help, let us know :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants