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.

Sign up for GitHub

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

Jump to bottom

Update mount propagation documentation #47645

Merged
merged 1 commit into from
Sep 3, 2024
Merged

Update mount propagation documentation #47645

merged 1 commit into from
Sep 3, 2024

Conversation

mattcary
Copy link
Contributor

Description

Mount propagation only works consistently on hostPath and in-memory emptyDir.

Issue

See kubernetes/kubernetes#95049 for more context.

/sig storage
/assign @msau42

@k8s-ci-robot k8s-ci-robot added sig/storage Categorizes an issue or PR as relevant to SIG Storage. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language labels Aug 22, 2024
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 22, 2024
@msau42
Copy link
Member

msau42 commented Aug 22, 2024

/lgtm

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

LGTM label has been added.

Git tree hash: dd6262f6002f084711f9f39b7ca6dc5b55f03f60

@msau42
Copy link
Member

msau42 commented Aug 22, 2024

cc @jsafrane

@netlify Netlify
Copy link

netlify bot commented Aug 22, 2024 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 3872831
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/66d0935a4d42690007d64b47
😎 Deploy Preview https://deploy-preview-47645--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

msau42
msau42 reviewed Aug 22, 2024
View reviewed changes
content/en/docs/concepts/storage/volumes.md Outdated
@@ -1247,6 +1247,13 @@ in `containers[*].volumeMounts`. Its values are:
(unmounted) by the containers on termination.
{{< /warning >}}

{{< warning >}}
Mount propagation is a low-level feature that does not work consistently on all
volume types. We recommend using it only with `hostPath` or in-memory `emptyDir`
Copy link
Member

Choose a reason for hiding this comment

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

actually, is it specifically in-memory emptydir, or any emptydir type?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've used it with in-memory emptydir. I think it should work with any type, but do others have an experience?

Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: avoid using “we“

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

sftim
sftim reviewed Aug 27, 2024
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks. I recommend a couple of tweaks, but this could merge as-is.

content/en/docs/concepts/storage/volumes.md Outdated
@@ -1247,6 +1247,13 @@ in `containers[*].volumeMounts`. Its values are:
(unmounted) by the containers on termination.
{{< /warning >}}

{{< warning >}}
Mount propagation is a low-level feature that does not work consistently on all
volume types. We recommend using it only with `hostPath` or in-memory `emptyDir`
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: avoid using “we“

content/en/docs/concepts/storage/volumes.md Outdated
@@ -1247,6 +1247,13 @@ in `containers[*].volumeMounts`. Its values are:
(unmounted) by the containers on termination.
{{< /warning >}}

{{< warning >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd use a caution here, not a warning. But also, I'd move this to the start of the section, just under the heading.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@jsafrane
Copy link
Member

lgtm from the storage perspective

@katcosgrove
Copy link
Contributor

@mattcary, are you able to address Tim's suggestions? I am also happy to approve this as-is, but would prefer the "we" replaced if you have the time.

@mattcary
Update mount propagation documentation
3872831 
Mount propagation only works consistently on hostPath and in-memory emptyDir.
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 29, 2024
mattcary
mattcary commented Aug 29, 2024
View reviewed changes
Copy link
Contributor Author

@mattcary mattcary left a comment

Choose a reason for hiding this comment

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

I've addressed the comments. Sorry for the delay, I had made this in-line in git but updating the commit in git codespaces crashed and burned.

content/en/docs/concepts/storage/volumes.md Outdated
@@ -1247,6 +1247,13 @@ in `containers[*].volumeMounts`. Its values are:
(unmounted) by the containers on termination.
{{< /warning >}}

{{< warning >}}
Mount propagation is a low-level feature that does not work consistently on all
volume types. We recommend using it only with `hostPath` or in-memory `emptyDir`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

content/en/docs/concepts/storage/volumes.md Outdated
@@ -1247,6 +1247,13 @@ in `containers[*].volumeMounts`. Its values are:
(unmounted) by the containers on termination.
{{< /warning >}}

{{< warning >}}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@reylejano
Copy link
Member

/lgtm
/approve

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

LGTM label has been added.

Git tree hash: c6d03508ee6bcfd8de6482b3d4125883f505fab3

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: reylejano

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 Sep 3, 2024
@k8s-ci-robot k8s-ci-robot merged commit 8baaba4 into kubernetes:main Sep 3, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@saad-ali saad-ali Awaiting requested review from saad-ali

@thockin thockin Awaiting requested review from thockin

@msau42 msau42 Awaiting requested review from msau42

Assignees

@msau42 msau42

@reylejano reylejano

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/storage Categorizes an issue or PR as relevant to SIG Storage. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@mattcary @msau42 @k8s-ci-robot @jsafrane @katcosgrove @reylejano @sftim