Mount propagation #5544
Merged
Mount propagation #5544
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
size/M
jsafrane
force-pushed
the
mount-propagation
branch
from
6c67554
to
76e964c
Compare
|
Deploy preview ready! Built with commit 6c67554 https://deploy-preview-5544--kubernetes-io-vnext-staging.netlify.com |
|
Deploy preview ready! Built with commit 0cb04d5 https://deploy-preview-5544--kubernetes-io-vnext-staging.netlify.com |
|
Btw, thanks to anyone who added hints about branches/milestones to the PR template! |
tengqm
reviewed
Sep 19, 2017
docs/concepts/storage/volumes.md
Outdated
| propagated (i.e. run with `private` mount propagation as described in | ||
| [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt)) | ||
|
|
||
| If MountPropagation alpha feature is enabled, `VolumeMounts` field in Container |
There was a problem hiding this comment.
To enable this feature, the MountPropagation=true option has to be specified in the --feature-gates option.
There was a problem hiding this comment.
'VolumeMounts' -> 'volumeMounts'
There was a problem hiding this comment.
`VolumeMounts' -> 'volumeMounts'
Fixed
To enable this feature, the MountPropagation=true option has to be specified in the --feature-gates option
Added + rephrased the rest a bit
docs/concepts/storage/volumes.md
Outdated
| [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt)) | ||
|
|
||
| If MountPropagation alpha feature is enabled, `VolumeMounts` field in Container | ||
| gets a new field `MountPropagation`. Its values are: |
There was a problem hiding this comment.
the field name should be 'mountPropagation'?
jsafrane
force-pushed
the
mount-propagation
branch
from
76e964c
to
4a797bd
Compare
docs/concepts/storage/volumes.md
Outdated
| @@ -854,6 +854,58 @@ volume plugin path on each node. This is an alpha feature and may change in futu | |||
| More details can be found [here](https://github.com/kubernetes/community/blob/master/contributors/devel/flexvolume.md). | |||
|
|
|||
|
|
|||
| ## Mount propagation | |||
|
|
|||
| **Note:** Mount propagation is alpha feature in Kubernetes 1.8 and may be | |||
There was a problem hiding this comment.
is alpha feature -> is an alpha feature
docs/concepts/storage/volumes.md
Outdated
| To enable this feature, the `MountPropagation=true` option has to be specified | ||
| in the `--feature-gates` command line option. When enabled, `volumeMounts` field | ||
| in Container gets a new field `mountPropagation`. Its values are: | ||
|
|
There was a problem hiding this comment.
Mount propagation allows for sharing volumes mounted by a Container to
other Containers in the same Pod, or even to other Pods on the same node.
If the MountPropagation feature is disabled, volume mounts in pods are not propagated.
That is, Containers run with private mount propagation as described in the
Linux kernel documentation.
To enable this feature, specify MountPropagation=true in the
--feature-gates command line option. When enabled, the volumeMounts field
of a Container has a new mountPropagation subfield. Its values are:
docs/concepts/storage/volumes.md
Outdated
| in the `--feature-gates` command line option. When enabled, `volumeMounts` field | ||
| in Container gets a new field `mountPropagation`. Its values are: | ||
|
|
||
| * `HostToContainer` - this volume mount will receive all subsequent mounts |
docs/concepts/storage/volumes.md
Outdated
| * `HostToContainer` - this volume mount will receive all subsequent mounts | ||
| that are mounted to this volume or any of its subdirectories. This is | ||
| the default mode when MountPropagation feature is enabled. | ||
|
|
There was a problem hiding this comment.
MountPropagation feature -> the MountPropagation feature
docs/concepts/storage/volumes.md
Outdated
| propagation will see it. | ||
|
|
||
| This mode equals to `rslave` mount propagation as described in | ||
| [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) |
There was a problem hiding this comment.
equals to -> is equal to
described in -> described in the
docs/concepts/storage/volumes.md
Outdated
| * `Bidirectional` - this volume mount behaves as with `HostToContainer` mount | ||
| propagation mode, i.e. it receives all volume mounts created by the host or | ||
| Pods in the volume mount. | ||
|
|
There was a problem hiding this comment.
This volume mount behaves the same as the HostToContainer mount. In addition, all volume mounts created by the Container will be propagated back to the host and to all Containers of all Pods that use the same volume.
docs/concepts/storage/volumes.md
Outdated
|
|
||
| Typical use case for this mode would be a Pod with a Flex volume driver or | ||
| a Pod that needs to mount something on the host using HostPath volume. | ||
|
|
There was a problem hiding this comment.
A typical use case for this mode is a Pod with a Flex volume driver or a Pod that needs to mount something on the host using a HostPath volume.
docs/concepts/storage/volumes.md
Outdated
| a Pod that needs to mount something on the host using HostPath volume. | ||
|
|
||
| This mode equals to `rshared` mount propagation as described in | ||
| [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) |
There was a problem hiding this comment.
equals to -> is equal to
docs/concepts/storage/volumes.md
Outdated
|
|
||
| **Caution:** `Bidirectional` mount propagation can be dangerous. It can damage | ||
| host operating system and therefore it is allowed only in privileged | ||
| Containers. Familiarity with Linux kernel behavior is strongly recommended. |
There was a problem hiding this comment.
damage host -> damage the host
|
@jsafrane A few comments in the text. |
jsafrane
force-pushed
the
mount-propagation
branch
2 times, most recently
from
60fe06f
to
0cb04d5
Compare
|
@steveperry-53, thanks for your review. I fixed all the comments, PTAL again. |
tengqm
approved these changes
Sep 22, 2017
steveperry-53
added a commit
that referenced
this pull request
Sep 29, 2017
* GC now supports non-core resources * Add two examples about how to analysis audits of kube-apiserver (#4264) * Deprecate system:nodes binding * [1.8] StatefulSet `initialized` annotation is now ignored. * inits the kubeadm upgrade docs addresses /issues/4689 * adds kubeadm upgrade cmd to ToC addresses /issues/4689 * add workload placement docs * ScaleIO - document udpate for 1.8 * Add documentation on storageClass.mountOptions and PV.mountOptions (#5254) * Add documentation on storageClass.mountOptions and PV.mountOptions * convert notes into callouts * Add docs for CustomResource validation add info about supported fields * advanced audit beta features (#5300) * Update job workload doc with backoff failure policy (#5319) Add to the Jobs documentation how to use the new backoffLimit field that limit the number of Pod failure before considering the Job as failed. * Documented additional AWS Service annotations (#4864) * Add device plugin doc under concepts/cluster-administration. (#5261) * Add device plugin doc under concepts/cluster-administration. * Update device-plugins.md * Update device-plugins.md Add meta description. Fix typo. Change bare metal deployment to manual deployment. * Update device-plugins.md Fix typo again. * Update page.version. (#5341) * Add documentation on storageClass.reclaimPolicy (#5171) * [Advanced audit] use new herf for audit-api (#5349) This tag contains all the changes in v1beta1 version. Update it now. * Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255) * Documentation for kubectl plugins (#5294) * Documentation for kubectl plugins * Update kubectl-plugins.md * Update kubectl-plugins.md * Updated CPU manager docs to match implementation. (#5332) * Noted limitation of alpha static cpumanager. * Updated CPU manager docs to match implementation. - Removed references to CPU pressure node condition and evictions. - Added note about new --cpu-manager-reconcile-period flag. - Added note about node allocatable requirements for static policy. - Noted limitation of alpha static cpumanager. * Move cpu-manager task link to rsc mgmt section. * init containers annotation removed in 1.8 (#5390) * Add documentation for TaintNodesByCondition (#5352) * Add documentation for TaintNodesByCondition * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Fix deployments (#5421) * Document extended resources and OIR deprecation. (#5399) * Document extended resources and OIR deprecation. * Updated extended resources doc per reviews. * reverts extra spacing in _data/tasks.yml * addresses `kubeadm upgrade` review comments Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit * HugePages documentation (#5419) * Update cpu-management-policies.md (#5407) Fixed the bad link. Modified "cpu" to "CPU". Added more 'yaml' as supplement. * Update RBAC docs for v1 (#5445) * Add user docs for pod priority and preemption (#5328) * Add user docs for pod priority and preemption * Update pod-priority-preemption.md * More updates * Update docs/admin/kubeadm.md for 1.8 (#5440) - Made a couple of minor wording changes (not strictly 1.8 related). - Did some reformatting (not strictly 1.8 related). - Updated references to the default token TTL (was infinite, now 24 hours). - Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`. - Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples. - Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes. - Documented the new `--groups` flag for `kubeadm token create`. - Added a note of caution under _Automating kubeadm_ that references the _Security model_ section. - Updated the component version table to drop 1.6 and add 1.8. - Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`. * Update StatefulSet Basics for 1.8 release (#5398) * addresses `kubeadm upgrade` review comments 2nd iteration review comments by @luxas * adds kubelet upgrade section to kubeadm upgrade * Fix a bulleted list on docs/admin/kubeadm.md. (#5458) I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow. This was introduced recently in #5440. * Clarify the API to check for device plugins * Moving Flexvolume to separate out-of-tree section * addresses `kubeadm upgrade` review comments CC: @luxas * fixes kubeadm upgrade index * Update Stackdriver Logging documentation (#5495) * Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526) * Update statefulset concepts doc to use apps/v1beta2 APIs (#5420) * add document on kubectl's behavior regarding initializers (#5505) * Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497) This is a new beta feature in 1.8. * Update kubectl patch doc to use apps/v1beta2 APIs (#5422) * [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525) * Update replicated stateful application task for 1.8. * Update single instance stateful app task for 1.8. * Update stateless app task for 1.8. * Update kubectl patch task for 1.8. * fix the link of persistent storage (#5515) * update the admission-controllers.md index.md what-is-kubernetes.md link * fix the link of persistent storage * Add quota support for local ephemeral storage (#5493) * Add quota support for local ephemeral storage update the doc to this alpha feature * Update resource-quotas.md * Updated Deployments concepts doc (#5491) * Updated Deployments concepts doc * Addressed comments * Addressed more comments * Modify allocatable storage to ephemeral-storage (#5490) Update the doc to use ephemeral-storage instead of storage * Revamped concepts doc for ReplicaSet (#5463) * Revamped concepts doc for ReplicaSet * Minor changes to call out specific versions for selector defaulting and immutability * Addressed doc review comments * Remove petset documentations (#5395) * Update docs to use batch/v1beta1 cronjobs (#5475) * add federation job doc (#5485) * add federation job doc * Update job.md Edits for clarity and consistency * Update job.md Fixed a typo * update DaemonSet concept for 1.8 release (#5397) * update DaemonSet concept for 1.8 release * Update daemonset.md Fix typo. than -> then * Update bootstrap tokens doc for 1.8. (#5479) * Update bootstrap tokens doc for 1.8. This has some changes I missed when I was updating the main kubeadm documention: - Bootstrap tokens are now beta, not alpha (kubernetes/enhancements#130) - The apiserver flag to enable the authenticator changedin 1.8 (kubernetes/kubernetes#51198) - Added `auth-extra-groups` documentaion (kubernetes/kubernetes#50933) - Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information. * Update bootstrap-tokens.md * Updated the Cassandra tutorial to use apps/v1beta2 (#5548) * add docs for AllowPrivilegeEscalation (#5448) Signed-off-by: Jess Frazelle <[email protected]> * Add local ephemeral storage alpha feature in managing compute resource (#5522) * Add local ephemeral storage alpha feature in managing compute resource Since 1.8, we add the local ephemeral storage alpha feature as one resource type to manage. Add this feature into the doc. * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Added documentation for Metrics Server (#5560) * authorization: improve authorization debugging docs (#5549) * Document mount propagation (#5544) * Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524) This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in kubernetes/kubernetes#49520 and some version bumps. * Add task doc for alpha dynamic kubelet configuration (#5523) * Fix input/output of selfsubjectaccess review (#5593) * Add docs for implementing resize (#5528) * Add docs for implementing resize * Update admission-controllers.md * Added link to PVC section * minor typo fixes * Update NetworkPolicy concept guide with egress and CIDR changes (#5529) * update zookeeper tutorial for 1.8 release * add doc for hostpath type (#5503) * Federated Hpa feature doc (#5487) * Federated Hpa feature doc * Federated Hpa feature doc review fixes * Update hpa.md * Update hpa.md * update cloud controller manager docs for v1.8 * Update cronjob with defaults information (#5556) * Kubernetes 1.8 reference docs (#5632) * Kubernetes 1.8 reference docs * Kubectl reference docs for 1.8 * Update side bar with 1.8 kubectl and api ref docs links * remove petset.md * update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644) * Fix cron job deletion section (#5655) * update imported docs (#5656) * Add documentation for certificate rotation. (#5639) * Link to using kubeadm page * fix the command output fix the command output * fix typo in api/resources reference: "Worloads" * Add documentation for certificate rotation. * Create TOC entry for cloud controller manager. (#5662) * Updates for new versions of API types * Followup 5655: fix link to garbage collection (#5666) * Temporarily redirect resources-reference to api-reference. (#5668) * Update config for 1.8 release. (#5661) * Update config for 1.8 release. * Address reviewer comments. * Switch references in HPA docs from alpha to beta (#5671) The HPA docs still referenced the alpha version. This switches them to talk about v2beta1, which is the appropriate version for Kubernetes 1.8 * Deprecate openstack heat (#5670) * Fix typo in pod preset conflict example Move container port definition to the correct line. * Highlight openstack-heat provider deprecation The openstack-heat provider for kube-up is being deprecated and will be removed in a future release. * Temporarily fix broken links by redirecting. (#5672) * Fix broken links. (#5675) * Fix render of code block (#5674) * Fix broken links. (#5677) * Add a small note about auto-bootstrapped CSR ClusterRoles (#5660) * Update kubeadm install doc for v1.8 (#5676) * add draft workloads api content for 1.8 (#5650) * add draft workloads api content for 1.8 * edits per review, add tables, for 1.8 workloads api doc * fix typo * Minor fixes to kubeadm 1.8 upgrade guide. (#5678) - The kubelet upgrade instructions should be done on every host, not just worker nodes. - We should just upgrade all packages, instead of calling out kubelet specifically. This will also upgrade kubectl, kubeadm, and kubernetes-cni, if installed. - Draining nodes should also ignore daemonsets, and master errors can be ignored. - Make sure that the new kubeadm download is chmoded correctly. - Add a step to run `kubeadm version` to verify after downloading. - Manually approve new kubelet CSRs if rotation is enabled (known issue). * Release 1.8 (#5680) * Fix versions for 1.8 API ref docs * Updates for 1.8 kubectl reference docs * Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681) * Update docs/admin/kubeadm.md (mostly 1.8 related). This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this). * A few of my own edits to clarify and clean up some Markdown.
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds documentation of mount propagation feature kubernetes/enhancements#432
It's hard to describe mount propagation in a few paragraphs, it's quite confusing topic.
This change is