Add documentation for mount option #2743
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
lgtm from tech side. |
| @@ -222,6 +222,51 @@ A volume will be in one of the following phases: | |||
|
|
|||
| The CLI will show the name of the PVC bound to the PV. | |||
|
|
|||
| ### Mount Options | |||
|
|
|||
| Kubernetes administrator can specify additional mount option to be used when a Persistent Volume is | |||
There was a problem hiding this comment.
Who is "Kubernetes administrator" in this case? The reader?
If the reader, address as "you." As in, "You can specify an additional mount option for the system to use when a Persistent Volume is mounted on a node."
There was a problem hiding this comment.
I was thinking in some cases, the reader may not have access to create/view/edit the Persistent Volume.
So it could be a cluster admin or something like that.
There was a problem hiding this comment.
Okay. In any case it still has grammar issues. Suggested edit:
"A Kubernetes administrator can specify additional mount options for when a Persistent Volume is being mounted on a node."
| Kubernetes administrator can specify additional mount option to be used when a Persistent Volume is | ||
| being mounted on a node. | ||
|
|
||
| Mount option can be specified via an annotation on PV - `volume.beta.kubernetes.io/mount-options`. |
There was a problem hiding this comment.
"You can specify a mount option by using an the volume.beta.kubernetes.io/mount-options annotiation on your Persistent Volume."
| pdName: "gce-disk-1 | ||
| ``` | ||
|
|
||
| A mount option can be a string which will be cumulatively joined and used while mounting volume to the disk. |
There was a problem hiding this comment.
Can be a string? Or must be a string? What all can it be?
"A mount option is a string which is cumulatively joined and used while mounting the volume to the disk."
|
|
||
| A mount option can be a string which will be cumulatively joined and used while mounting volume to the disk. | ||
|
|
||
| Having said that, not all Persistent volume types support mount options. As of this writing - volume types that |
There was a problem hiding this comment.
"Note that not all Persistent Volume types support mount options. In Kubernetes version 1.6, the following volume types support mount options:"
|
@devin-donnelly fixed most of the review comments. ptal |
| Kubernetes administrator can specify additional mount option to be used when a Persistent Volume is | ||
| being mounted on a node. | ||
|
|
||
| You can specify a mount option by using annotation - `volume.beta.kubernetes.io/mount-options` on |
There was a problem hiding this comment.
"by using the annotation" (and remove the "-") character
|
@gnufied I've approved your changes. There are still two open comments I'd like you to fix, and then I'll merge. |
gnufied
force-pushed
the
add-mount-option-docs
branch
from
53456fc
to
5bfd292
Compare
|
@devin-donnelly fixed the review comments. |
|
Great, thanks. |
Adds documentation for mount options introduce in kubernetes/enhancements#168
This change is