Update eck pdb docs #2361
Open
Update eck pdb docs #2361
Conversation
This file contains hidden or 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
Signed-off-by: Michael Montgomery <[email protected]>
Signed-off-by: Michael Montgomery <[email protected]>
🔍 Preview links for changed docs |
shainaraskas
reviewed
Aug 1, 2025
| @@ -12,7 +12,28 @@ products: | |||
|
|
|||
| A [Pod Disruption Budget](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) (PDB) allows you to limit the disruption to your application when its pods need to be rescheduled for some reason such as upgrades or routine maintenance work on the Kubernetes nodes. | |||
|
|
|||
| ECK manages a default PDB per {{es}} resource. It allows one {{es}} Pod to be taken down, as long as the cluster has a `green` health. Single-node clusters are not considered highly available and can always be disrupted. | |||
| ECK manages either a single default PDB, or multiple PDBs per {{es}} resource according to the license available. | |||
There was a problem hiding this comment.
Does the user have to be on a stack 9.2 cluster as well as use ECK 3.2?
Consider this approach. More tagging / clarification might be necessary if the stack version is also a factor.
We have a couple of other ways we could do this with heading tagging or tabs, but this is probably a nice lightweight way to do it
Suggested change
| ECK manages either a single default PDB, or multiple PDBs per {{es}} resource according to the license available. | |
| ECK manages either a single default PDB, or multiple PDBs per {{es}} resource according to the license available. | |
| :::{note} | |
| In ECK 3.1 and earlier, all clusters follow the [non-enterprise behavior](#non-enterprise-licensed-customers), regardless of license type. | |
| ::: |
| ECK manages a default PDB per {{es}} resource. It allows one {{es}} Pod to be taken down, as long as the cluster has a `green` health. Single-node clusters are not considered highly available and can always be disrupted. | ||
| ECK manages either a single default PDB, or multiple PDBs per {{es}} resource according to the license available. | ||
|
|
||
| ## Enterprise licensed customers |
There was a problem hiding this comment.
Suggested change
| ## Enterprise licensed customers | |
| ## Enterprise licensed customers | |
| ```{applies_to} | |
| deployment: | |
| eck: ga 3.2 | |
| ``` |
|
|
||
| Single-node clusters are not considered highly available and can always be disrupted. | ||
|
|
||
| ## Non-enterprise licensed customers |
There was a problem hiding this comment.
Suggested change
| ## Non-enterprise licensed customers | |
| ## Non-enterprise licensed customers | |
| :::{note} | |
| In ECK 3.1 and earlier, all clusters follow this behavior regardless of license type. | |
| ::: |
|
|
||
| A separate PDB is created for each type of nodeSet defined in the manifest allowing upgrade or maintenance operations to be more quickly executed. The PDBs allow one {{es}} Pod per nodeSet to simultaneously be taken down as long as the cluster has the health defined in the following table: | ||
|
|
||
| | Role | Cluster Health Required | Notes | |
There was a problem hiding this comment.
Suggested change
| | Role | Cluster Health Required | Notes | | |
| | Role | Cluster health required | Notes | |
| | ML | Yellow | | | ||
| | Coordinating | Yellow | | | ||
| | Transform | Yellow | | | ||
| | Remote Cluster Client | Yellow | | |
There was a problem hiding this comment.
Suggested change
| | Remote Cluster Client | Yellow | | | |
| | Remote cluster client | Yellow | | |
|
|
||
| ## Non-enterprise licensed customers | ||
|
|
||
| It allows one {{es}} Pod to be taken down, as long as the cluster has a `green` health. Single-node clusters are not considered highly available and can always be disrupted. | ||
|
|
||
| In the {{es}} specification, you can change the default behavior as follows: |
There was a problem hiding this comment.
do the instructions below this line only apply to non-enterprise? if not, you might want to change the headings a little:
## Default behavior
...
### Enterprise licensed customers
...
### Non-enterprise licensed customers
...
## Override the default behavior
...
## Pod disruption budget ...
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.
The following elastic/cloud-on-k8s#8780 is planned to be released with the ECK 3.2/Stack 9.2 release. How do we tag this specifically for that?