Skip to content

docs: Update SafeRollout concept doc based on new availability trackers #1088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
britaniar merged 3 commits into from
Mar 20, 2025
Merged

docs: Update SafeRollout concept doc based on new availability trackers #1088

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b463833
Update doc based on availability tracker
britaniar Mar 18, 2025
fcb4460
address comments
britaniar Mar 18, 2025
1b96abc
fix nit and remove service export
britaniar Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions docs/concepts/SafeRollout/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ mandates at least one cluster to be available.

`UnavailablePeriodSeconds` is used to configure the waiting time between rollout phases when we cannot determine if the
resources have rolled out successfully or not. This field is used only if the availability of resources we propagate
are not trackable. Refer to the [Data only object](#data-only-objects) section for more details.
are not trackable. Refer to the [Availability based Rollout](#availability-based-rollout) section for more details on a list of resources we can track.

## Availability based Rollout
We have built-in mechanisms to determine the availability of some common Kubernetes native resources. We only mark them
Expand All @@ -195,9 +195,22 @@ For `Service` based on the service type the availability is determined as follow
- For `ExternalName` service, checking availability is not supported, so it will be marked as available with a "not trackable" reason.


#### Custom Resource Definition
Comment thread
jwtty marked this conversation as resolved.
For `CustomResourceDefinition` availability is determined as follows:
- We mark as available when `Established` condition is set to true and `NamesAccepted` condition is set to true.


### Pod Disruption Budget
For `PodDisruptionBudget` based on the `DisruptionsAllowed` field the availability is determined as follows:
- For `DisruptionsAllowed` > 0 , we mark it as available when condition `DisruptionAllowed` is set to true and the reason
is `SufficientPods`.
- Otherwise, we mark it as available when condition `DisruptionAllowed` is set to false and the reason
is `InsufficientPodsReason`.


#### Data only objects

For the objects described below since they are a data resource we mark them as available immediately after creation,
For the objects described below since they are a data resource we mark them as available immediately after creation:

- Namespace
- Secret
Expand All @@ -206,3 +219,13 @@ For the objects described below since they are a data resource we mark them as a
- ClusterRole
- RoleBinding
- ClusterRoleBinding
- NetworkPolicy
- CSIDriver
- CSINode
- StorageClass
- CSIStorageCapacity
- ControllerRevision
- IngressClass
- LimitRange
- ResourceQuota
- PriorityClass