-
Notifications
You must be signed in to change notification settings - Fork 813
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
Update documentation #1263
Update documentation #1263
Conversation
docs/parameters.md
Outdated
@@ -0,0 +1,17 @@ | |||
# CreateVolume Parameters | |||
There are several optional parameters that could be passed into `CreateVolumeRequest.parameters` map, these parameters can be configured in StorageClass, see [example](../examples/kubernetes/storageclass): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about adding a reference to the SC tagging doc here as well?
/lgtm |
Signed-off-by: Eddie Torres <[email protected]>
@wmesard Appreciate the feedback, new rev addresses all of your comments. |
/lgtm |
* Enable flag `--allow-privileged=true` for `kubelet` and `kube-apiserver` | ||
* Enable `kube-apiserver` feature gates `--feature-gates=CSINodeInfo=true,CSIDriverRegistry=true,CSIBlockVolume=true,VolumeSnapshotDataSource=true` | ||
* Enable `kubelet` feature gates `--feature-gates=CSINodeInfo=true,CSIDriverRegistry=true,CSIBlockVolume=true` | ||
* If you intend to use the csi-snapshotter functionality you will need to first install the [CSI Snapshotter](https://github.com/kubernetes-csi/external-snapshotter) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Missing period
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: MurphyPuppy, rdpsin, torredil, wmesard The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/hold cancel |
Signed-off-by: torredil [email protected]
What is this PR about? / Why do we need it?
Current project documentation is not very user-friendly, hard to navigate, and in some instances outdated (a la #1256).
README.md
CONTRIBUTING.md
NOTICE
install.md
,options.md
,parameters.md
,tagging.md