PodDisruptionBudget documentation Improvements #4140
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
cncf-cla: yes
|
This depends on and includes #3885. |
janetkuo
reviewed
Jun 20, 2017
|
|
||
| ## Voluntary and Involuntary Disruptions | ||
|
|
||
| Pods generally do not dissappear until someone (a person or the controller) destroys them |
| However, once bound to a particular node, it is bound to that node for the rest of its lifetime. | ||
| If a node dies or is disconnected, the pod is terminated. Kubernetes controllers automatically | ||
| create replacement pods when this happens. | ||
| (Read more about [pod lifetime](docs/concepts/workloads/pods/pod-lifecycle/#pod-lifetime)).) |
| Some node failures are unavoidable. We call these *involuntary disruptions* to | ||
| an applicaton; for example, a hardware failure, kernel panic may cause | ||
| the node to disappear from the cluster, taking its Pods with it. Other examples | ||
| are a node that is `NotReady` a cluster network partition, or an eviction of a pod |
| highly availabile applications, and thus need to understand | ||
| what types of Disruptions can happen to Pods. | ||
|
|
||
| It is also for Cluster Administrators will want to perform automated |
| and [stateful](docs/tasks/run-application/run-replicated-stateful-application.md) applications.) | ||
| Simultaneous failures of multiple nodes is less likely. For even higher availability, use | ||
| multi-zone clusters, spread applications across racks (using | ||
| [anti-affinity](docs/user-guide/node-selection/#inter-pod-affinity-and-anti-affinity-beta-feature) |
| 1. Accept downtime during the upgrade. Schedule a time for this. | ||
| 2. Fail over to another complete replica cluster. No downtime, but may be costly | ||
| both for the duplicated nodes, and for human effort to orchestrate the switchover. | ||
| 3. Write disruption tolerant applications and use PDBs. No downtime, lower resource cost, and allows increasing automation of cluster administration. PDBs help with this case. Does require evaluation of |
There was a problem hiding this comment.
"Does require evaluation of" --> unfinished sentence
There was a problem hiding this comment.
Mark option 3 as (recommended)?
There was a problem hiding this comment.
I'm not sure I know enough about users to blanket recommend 3.
| However, once bound to a particular node, it is bound to that node for the rest of its lifetime. | ||
| If a node dies or is disconnected, the pod is terminated. Kubernetes controllers automatically | ||
| create replacement pods when this happens. | ||
| (Read more about [pod lifetime](docs/concepts/workloads/pods/pod-lifecycle/#pod-lifetime)).) |
There was a problem hiding this comment.
Links should be /docs/... otherwise it'll be 404
|
|
||
| ## Specifying a PodDisruptionBudget | ||
|
|
||
| A `PodDisruptionBudget` has three components, of which two must be specified: |
There was a problem hiding this comment.
All these fields (components) are under .spec
| - "/docs/tasks/administer-cluster/configure-pod-disruption-budget/" | ||
| --- | ||
|
|
||
| {% capture overview %} |
There was a problem hiding this comment.
Should we mention that DaemonSet can't be used with PDB or it's obvious?
There was a problem hiding this comment.
This is mentioned elsewhere.
|
|
||
| Identify the pod selector used by your controller. You will use this in the | ||
| `PodDisruptionBudget` to select the pods protected by the PDB. These | ||
| selectors should match. |
There was a problem hiding this comment.
What happens if the user specifies a PDB that selects pods controlled by more than one controller?
cody-clark
reviewed
Jun 20, 2017
| highly availabile applications, and thus need to understand | ||
| what types of Disruptions can happen to Pods. | ||
|
|
||
| It is also for Cluster Administrators will want to perform automated |
There was a problem hiding this comment.
Administrators who* (gets rid of future tense per style guide and adds needed pronoun)
| what types of Disruptions can happen to Pods. | ||
|
|
||
| It is also for Cluster Administrators will want to perform automated | ||
| cluster actions, like upgrades and cluster autoscaling. |
There was a problem hiding this comment.
change to “like upgrading and autoscaling clusters” (parallel construction)
|
|
||
| ## Voluntary and Involuntary Disruptions | ||
|
|
||
| Pods generally do not dissappear until someone (a person or the controller) destroys them |
There was a problem hiding this comment.
Delete generally (unless we want to explain those edge cases)
add period after "them."
| ## Voluntary and Involuntary Disruptions | ||
|
|
||
| Pods generally do not dissappear until someone (a person or the controller) destroys them | ||
| However, once bound to a particular node, it is bound to that node for the rest of its lifetime. |
There was a problem hiding this comment.
Delete “however” (the sentence doesn't contradict its predecessor)
Unclear antecedent. RW "Once bound to a particular node, the pod is bound to that node for the rest of its lifetime."
| may also perform voluntary evictions. | ||
|
|
||
| All sources of voluntary disruptions are optional with Kubernetes. | ||
| Ask you cluster administrator or consult your cloud provider or distribution documentation |
There was a problem hiding this comment.
"your cluster administrator"
| is the `scale` of the controller managing the pods being selected by the | ||
| `PodDisruptionBudget`. | ||
|
|
||
| Example 1: With a `minAvailable` of 5, evictions will be allowed as long as they leave behind |
There was a problem hiding this comment.
''...evictions are allowed as long as..."
| Example 1: With a `minAvailable` of 5, evictions will be allowed as long as they leave behind | ||
| 5 or more healthy pods among those selected by the PodDisruptionBudget's `selector`. | ||
|
|
||
| Example 2: With a `minAvailable` of 30%, evictions will be allowed as long as at least 30% |
| Example 2: With a `minAvailable` of 30%, evictions will be allowed as long as at least 30% | ||
| of the number of desired replicas are healthy. | ||
|
|
||
| Example 3: With a `maxUnavailable` of 5, evictions will be allowed as long as there are at most 5 |
| Example 3: With a `maxUnavailable` of 5, evictions will be allowed as long as there are at most 5 | ||
| unhealthy replicas among the total number of desired replicas. | ||
|
|
||
| Example 4: With a `maxUnavailable` of 30%, evictions will be allowed as long as no more than 30% |
| In typical usage, a single budget would be used for a collection of pods managed by | ||
| a controller—for example, the pods in a single ReplicaSet or StatefulSet. | ||
|
|
||
| Note that a disruption budget does not truly guarantee that the specified |
There was a problem hiding this comment.
"Note: A disruption budget...."
We should address callouts in the style guide (note, caution, warning, etc)
|
All Janet's comments addressed except where replied otherwise. Will tackle @cody-clark 's detailed comments later this week. |
|
Ok, just ping me when this is ready to be merged. |
mml
previously requested changes
Jun 22, 2017
| (Read more about [pod lifetime](/docs/concepts/workloads/pods/pod-lifecycle/#pod-lifetime).) | ||
|
|
||
| Some node failures are unavoidable. We call these *involuntary disruptions* to | ||
| an applicaton; for example, a hardware failure, kernel panic may cause |
There was a problem hiding this comment.
hardware failure or kernel panic
| ensure that the number of replicas serving load never falls below a certain | ||
| percentage of the total, even briefly. | ||
|
|
||
| Cluster management tools can use the `Eviction API` to "safely delete" pods |
There was a problem hiding this comment.
Hyperlink to... something please. We're using a Proper Name for the first time. Maybe just link to safely-drain-node.md?
| When a tool attempts to delete a pod using the Eviction API, Kuberetes checks if the proposed | ||
| delete would leave the application with enough replicas. If not, it rejects the request. | ||
| The tool retries again later, and will typically succeed later. | ||
| The `kubectl drain` tool uses the Eviction API. |
There was a problem hiding this comment.
"as does cluster/gce/upgrade.sh starting in 1.7"?
| The "intended" number of pods is computed from the `.spec.replicas` of the pods controller. | ||
| The controller is discovered from the pods using the `.metadata.ownerReferences` of the object. | ||
|
|
||
| PDBs cannot prevent [involuntary disruptions](#voluntary-and-involuntary-disruptions) from |
There was a problem hiding this comment.
Is it worth noting that they can prevent an additional voluntary disruptions if involuntary ones have diminished capacity already?
| At this point, the cluster administrator needs to | ||
| add a node back to the cluster to proceed with the upgrade. | ||
|
|
||
| You can see how Kubernetes determine the rate at which disruptions, like node upgrades, |
There was a problem hiding this comment.
I must say, this section is very patient and detailed. Good job. I would not have thought to spell it out quite so clearly, even though I'm now certain the audience is going to profit from it big time.
| If you do not have such a separation of responsibilities in your organization, | ||
| you may not need to use Pod Disruption Budgets. In that case, when performing | ||
| cluster management tasks, like upgrading node software, and so on, you will | ||
| think the impact on your application at each step. |
There was a problem hiding this comment.
Whether consider or think, I believe we're missing something like a "need to" after "will".
|
|
||
| ## Identify an Application to Protect | ||
|
|
||
| PDBs can be used with applications the following types of application controllers: |
There was a problem hiding this comment.
Not sure I understand this. I can put a PDB on any collection of pods.
There was a problem hiding this comment.
It is trickier than that. I rewrote this section to explain this more clearly.
maisem
reviewed
Jun 23, 2017
|
|
||
| Cluster management tools can use the `Eviction API` to "safely delete" pods | ||
| while respecting Pod Disruption Budgets. | ||
| When a tool attempts to delete a pod using the Eviction API, Kuberetes checks if the proposed |
| while respecting Pod Disruption Budgets. | ||
| When a tool attempts to delete a pod using the Eviction API, Kuberetes checks if the proposed | ||
| delete would leave the application with enough replicas. If not, it rejects the request. | ||
| The tool retries again later, and will typically succeed later. |
There was a problem hiding this comment.
there are multiple actions that the cloud admin can take here
- keep retrying forever
- keep retrying for a certain amount of time (e.g. 1hr) and give up on the maintenance
- keep retrying for a certain amount of time (e.g. 1hr) and go through with the maintenance e.g. upgrade the node anyway
Ideally it would be 1, but realistically it'll be more like 3.
|
|
||
| Pods which are deleted or unavailable due to a rolling upgrade to an application do count | ||
| against the disruption budget, but controllers (like deployment and stateful-set) | ||
| are not limited by PDBs whe doing rolling upgrades -- the handling of failures |
| there is natural specialization of roles | ||
| - when third-party tools or services are used to automate cluster management | ||
|
|
||
| Pod Disrutption Budgets supports this separation of roles by providing an |
Title: Update PDB documentation to explain new field Author: foxish
New file: docs/concepts/workloads/pods/disruptions.md Intented contents: concept for Pod Disruption Budget, cross reference to Eviction and Preemption docs. Linked from: concepts > workloads > pods
New file: docs/tasks/run-application/configure-pdb.md Intented contents: task for writing a Pod Disruption Budget. Linked from: tasks > configuring-applications > configure pdb.
|
All Cody's comments addressed. |
|
Addressed review comments from mml and maisem. |
|
Once they give the tech lgtm, I will squash and merge this. Thanks @erictune ! |
|
FYI, all feedback must be addressed and LGTMs given by EOD Tue, June 27th so that this can be merged for the 1.7 release on June 28th. |
erictune
dismissed
mml’s stale review
I addressed it, but Github thinks I didn't.
tengqm
reviewed
Jun 28, 2017
| high availability. | ||
| * You should know how to deploy [Replicated Stateless Applications](/docs/tasks/run-application/run-stateless-application-deployment.md) | ||
| and/or [Replicated Stateful Applications](/docs/tasks/run-application/run-replicated-stateful-application.md). | ||
| * You should have read about the [Pod Disruption Budget concept](/docs/tasks/run-application/configure-pdb.md). |
There was a problem hiding this comment.
this points to the same doc, thus should be removed.
There was a problem hiding this comment.
Changed to Pod Disruptions.
| You can find examples of pod disruption budgets defined below. They match pods with the label | ||
| `app: zookeeper`. | ||
|
|
||
| Example PDB Using maxUnavailable: |
There was a problem hiding this comment.
This example is using 'minAvailable', not 'maxUnavailable'
|
|
||
| The non-zero value for `ALLOWED-DISRUPTIONS` means that the disruption controller | ||
| has seen the PDB and counted the matching PDB, and updated the status | ||
| of the PDB. |
There was a problem hiding this comment.
this is confusing ... maybe you mean ... the disruption controller has seen the pods, and counted the matching pods, and update the status of the PDB.
| - only `.spec.minAvailable` can be used, not `.spec.maxUnavailable`. | ||
| - only an integer value can be used with `.spec.minAvailable`, not a percentage. | ||
|
|
||
| You can use a selector which selects a subset or superset of the pods beloning to a built-in |
Merged
dchen1107
pushed a commit
that referenced
this pull request
Jun 30, 2017
* Minor fixes in the Deployment doc Signed-off-by: Michail Kargakis <mkargaki@redhat.com> * add NodeRestriction to admission-controllers (#3842) * Admins Can Configure Zones in Storage Class The PR #38505 (kubernetes/kubernetes#38505) added zones optional parameter to Storage Class for AWS and GCE provisioners. That's why documentation needs to be updated accordingly. * document custom resource definitions * add host paths to psp (#3971) * add host paths to psp * add italics * Update ConfigMap doc to explain TTL-based cache updates (#3989) * Update ConfigMap doc to explain TTL-based cache updates * swap word order Change "When a ConfigMap being already consumed..." to "When a ConfigMap already being consumed..." * Update NetworkPolicy docs for v1 * StorageOS Volume plugin * Update GPU docs * docs: HPA autoscaling/v2alpha1 status conditions This commit documents the new status conditions feature for HPA autoscaling/v2alpha1. It demonstrates how to get the status conditions using `kubectl describe`, and how to interpret them. * Update description about NodeRestriction kubelet node can alse create mirror pods for their own static pods. * adding storage as a supported resource to node allocatable Signed-off-by: Vishnu kannan <vishnuk@google.com> * Add documentation for podpreset opt-out annotation This adds the annotation for having the podpreset admission controller to skip (opt-out) manipulating the pod spec. Also, the annotation format for what presets have acted on a pod has been modified to add a prefix of "podpreset-". The new naming makes it such that there is no chance of collision with the newly introduced opt-out annotation (or future ones yet to be added). Opt-out annotation PR: kubernetes/kubernetes#44965 * Update PDB documentation to explain new field (#3885) * update-docs-pdb * Addressed erictune@'s comments * Fix title and add a TOC to the logging concept page * Patch #4118 for typos * Describe setting coredns server in nameserver resolv chain * Address comments in PR #3997. Comment is in https://github.com/kubernetes/kubernetes.github.io/pull/3997/files/f6eb59c67e28efc298c87b1ef49a96bc6adacd1e#diff-7a14981f3dd8eb203f897ce6c11d9828 * Update task for DaemonSet history and rollback (#4098) * Update task for DaemonSet history and rollback Also remove mentions of templateGeneration field because it's deprecated * Address comments * removed lt and gt as operators (#4152) * removed lt and gt as operators * replace lt and gt for node-affinfity * updated based on bsalamat review * Initial draft of upgrade guide for kubeadm clusters. In-place upgrades are supported between 1.6 and 1.7 releases. Rollback instructions to come in a separate commit. Fixes kubernetes/kubeadm#278 * Add local volume documentation (#4050) * Add local volume documentation * Add PV local volume example * Patch PR #3999 * Add documentation for Stackdriver event exporter * Add documentation about controller metrics * Federation: Add task for setting up placement policies (#4075) * Add task for setting up placement policies * Update version of management sidecar in policy engine deployment * Address @nikhiljindal's comments - Lower case filenames - Comments in policy - Typo fixes - Removed type LoadBalancer from OPA Service * Add example that sets cluster selector Per-@nikhiljindal's suggestion * Fix wording and templating per @chenopis * PodDisruptionBudget documentation Improvements (#4140) * Changes from #3885 Title: Update PDB documentation to explain new field Author: foxish * Added Placeholder Disruptions Concept Guide New file: docs/concepts/workloads/pods/disruptions.md Intented contents: concept for Pod Disruption Budget, cross reference to Eviction and Preemption docs. Linked from: concepts > workloads > pods * Added placeholder Configuring PDB Task New file: docs/tasks/run-application/configure-pdb.md Intented contents: task for writing a Pod Disruption Budget. Linked from: tasks > configuring-applications > configure pdb. * Add refs to the "drain a node" task. * Refactor PDB docs. Move the "Requesting an eviction" section from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md -- which is going away -- to: docs/tasks/administer-cluster/safely-drain-node.md The move is verbatim, except for an introductory sentence. Also added assignees. * Refactor of PDB docs Moved the section: Specifying a PodDisruptionBudget from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md to: docs/tasks/run-application/configure-pdb.md because that former file is going away. Move is verbatim. * Explain how Eviction tools should handle failures * Refactor PDB docs Move text from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md to: docs/concepts/workloads/pods/disruptions.md Delete the now empty: docs/tasks/administer-cluster/configure-pod-disruption-budget.md Added a redirects_from section to the new doc, containing the path of the now-deleted doc, plus all the redirects from the deleted doc. * Expand PDB Concept guide Building on a little content from the old task, greatly expanded the Disruptions concept guide, including an abstract example. * Update creating a pdb Task. * Address review comments. * Fixed for all cody-clark's review comments * Address review comments from mml * Address review comments from maisem * Fix missing backtick * Api and Kubectl reference docs updates for 1.7 (#4193) * Fix includes groups * Generated kubectl docs for 1.7 * Generated references docs for 1.7 api * Document node authorization mode * API Aggregator (#4173) * API Aggregator * Additional bullet points * incorporated feedback for apiserver-aggregation.md * split setup-api-aggregator.md into two docs and address feedback * fix link * addressed docs feedback * incorporate feedback * integrate feedback * Add documentation for DNS stub domains (#4063) * Add documentation for DNS stub domains * add additional prereq * fix image path * review feedback * minor grammar and style nits * documentation for using hostAliases to manage hosts file (#4080) * documentation for using hostAliases to manage hosts file * add to table of contents * review comments * update the right command to see hosts file * reformat doc based on suggestion and change some wording * Fix typo for #4080 * Patch PR #4063 * Fix wording in placement policy task introduction * Add update to statefulset concepts and basic tutorial (#4174) * Add update to statefulset concpets and basic tutorial * Address tech comments. * Update ESIPP docs for new added API fields * Custom resource docs * update audit document with advanced audit features added in 1.7 * kubeadm v1.7 documentation updates (#4018) * v1.7 updates for kubeadm * Address review comments * Address Luke's comments * Encrypting secrets at rest and cluster security guide * Edits for Custom DNS Documentation (#4207) * reorganize custom dns doc * format fixes * Update version numbers to 1.7 * Patch PR #4140 (#4215) * Patch PR #4140 * fix link and typos * Update PR template * Update TLS bootstrapping with 1.7 features This includes documenting the new CSR approver built into the controller manager and the kubelet alpha features for certificate rotation. Since the CSR approver changed over the 1.7 release cycle we need to call out the migration steps for those using the alpha feature. This document as a whole could probably use some updates, but the main focus of this PR is just to get these features minimally documented before the release. * Federated ClusterSelector formatting updates from review * complete PR #4181 (#4223) * complete PR #4181 * fix security link * Extensible admission controller (#4092) * extensible-admission-controllers * Update extensible-admission-controllers.md * more on initializers * fixes * Expand external admission webhooks documentation * wrap at 80 chars * more * add reference * Use correct apigroup for network policy * Docs changes to PR #4092 (#4224) * Docs changes to PR #4092 * address feedback * add doc for --as-group in cli Add doc for this pr: kubernetes/kubernetes#43696
jesscodez
pushed a commit
that referenced
this pull request
Sep 22, 2017
* Changes from #3885 Title: Update PDB documentation to explain new field Author: foxish * Added Placeholder Disruptions Concept Guide New file: docs/concepts/workloads/pods/disruptions.md Intented contents: concept for Pod Disruption Budget, cross reference to Eviction and Preemption docs. Linked from: concepts > workloads > pods * Added placeholder Configuring PDB Task New file: docs/tasks/run-application/configure-pdb.md Intented contents: task for writing a Pod Disruption Budget. Linked from: tasks > configuring-applications > configure pdb. * Add refs to the "drain a node" task. * Refactor PDB docs. Move the "Requesting an eviction" section from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md -- which is going away -- to: docs/tasks/administer-cluster/safely-drain-node.md The move is verbatim, except for an introductory sentence. Also added assignees. * Refactor of PDB docs Moved the section: Specifying a PodDisruptionBudget from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md to: docs/tasks/run-application/configure-pdb.md because that former file is going away. Move is verbatim. * Explain how Eviction tools should handle failures * Refactor PDB docs Move text from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md to: docs/concepts/workloads/pods/disruptions.md Delete the now empty: docs/tasks/administer-cluster/configure-pod-disruption-budget.md Added a redirects_from section to the new doc, containing the path of the now-deleted doc, plus all the redirects from the deleted doc. * Expand PDB Concept guide Building on a little content from the old task, greatly expanded the Disruptions concept guide, including an abstract example. * Update creating a pdb Task. * Address review comments. * Fixed for all cody-clark's review comments * Address review comments from mml * Address review comments from maisem * Fix missing backtick
jesscodez
pushed a commit
that referenced
this pull request
Sep 22, 2017
* Minor fixes in the Deployment doc Signed-off-by: Michail Kargakis <mkargaki@redhat.com> * add NodeRestriction to admission-controllers (#3842) * Admins Can Configure Zones in Storage Class The PR #38505 (kubernetes/kubernetes#38505) added zones optional parameter to Storage Class for AWS and GCE provisioners. That's why documentation needs to be updated accordingly. * document custom resource definitions * add host paths to psp (#3971) * add host paths to psp * add italics * Update ConfigMap doc to explain TTL-based cache updates (#3989) * Update ConfigMap doc to explain TTL-based cache updates * swap word order Change "When a ConfigMap being already consumed..." to "When a ConfigMap already being consumed..." * Update NetworkPolicy docs for v1 * StorageOS Volume plugin * Update GPU docs * docs: HPA autoscaling/v2alpha1 status conditions This commit documents the new status conditions feature for HPA autoscaling/v2alpha1. It demonstrates how to get the status conditions using `kubectl describe`, and how to interpret them. * Update description about NodeRestriction kubelet node can alse create mirror pods for their own static pods. * adding storage as a supported resource to node allocatable Signed-off-by: Vishnu kannan <vishnuk@google.com> * Add documentation for podpreset opt-out annotation This adds the annotation for having the podpreset admission controller to skip (opt-out) manipulating the pod spec. Also, the annotation format for what presets have acted on a pod has been modified to add a prefix of "podpreset-". The new naming makes it such that there is no chance of collision with the newly introduced opt-out annotation (or future ones yet to be added). Opt-out annotation PR: kubernetes/kubernetes#44965 * Update PDB documentation to explain new field (#3885) * update-docs-pdb * Addressed erictune@'s comments * Fix title and add a TOC to the logging concept page * Patch #4118 for typos * Describe setting coredns server in nameserver resolv chain * Address comments in PR #3997. Comment is in https://github.com/kubernetes/kubernetes.github.io/pull/3997/files/f6eb59c67e28efc298c87b1ef49a96bc6adacd1e#diff-7a14981f3dd8eb203f897ce6c11d9828 * Update task for DaemonSet history and rollback (#4098) * Update task for DaemonSet history and rollback Also remove mentions of templateGeneration field because it's deprecated * Address comments * removed lt and gt as operators (#4152) * removed lt and gt as operators * replace lt and gt for node-affinfity * updated based on bsalamat review * Initial draft of upgrade guide for kubeadm clusters. In-place upgrades are supported between 1.6 and 1.7 releases. Rollback instructions to come in a separate commit. Fixes kubernetes/kubeadm#278 * Add local volume documentation (#4050) * Add local volume documentation * Add PV local volume example * Patch PR #3999 * Add documentation for Stackdriver event exporter * Add documentation about controller metrics * Federation: Add task for setting up placement policies (#4075) * Add task for setting up placement policies * Update version of management sidecar in policy engine deployment * Address @nikhiljindal's comments - Lower case filenames - Comments in policy - Typo fixes - Removed type LoadBalancer from OPA Service * Add example that sets cluster selector Per-@nikhiljindal's suggestion * Fix wording and templating per @chenopis * PodDisruptionBudget documentation Improvements (#4140) * Changes from #3885 Title: Update PDB documentation to explain new field Author: foxish * Added Placeholder Disruptions Concept Guide New file: docs/concepts/workloads/pods/disruptions.md Intented contents: concept for Pod Disruption Budget, cross reference to Eviction and Preemption docs. Linked from: concepts > workloads > pods * Added placeholder Configuring PDB Task New file: docs/tasks/run-application/configure-pdb.md Intented contents: task for writing a Pod Disruption Budget. Linked from: tasks > configuring-applications > configure pdb. * Add refs to the "drain a node" task. * Refactor PDB docs. Move the "Requesting an eviction" section from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md -- which is going away -- to: docs/tasks/administer-cluster/safely-drain-node.md The move is verbatim, except for an introductory sentence. Also added assignees. * Refactor of PDB docs Moved the section: Specifying a PodDisruptionBudget from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md to: docs/tasks/run-application/configure-pdb.md because that former file is going away. Move is verbatim. * Explain how Eviction tools should handle failures * Refactor PDB docs Move text from: docs/tasks/administer-cluster/configure-pod-disruption-budget.md to: docs/concepts/workloads/pods/disruptions.md Delete the now empty: docs/tasks/administer-cluster/configure-pod-disruption-budget.md Added a redirects_from section to the new doc, containing the path of the now-deleted doc, plus all the redirects from the deleted doc. * Expand PDB Concept guide Building on a little content from the old task, greatly expanded the Disruptions concept guide, including an abstract example. * Update creating a pdb Task. * Address review comments. * Fixed for all cody-clark's review comments * Address review comments from mml * Address review comments from maisem * Fix missing backtick * Api and Kubectl reference docs updates for 1.7 (#4193) * Fix includes groups * Generated kubectl docs for 1.7 * Generated references docs for 1.7 api * Document node authorization mode * API Aggregator (#4173) * API Aggregator * Additional bullet points * incorporated feedback for apiserver-aggregation.md * split setup-api-aggregator.md into two docs and address feedback * fix link * addressed docs feedback * incorporate feedback * integrate feedback * Add documentation for DNS stub domains (#4063) * Add documentation for DNS stub domains * add additional prereq * fix image path * review feedback * minor grammar and style nits * documentation for using hostAliases to manage hosts file (#4080) * documentation for using hostAliases to manage hosts file * add to table of contents * review comments * update the right command to see hosts file * reformat doc based on suggestion and change some wording * Fix typo for #4080 * Patch PR #4063 * Fix wording in placement policy task introduction * Add update to statefulset concepts and basic tutorial (#4174) * Add update to statefulset concpets and basic tutorial * Address tech comments. * Update ESIPP docs for new added API fields * Custom resource docs * update audit document with advanced audit features added in 1.7 * kubeadm v1.7 documentation updates (#4018) * v1.7 updates for kubeadm * Address review comments * Address Luke's comments * Encrypting secrets at rest and cluster security guide * Edits for Custom DNS Documentation (#4207) * reorganize custom dns doc * format fixes * Update version numbers to 1.7 * Patch PR #4140 (#4215) * Patch PR #4140 * fix link and typos * Update PR template * Update TLS bootstrapping with 1.7 features This includes documenting the new CSR approver built into the controller manager and the kubelet alpha features for certificate rotation. Since the CSR approver changed over the 1.7 release cycle we need to call out the migration steps for those using the alpha feature. This document as a whole could probably use some updates, but the main focus of this PR is just to get these features minimally documented before the release. * Federated ClusterSelector formatting updates from review * complete PR #4181 (#4223) * complete PR #4181 * fix security link * Extensible admission controller (#4092) * extensible-admission-controllers * Update extensible-admission-controllers.md * more on initializers * fixes * Expand external admission webhooks documentation * wrap at 80 chars * more * add reference * Use correct apigroup for network policy * Docs changes to PR #4092 (#4224) * Docs changes to PR #4092 * address feedback * add doc for --as-group in cli Add doc for this pr: kubernetes/kubernetes#43696
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.
Improved PDB documentation.
Removes old
docs/tasks/administer-cluster/configure-pod-disruption-budget.md.Replaces with a Concept Guide and a new Task, and improvements to an existing task.
This change is