docs update to promote TaintNodesByCondition to beta #9626
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
the
size/M
k8s-ci-robot
added
the
cncf-cla: yes
15 tasks
|
@idvoretskyi @justaugustus @MistyHacks could you help to assign some people to do both editor and tech review? Thanks. |
|
/assign @zparnold |
k82cn
reviewed
Jul 26, 2018
| @@ -76,11 +76,10 @@ the "Terminating" or "Unknown" states. In cases where Kubernetes cannot deduce f | |||
| permanently left a cluster, the cluster administrator may need to delete the node object by hand. Deleting the node object from | |||
| Kubernetes causes all the Pod objects running on it to be deleted from the apiserver, freeing up their names. | |||
|
|
|||
| Version 1.8 introduced an alpha feature that automatically creates | |||
| In version 1.12, `TaintNodesByCondition` feature is promoted to beta，so node controller automatically creates | |||
There was a problem hiding this comment.
s/node controller/node lifecycle controller/
k82cn
reviewed
Jul 26, 2018
| `--feature-gates=FooBar=true,TaintNodesByCondition=true`), the scheduler does not check Node conditions; instead the scheduler checks taints. This assures that Node conditions don't affect what's scheduled onto the Node. The user can choose to ignore some of the Node's problems (represented as Node conditions) by adding appropriate Pod tolerations. | ||
| In version 1.12, `TaintNodesByCondition` feature is promoted to beta, so node controller automatically creates taints corresponding to | ||
| Node conditions. | ||
| > this feature can be disabled by including `TaintNodesByCondition=true` in the `--feature-gates` command line flag to the scheduler, such as |
k82cn
reviewed
Jul 26, 2018
| Node conditions. | ||
| > this feature can be disabled by including `TaintNodesByCondition=true` in the `--feature-gates` command line flag to the scheduler, such as | ||
| `--feature-gates=...,TaintNodesByCondition=false`). | ||
| Similarly the scheduler does not check Node conditions; instead the scheduler checks taints. This assures that Node conditions don't affect what's scheduled onto the Node. The user can choose to ignore some of the Node's problems (represented as Node conditions) by adding appropriate Pod tolerations. |
There was a problem hiding this comment.
This assures that Node conditions don't affect what's scheduled onto the Node
We'd better to clarify that TaintNodesByCondition only taints node with NoSchedule effect. As TaintBasedEviction will taint NoExecute.
k82cn
reviewed
Jul 26, 2018
| `unschedulable` Nodes when scheduling DaemonSet Pods. You must enable | ||
| `TaintNodesByCondition` to ensure that the default scheduler behaves the same | ||
| way and schedules DaemonSet pods on `unschedulable` nodes. | ||
| `unschedulable` Nodes when scheduling DaemonSet Pods. |
There was a problem hiding this comment.
The DaemonSet pod did not scheduling pods.
Huang-Wei
force-pushed
the
1.12-promote-TaintNodesByCondition-beta
branch
from
6a6aba0
to
7f54cb0
Compare
|
@k82cn Thanks for the review. All comments have been addressed. |
|
@k82cn PTAL |
|
/hold |
k8s-ci-robot
added
the
do-not-merge/hold
|
sorry for the delay :(, I'll review it this week :) |
Huang-Wei
force-pushed
the
1.12-promote-TaintNodesByCondition-beta
branch
from
7f54cb0
to
a2be01b
Compare
|
Friendly ping @k82cn |
bsalamat
reviewed
Aug 14, 2018
| `--feature-gates=FooBar=true,TaintNodesByCondition=true`), the scheduler does not check Node conditions; instead the scheduler checks taints. This assures that Node conditions don't affect what's scheduled onto the Node. The user can choose to ignore some of the Node's problems (represented as Node conditions) by adding appropriate Pod tolerations. | ||
| In version 1.12, `TaintNodesByCondition` feature is promoted to beta, so node lifecycle controller automatically creates taints corresponding to | ||
| Node conditions. | ||
| > this feature can be disabled by including `TaintNodesByCondition=false` in the `--feature-gates` command line flag to the scheduler, such as `--feature-gates=...,TaintNodesByCondition=false`). |
There was a problem hiding this comment.
Why quoted text?
Also the ) at the end of the sentence should be removed.
There was a problem hiding this comment.
Also "this" should be capitalized.
There was a problem hiding this comment.
@bsalamat Quoted is for just explanation purpose - to tell user it's a beta feature, and they can disable it if they want. If it's unnecessary, it can be totally removed.
There was a problem hiding this comment.
The quoted text is rendered with lighter font color and gives the impression that it is not important. I would put the text under a sub-section called "how to disable" or something like that.
There was a problem hiding this comment.
To avoid confusion, I would like to remove the section. Even if people needs to disable it, they should be able to infer which parameter to pass.
And I notice that most of beta features didn't mention how to disable them.
| | `node.kubernetes.io/unreachable` | NoExecute | `TaintBasedEvictions` - Alpha | 1.8+ | when `TaintBasedEvictions` is enabled, they will not be evicted when there are node problems such as a network partition. | | ||
| | `node.kubernetes.io/disk-pressure` | NoSchedule | `TaintNodesByCondition` - Beta | 1.12+ | | | ||
| | `node.kubernetes.io/memory-pressure` | NoSchedule | `TaintNodesByCondition` - Beta | 1.12+ | | | ||
| | `node.kubernetes.io/unschedulable` | NoSchedule | `ScheduleDaemonSetPods` - Alpha</br> `TaintNodesByCondition` - Beta</br> | 1.11+</br> 1.12+</br> | When ` ScheduleDaemonSetPods` is enabled, DaemonSet pods tolerate unschedulable attributes by default scheduler. | |
There was a problem hiding this comment.
I am not so sure about these line breaks in the table. Since different cells have different amount of text, the lines in two columns of the same row are not perfectly aligned. Some users may not realize that the versions of K8s correspond to the features.
On another note, I am not sure if we should put Beta features in this table. Beta features are enabled by default and may not be needed here.
There was a problem hiding this comment.
There are 3 flags here described as alpha features. But 2 of them (TaintNodesByCondition and ScheduleDaemonSetPods) are going to be beta in 1.12, so I changed the column name from "Alpha" to "Alpha/Beta", and split into two lines using </br> as well as in "Version" column.
It might look a little tricky.. So if beta features are not needed to mention here, things are easier. @bsalamat Are you ok with removing beta feature flags in this table?
There was a problem hiding this comment.
I think it would be better to remove the beta features as they are enabled by default. Those wondering what features where in alpha in older releases could refer to 1.11 documentation.
Huang-Wei
force-pushed
the
1.12-promote-TaintNodesByCondition-beta
branch
from
a2be01b
to
bb8eb90
Compare
k8s-ci-robot
added
the
lgtm
|
Thanks, @Huang-Wei! |
|
ping @zparnold. Could you please approve this PR? |
|
/hold cancel |
k8s-ci-robot
removed
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: zparnold 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 |
k8s-ci-robot
added
the
approved
detiber
pushed a commit
to detiber/kubernetes-website
that referenced
this pull request
Sep 19, 2018
k8s-ci-robot
pushed a commit
that referenced
this pull request
Sep 27, 2018
* Update docs for fields allowed at root of CRD schema (#9973) * add plugin docs and examples (#10053) * docs update to promote TaintNodesByCondition to beta (#9626) * HPA Specificity Improvements (#8757) Updated the HPA docs to reference the `autoscaling/v2beta2` API version, and added documentation about the new fields. * adjust docs for pod ready++ (#10049) * Remove --cadvisor-port - has been deprecated since v1.10 (#10023) Change-Id: Id2a685473a243aef492a98ff450759f39e362557 * Add Documentation for Snapshot Feature (#9948) * Add documentation for snapshot feature * Update volume-snapshots.md * Add dry-run to api-concepts (#10033) * kubeadm-init: Update the offline support section (#10062) The update includes the following things (in mind with Kubernetes 1.12): - Remove the 1.8 image versions - Add the 1.10 image versions that were missing until now - Include a comment for the missing arch suffixes in 1.12 Signed-off-by: Rostislav M. Georgiev <rostislavg@vmware.com> * Say bye to `DynamicProvisioningScheduling` (#10157) The mentioned feature gate is now collapsed into `VolumeScheduling`. xref: kubernetes/kubernetes#67432 * Update ResourceQuota per PriorityClass state for 1.12 (#10229) * TokenRequest and TokenRequestProjection now beta (#10161) xref: kubernetes/kubernetes#67349 * Change feature state for kms provider to beta. (#10230) KMS Provider will be graduating to beta in v1.12, reflecting this change on the website. * coredns default (#10200) * Promote ShareProcessNamespace to beta in docs (#9996) * Add CoreDNS details to DNS Debug docs (#10201) * add coredns details * address nits, add query logging section * Update docs with topology aware dynamic provisioning (#9939) * Document topology aware volume binding feature * update for readability * Update storage-classes.md * comma splice * don't abbreviate * HPA Algorithm Information Improvements (#9780) * Update HPA docs with more algorithm details The HPA docs pointed to an out-of-date document for information on the algorithm details, which users were finding confusing. This sticks a section on the algorithm in the HPA docs instead, documenting both general behavior and corner cases. * Add glossary info, HPA docs on quantities People often ask about the quantity notation when working with the metrics APIs, so this adds a glossary entry on quantities (since they're used elsewhere in the system), and a short explantation in the HPA walkthough. * Information about HPA readiness and stabilization This adds information about the new changes to HPA readiness and stabilization from kubernetes/enhancements#591, and other minor changes that landed in Kubernetes 1.12. * Update horizontal-pod-autoscale.md * Audit 1.12 doc (#9953) * audit 1.12 document * remove legacy audit feature kubernetes/kubernetes#65862 * update feature gate doc * MountPropagation is now GA (#10090) * RuntimeClass documentation (#10102) * RuntimeClass documentation * Update runtime-class.md * Add documentation for Scheduler performance tuning (#10048) * Add documentation for Scheduler performance tuning * Update scheduler-perf-tuning.md * TTL controller for cleaning up finished resources (#10064) * TTL controller for cleaning up finished resources * Address comments * Update ttlafterfinished.md * Bump quota configuration api version (#10217) * Incremental update from master (#10278) * fix invalid href of cloud controller manager (#10240) * fix invalid yaml format (#10238) * update storage-limits doc with Azure disk part (#10224) update storage-limits doc with Azure disk part fix comments * Update kubelet-config-file.md (#10222) Update link to KubeletConfiguration struct. * fix a trivial misspelling (#10244) * Fix cassandra-statefulset.yaml indent level (#10243) * Mention minimum etcd versions (#10208) Source: https://groups.google.com/d/msg/kubernetes-dev/jMPA4JzKiY4/HIx2ugvLBAAJ * fix 404 error (#10250) * Small verb tweak (#10190) Present participle, ftw. * Add AnchorJS logic for header links (#10155) * Add AnchorJS JavaScript * Remove existing inpage_heading logic * Remove underline from anchor tags * Use single icon and add touch visibility * Use paragraph link icon for AnchorJS * Update Sass to use code formatting in docsContent headers * Update header size coverage to H3-H6 * fix broken link in kubefed.md (#10254) * Update the version numbers for the X-Remote-Extra- and Impersonate-Extra- key fixes (#9827) The fix was cherry picked into 1.11.3, 1.10.7, and 1.9.11: kubernetes/kubernetes#67162 kubernetes/kubernetes#67163 kubernetes/kubernetes#67164 * fix typo (#10168) * fix typo * addressing comments. * Update setup-ha-etcd-with-kubeadm.md * fix typos (#10252) * fix description of contribute guide (#10253) * describe truncate feature about advanced audit (#10236) * describe truncate feature about advanced audit * Update audit.md * docs update to promote ScheduleDaemonSetPods to beta (#9923) * Dynamic volume limit updates for 1.12 (#10211) * add a placeholder commit * Update docs for csi volume limits * Update storage-limits.md * Add "MayRunAs" value among other GroupStrategies (#9888) * Add CoreDNS details to the customize DNS doc (#10228) * Add CoreDNS details to the customize DNS doc Rewrite the document to include more details about CoreDNS, since it's now the default from v1.12 * Address comments * Improve doc wording * Fix link * Update dns-custom-nameservers.md * Update dns-custom-nameservers.md * Fix secrets docs in 1.12 branch (#10056) * Fix secrets docs * Update secret.md * Revert CoreDNS Docs (#10319) * Revert "Add CoreDNS details to DNS Debug docs (#10201)" This reverts commit 462817a. * Revert "Add CoreDNS details to the customize DNS doc (#10228)" This reverts commit e7319ee. * Revert "coredns default (#10200)" This reverts commit 698e93b. * Add CRI installation instructions page Added cri-installation page with CRI installation instructions Referenced it from kubeadm-init and install-kubeadm pages. * kubeadm: update API types documentation for 1.12 (#10283) v1alpha2 -> v1alpha3 MasterConfiguration -> [new-api-types] * TokenRequest feature documentation (#10295) * AdvancedAuditing is now GA (#10156) xref: kubernetes/kubernetes#65862 `AdvancedAuditing` feature is GA in 1.12. This PR adjusts the related docs. * update runtime-class.md (#10332) * update runtime-class.md * Update runtime-class.md * Document cross-authorizer permissions for creating RBAC roles (#10015) * Document cross-authorizer permissions for creating RBAC roles * Update rbac.md * kubeadm: update authored content for 1.12 (reference docs and cluster creation) (#10348) * kubeadm: update authored content in reference docs for 1.12 * kubeadm: add time frame in create-cluster-kubeadm for 1.12 * add AllowedProcMountTypes and ProcMountType to docs (#9911) Signed-off-by: Jess Frazelle <acidburn@microsoft.com> * kubeadm: add new command line reference (#10306) Add: - placeholder files - include place holder files - include "renew" sub command - add missing tabs for "alpha phase kubelet" * Documenting SCTP support in Kubernetes (#10279) * Documenting SCTP support in Kubernetes Service, Endpoint, NetworkPolicy and Pod * Updates based on comments on the PR * kubectl expose update with SCTP support * Updated according to comments in the PR * Revert "kubectl expose update with SCTP support" This reverts commit 0d5a1e6. * TLS Bootstrap and Server Cert Rotation feature documentation (#10232) * TokenRequest feature documentation * line wrapping to make review not insane * update content for GA without major refactor * Update kubelet-tls-bootstrapping.md * Add clarifications for volume snapshots (#10296) * Update kubadm ha installation for 1.12 (#10264) * Update kubadm ha installation for 1.12 Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * update stable version Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * Update stacked control plane for v1.12 (#2) * use v1alpha3 Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * more v1alpha3 (#4) * updates Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * Document how to run in-tree cloud providers with kubeadm (#10357) Change-Id: Iab6b996a830503d74a6eb0c507c5f8ca7a39235b * kubeadm reference doc for release 1.12 (#10359) * Revert "Revert "Add CoreDNS details to DNS Debug docs (#10201)"" This reverts commit bb30f4d. * Revert "Revert "Add CoreDNS details to the customize DNS doc (#10228)"" This reverts commit bc23d45. * Revert "Revert "coredns default (#10200)"" This reverts commit 7f4350d. * add missing instruction for ha guide (#10374) Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * kubeadm - Ha upgrade updates (#10340) * Update HA upgrade docs * Adds external etcd HA upgrade guide Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * copyedit * more edits * add runasgroup in psp (#10076) * update KubeletPluginsWatcher feature gate (#10205) * generated 1.12 docs * Building Multi-arch images with Manifests (#10379) In 1.12, a variety of images used in a typical kubernetes installation have started to using manifests to better support environments with arm or ppc64le architectures. For example all images used with kubeadm by default have manifests, another would be all the tests in the conformance test suite. Here we capture the best practices for everyone to start using manifests in their own workflows. Change-Id: I5ba4c5fe55ffc9486a8251760f3352be4f2e1494 * Upgrade docs for v1.12 (#10344) * generated assets and docs * remove 1.7 * update 1.12 * update plugin documentation under docs>tasks>extend-kubectl (#10259) * update plugin documentation under docs>tasks>extend-kubectl * Update kubectl-plugins.md
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.
TaintNodesByCondition is agreed to promote to beta in 1.12. This PR is used to track all website related changes.
Part of kubernetes/kubernetes#62109.