PodDisruptionBudget [policy/v1]
- Description
- PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods
- Type
object
Specification
.spec
- Description
- PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
- Type
object
.spec.selector
- Description
- A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- Type
object
.spec.selector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.selector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.selector.matchExpressions[].values
- Description
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Type
array
.spec.selector.matchExpressions[].values[]
- Type
string
.spec.selector.matchLabels
- Description
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Type
object
.status
- Description
- PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.
- Type
object
.status.conditions
- Description
- Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute the number of allowed disruptions. Therefore no disruptions are allowed and the status of the condition will be False. - InsufficientPods: The number of pods are either at or below the number required by the PodDisruptionBudget. No disruptions are allowed and the status of the condition will be False. - SufficientPods: There are more pods than required by the PodDisruptionBudget. The condition will be True, and the number of allowed disruptions are provided by the disruptionsAllowed property.
- Type
array
.status.conditions[]
- Description
- Condition contains details for one aspect of the current state of this API Resource.
- Type
object- Required
typestatuslastTransitionTimereasonmessage
.status.disruptedPods
- Description
- DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
- Type
object
API Endpoints
The following API endpoints are available:
/kubernetes/{cluster}/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgetsDELETE: delete collection of PodDisruptionBudgetGET: list objects of kind PodDisruptionBudgetPOST: create a new PodDisruptionBudget
/kubernetes/{cluster}/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}DELETE: delete the specified PodDisruptionBudgetGET: read the specified PodDisruptionBudgetPATCH: partially update the specified PodDisruptionBudgetPUT: replace the specified PodDisruptionBudget
/kubernetes/{cluster}/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/statusGET: read status of the specified PodDisruptionBudgetPATCH: partially update status of the specified PodDisruptionBudgetPUT: replace status of the specified PodDisruptionBudget
/kubernetes/{cluster}/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
- HTTP method
DELETE- Description
- delete collection of PodDisruptionBudget
- HTTP responses
- HTTP method
GET- Description
- list objects of kind PodDisruptionBudget
- HTTP responses
- HTTP method
POST- Description
- create a new PodDisruptionBudget
- Query parameters
- Body parameters
- HTTP responses
/kubernetes/{cluster}/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
- HTTP method
DELETE- Description
- delete the specified PodDisruptionBudget
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified PodDisruptionBudget
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified PodDisruptionBudget
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified PodDisruptionBudget
- Query parameters
- Body parameters
- HTTP responses
/kubernetes/{cluster}/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
- HTTP method
GET- Description
- read status of the specified PodDisruptionBudget
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified PodDisruptionBudget
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified PodDisruptionBudget
- Query parameters
- Body parameters
- HTTP responses