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

Update note for waitForFirstConsumer binding mode with example #27884

Merged
merged 1 commit into from
May 11, 2021

Conversation

jingxu97
Copy link
Contributor

@jingxu97 jingxu97 commented May 6, 2021

Update binding mode related to nodeName and give an example

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 6, 2021
@k8s-ci-robot k8s-ci-robot requested review from saad-ali and thockin May 6, 2021 00:41
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 6, 2021
@jingxu97
Copy link
Contributor Author

jingxu97 commented May 6, 2021

/assign @msau42

@netlify
Copy link

netlify bot commented May 6, 2021

Deploy preview for kubernetes-io-master-staging ready!

Built with commit e7d3e27

https://deploy-preview-27884--kubernetes-io-master-staging.netlify.app

@@ -156,7 +156,7 @@ the class or PV. If a mount option is invalid, the PV mount fails.
The `volumeBindingMode` field controls when [volume binding and dynamic
provisioning](/docs/concepts/storage/persistent-volumes/#provisioning) should occur.

By default, the `Immediate` mode indicates that volume binding and dynamic
The `Immediate` mode indicates that volume binding and dynamic
Copy link
Member

Choose a reason for hiding this comment

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

I think it's still good to say that Immediate is the default behavior

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, right without specifying any mode, the default is "Immediate"

@@ -188,6 +188,43 @@ The following plugins support `WaitForFirstConsumer` with pre-created Persistent
and pre-created PVs, but you'll need to look at the documentation for a specific CSI driver
to see its supported topology keys and examples.

:::note
If you choose to use `waitForFirstConsumer` in storage classes, do not use `nodeName` in the Pod spec
Copy link
Member

Choose a reason for hiding this comment

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

How about something like

If you choose to use `WaitForFirstConsumer`, do not use...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

@@ -188,6 +188,43 @@ The following plugins support `WaitForFirstConsumer` with pre-created Persistent
and pre-created PVs, but you'll need to look at the documentation for a specific CSI driver
to see its supported topology keys and examples.

:::note
If you choose to use `waitForFirstConsumer` in storage classes, do not use `nodeName` in the Pod spec
to specify node affinity. If `nodeName` is used in this case, then PVC will remain in `pending` state. For more details refer https://github.com/openebs/openebs/issues/2915.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we should refer to issues outside of the kubernetes repo. Maybe just say something like the scheduler will be bypassed and the PVC will remain...

metadata:
name: task-pv-pod
spec:
affinity:
Copy link
Member

Choose a reason for hiding this comment

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

It could be even simpler than this if you use nodeSelector

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

@jingxu97
Copy link
Contributor Author

jingxu97 commented May 6, 2021

updated, PTAL @msau42

@msau42
Copy link
Member

msau42 commented May 6, 2021

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 6, 2021
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 6c650a0c37b2951847be83748eb10f6dc00e96fb

@msau42
Copy link
Member

msau42 commented May 6, 2021

/assign @reylejano

Copy link
Member

@savitharaghunathan savitharaghunathan left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: savitharaghunathan

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 11, 2021
@k8s-ci-robot k8s-ci-robot merged commit 45f3664 into kubernetes:master May 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants