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(install): document using NFS for volume storage #344

Merged
merged 1 commit into from
Mar 6, 2018

Conversation

technosophos
Copy link
Contributor

This documents how to use nfs-provisioner to back storage and cache to
an NFS instance.

Implementation details of note:

- The NFS server used is [NFS-Ganesha](https://github.com/nfs-ganesha/nfs-ganesha)
- The Kubernetes proisioner is part of [kubernetes-incubator/external-storage](https://github.com/kubernetes-incubator/external-storage/tree/master/nfs)
Copy link
Contributor

Choose a reason for hiding this comment

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

provisioner

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Fixing.

Copy link
Contributor

@lukepatrick lukepatrick left a comment

Choose a reason for hiding this comment

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

A couple of comments from previous experience.

NFS (Network File System) is one protocol that works well for Brigade. You can
use the [NFS Provisioner](https://github.com/IlyaSemenov/nfs-provisioner-chart)
chart to easily install an NFS server.

Copy link
Contributor

Choose a reason for hiding this comment

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

Note, one assumption is the host has nfs-common. Rare not to have it but we hit that once before.
If not already set up on your host, add nfs-common
$ apt-get install nfs-common

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is very good to know. Thanks!


This chart installs a `StorageClass` named `local-nfs`. Brigade projects can
each declare which storage classes they want to use. And there are two storage
class settings:
Copy link
Contributor

Choose a reason for hiding this comment

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

In lieu of a named StorageClass, this can be installed as a default storage class. Though an explicit name is recommended.
$ helm install --name nfs --namespace nfs-provisioner nfs-provisioner/nfs-provisioner --set defaultClass=true

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good idea.

This documents how to use nfs-provisioner to back storage and cache to
an NFS instance.
@technosophos technosophos force-pushed the docs/nfs-provisioner branch from ad0ec1f to 71acbbd Compare March 6, 2018 19:21
@technosophos technosophos merged commit 399f0af into brigadecore:master Mar 6, 2018
@technosophos technosophos deleted the docs/nfs-provisioner branch March 6, 2018 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants