update DaemonSet concept for 1.8 release #5397
Merged
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
cncf-cla: yes
|
Deploy preview ready! Built with commit 4059b65 https://deploy-preview-5397--kubernetes-io-vnext-staging.netlify.com |
steveperry-53
requested review from
janetkuo
and removed request for
foxish and
erictune
| then DaemonSet controller will create pods on nodes which match that [node affinity](/docs/concepts/configuration/assign-pod-node/). | ||
| If you do not specify either, then the DaemonSet controller will create pods on all nodes. | ||
| then DaemonSet controller will create Pods on nodes which match that [node affinity](/docs/concepts/configuration/assign-pod-node/). | ||
| If you do not specify either, then the DaemonSet controller will create Pods on all nodes. | ||
|
|
There was a problem hiding this comment.
then DaemonSet controller -> the DaemonSet controller
| the pod runs on. Use a Daemon Controller when it is important that a copy of a pod always run on | ||
| all or certain hosts, and when it needs to start before other pods. | ||
| the Pod runs on. Use a DaemonSet when it is important that a copy of a Pod always run on | ||
| all or certain hosts, and when it needs to start before other Pods. |
There was a problem hiding this comment.
Deploymt -> Deployment
|
|
||
| The `.spec.template` is a [pod template](/docs/concepts/workloads/pods/pod-overview/#pod-templates). It has exactly the same schema as a [pod](/docs/concepts/workloads/pods/pod/), except it is nested and does not have an `apiVersion` or `kind`. | ||
| The `.spec.template` is a [Pod Template](/docs/concepts/workloads/pods/pod-overview/#pod-templates). It has exactly the same schema as a [Pod](/docs/concepts/workloads/pods/pod/), except it is nested and does not have an `apiVersion` or `kind`. | ||
|
|
There was a problem hiding this comment.
Our style is to refer to API objects the same way the object is spelled and capitalized. So instead of Pod Template, we would write PodTemplate.
And I see now that there is another problem here. Start with a DaemonSet. The spec.template field is not a PodTemplate. Rather, it is a PodTemplateSpec.
foxish
reviewed
Sep 12, 2017
| @@ -47,21 +51,27 @@ A DaemonSet also needs a [`.spec`](https://git.k8s.io/community/contributors/dev | |||
|
|
|||
| ### Pod Template | |||
|
|
|||
| The `.spec.template` is the only required field of the `.spec`. | |||
| The `.spec.template` is one of the required fields `.spec`. | |||
There was a problem hiding this comment.
We could say: .spec.template and .spec.selector are required fields.
I realize as per the types.go, only the former is "required", but we block with validation an empty field in the latter as well.
There was a problem hiding this comment.
In the pod selector section I added details about defaulting and its removal in 1.8
| a [Job](/docs/concepts/jobs/run-to-completion-finite-workloads/) or other new resources. | ||
|
|
||
| As of Kubernetes 1.8, you must specify a Pod Selector that matches the labels of the |
There was a problem hiding this comment.
matches some subset of labels? We don't require that it is an exact match IIUC.
There was a problem hiding this comment.
throughout the documentation we use match to mean something akin to selector.matches == true
| collected. Deleting a DaemonSet will clean up the pods it created. | ||
| A _DaemonSet_ ensures that all (or some) Nodes run a copy of a Pod. As nodes are added to the | ||
| cluster, Pods are added to them. As nodes are removed from the cluster, those Pods are garbage | ||
| collected. Deleting a DaemonSet will clean up the Pods it created. |
There was a problem hiding this comment.
Maybe we should mention that this documentation is for the behavior introduced in apps/v1beta2, in case people try to use an older api version and expect this behavior.
There was a problem hiding this comment.
this is GC. It's been in since 1.6 and doesn't have anything to do with the new API
| equal to `Always`, or be unspecified, which defaults to `Always`. | ||
|
|
||
| ### Pod Selector | ||
|
|
||
| The `.spec.selector` field is a pod selector. It works the same as the `.spec.selector` of | ||
| The `.spec.selector` field is a Pod Selector. It works the same as the `.spec.selector` of | ||
| a [Job](/docs/concepts/jobs/run-to-completion-finite-workloads/) or other new resources. | ||
|
|
There was a problem hiding this comment.
If you're going to talk generically about selecting Pods, you would use Pod selector (lower-case s).
If you're going to talk about API objects, then use caps, but use the actual API object like this:
The spec.selector field is a LabelSelector.
| created by the Daemon controller have the machine already selected (`.spec.nodeName` is specified | ||
| when the pod is created, so it is ignored by the scheduler). Therefore: | ||
| when the Pod is created, so it is ignored by the scheduler). Therefore: |
There was a problem hiding this comment.
Daemon controller -> DaemonSet controller ?
|
|
||
| - The [`unschedulable`](/docs/admin/node/#manual-node-administration) field of a node is not respected | ||
| by the DaemonSet controller. | ||
| - DaemonSet controller can make pods even when the scheduler has not been started, which can help cluster | ||
| - DaemonSet controller can make Pods even when the scheduler has not been started, which can help cluster | ||
| bootstrap. |
There was a problem hiding this comment.
DaemonSet controller -> The DaemonSet controller
| matching labels. It will not modify or delete them despite a mismatch in the pod template. | ||
| You will need to force new pod creation by deleting the pod or deleting the node. | ||
| the new DaemonSet with the different template will recognize all the existing Pods as having | ||
| matching labels. It will not modify or delete them despite a mismatch in the Pod template. |
| a node for testing. | ||
|
|
||
| If you attempt to create a DeamonSet such that | ||
|
|
There was a problem hiding this comment.
DeamonSet -> DaemonSet
kow3ns
force-pushed
the
ds-concpet-1.8
branch
from
0ef906c
to
0f4365d
Compare
kow3ns
force-pushed
the
ds-concpet-1.8
branch
from
0f4365d
to
01e4693
Compare
tengqm
requested changes
Sep 16, 2017
| then DaemonSet controller will create pods on nodes which match that [node affinity](/docs/concepts/configuration/assign-pod-node/). | ||
| If you do not specify either, then the DaemonSet controller will create pods on all nodes. | ||
| then DaemonSet controller will create Pods on nodes which match that [node affinity](/docs/concepts/configuration/assign-pod-node/). | ||
| If you do not specify either, than the DaemonSet controller will create Pods on all nodes. |
There was a problem hiding this comment.
please change 'than' back to 'then'.
janetkuo
reviewed
Sep 18, 2017
There was a problem hiding this comment.
The behavior changes (i.e. selector immutability) mentioned in this PR only apply to apps/v1beta2 DaemonSet. How should we handle this in our docs? Perhaps mention that apps/v1beta2 is the API version that we encourage users to use, and is different from other API versions?
|
@janetkuo, Is your question about the behavior change in apps/v1beta2 for us on the docs team, and is it a general question for the doc set as a whole? Or is your question primarily about adding a note to this individual topic? |
|
Earlier discussion about this in #5398 (comment). |
Fix typo. than -> then
tengqm
approved these changes
Sep 20, 2017
janetkuo
approved these changes
Sep 20, 2017
|
@janetkou I would go with indicating that apps/v1beta2 is the current version and update the examples to reflect it. Based on precedence we don't seem to explicitly mention the group version of a kind in the documentation. We always mention the stability and reference the behavior of the current default version. |
foxish
approved these changes
Sep 20, 2017
This change is good to me. However current default version isn't |
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 <acidburn@microsoft.com> * 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.
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.
Updates the DaemonSet concept to be compatible with the 1.8 release.
This change is