Update flex volume 1.6 documentation. #43326
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
This change is |
|
Hi @chakri-nelluri. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
k8s-github-robot
added
size/M
| Flexvolume enables users to mount vendor volumes into kubernetes. It expects vendor drivers are installed in the volume plugin path on every kubelet node. | ||
|
|
||
| It allows for vendors to develop their own drivers to mount volumes on nodes. | ||
| Flexvolume enables users to write their own drivers and add support for their volumes in Kubernetes. Vendor drivers should be installed in the volume plugin path on every Kubelet node and on master node(s) if "-enable-controller-attach-detach" Kubelet option is enabled. |
There was a problem hiding this comment.
Missing hyphen (-) --enable-controller-attach-detach?
| <driver executable> waitfordetach <mount device> <json options> | ||
| ``` | ||
|
|
||
| #### Volume is Attached: |
There was a problem hiding this comment.
Only relevant if --enable-controller-attach-detach is set correct?
|
|
||
| ### Driver invocation model: | ||
|
|
||
| Init: | ||
| #### Init: |
There was a problem hiding this comment.
When is this called by kubernetes? From what component (kubelet?)? What is it expected to do?
There was a problem hiding this comment.
These questions should be answered for each callout.
| #### Mount device: | ||
| Mount device mounts the device to a global path which individual pods can then bind mount. | ||
|
|
||
| This call-out does not pass "secrets" specified in Flexvolume spec. If your driver requires secrets, do not implement this call-out and instead use "mount" call-out and implement attach and mount in that call-out. |
| ``` | ||
|
|
||
| #### Attach: | ||
| Attach the volume specified by the given spec on the given host. On success, returns the device path where the device is attached on the node. Nodename param is only valid if "-enable-controller-attach-detach" Kubelet option is enabled. |
There was a problem hiding this comment.
Nodename param is only valid if "-enable-controller-attach-detach" Kubelet option is enabled.
When attach/detach controller is disabled, kubelet calls attach, and I believe still provides the node name, no?
|
Review status: 0 of 1 files reviewed at latest revision, 5 unresolved discussions. examples/volumes/flexvolume/README.md, line 3 at r1 (raw file): Previously, klausenbusk (Kristian Klausen) wrote…
Done. examples/volumes/flexvolume/README.md, line 18 at r1 (raw file): Previously, saad-ali (Saad Ali) wrote…
Added "Called from Kubelet & Controller manager" for relevant callouts examples/volumes/flexvolume/README.md, line 33 at r1 (raw file): Previously, saad-ali (Saad Ali) wrote…
Trying to signify it still provides but nodename but it not valid/relevant. examples/volumes/flexvolume/README.md, line 54 at r1 (raw file): Previously, klausenbusk (Kristian Klausen) wrote…
It is getting called from both Kubelet & Controller manager right. examples/volumes/flexvolume/README.md, line 64 at r1 (raw file): Previously, saad-ali (Saad Ali) wrote…
this is the mountdevice call-out. Comments from Reviewable |
|
@saad-ali Does this need to be documented on kubernetes.io (the web documentation)? |
Good question. Intended audience for Flex volume plugin is Kubernetes volume plugin developers. So maybe not? |
|
Other than the concern's @devin-donnelly raised about the correct place for this doc, LGTM |
|
Thanks @saad-ali @devin-donnelly I agree with @saad-ali. This is only intended for volume plugin drivers. I don't think we need to update documentation on kubernetes.io. |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
saad-ali
added
release-note-none
k8s-github-robot
added
the
do-not-merge
saad-ali
added
approved
k8s-github-robot
removed
the
lgtm
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: brendandburns, chakri-nelluri, saad-ali
Needs approval from an approver in each of these OWNERS Files:
You can indicate your approval by writing |
|
Automatic merge from submit-queue |
What this PR does / why we need it:
Update documentation for 1.6 flex volume changes.