Kubernetes Reference
PodDisruptionBudget v1beta1

PodDisruptionBudget v1beta1

PodDisruptionBudget

apiVersion: policy/v1beta1
import "k8s.io/api/policy/v1beta1"

PodDisruptionBudget

PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

PodDisruptionBudgetSpec

PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.

  • maxUnavailable (IntOrString)
    An eviction is allowed if at most “maxUnavailable” pods selected by “selector” are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with “minAvailable”.
    IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.
  • minAvailable (IntOrString)
    An eviction is allowed if at least “minAvailable” pods selected by “selector” will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying “100%!"(MISSING).
    IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.
  • selector (LabelSelector)
    Label query over pods whose evictions are managed by the disruption budget.

PodDisruptionBudgetStatus

PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.

  • currentHealthy (int32), required
    current number of healthy pods
  • desiredHealthy (int32), required
    minimum desired number of healthy pods
  • disruptionsAllowed (int32), required
    Number of pod disruptions that are currently allowed.
  • expectedPods (int32), required
    total number of pods counted by this disruption budget
  • disruptedPods (map[string]Time)
    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.
    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
  • observedGeneration (int64)
    Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB’s object generation.

PodDisruptionBudgetList

PodDisruptionBudgetList is a collection of PodDisruptionBudgets.

Operations

get read the specified PodDisruptionBudget

HTTP Request

GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}

Parameters
  • {name} (string), required
    name of the PodDisruptionBudget
  • {namespace} (string), required
    namespace
  • ?pretty (string)
    pretty
Response

200 (PodDisruptionBudget): OK
401: Unauthorized

get read status of the specified PodDisruptionBudget

HTTP Request

GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status

Parameters
  • {name} (string), required
    name of the PodDisruptionBudget
  • {namespace} (string), required
    namespace
  • ?pretty (string)
    pretty
Response

200 (PodDisruptionBudget): OK
401: Unauthorized

list list or watch objects of kind PodDisruptionBudget

HTTP Request

GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets

Parameters
Response

200 (PodDisruptionBudgetList): OK
401: Unauthorized

list list or watch objects of kind PodDisruptionBudget

HTTP Request

GET /apis/policy/v1beta1/poddisruptionbudgets

Parameters
Response

200 (PodDisruptionBudgetList): OK
401: Unauthorized

create create a PodDisruptionBudget

HTTP Request

POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets

Parameters
Response

200 (PodDisruptionBudget): OK
201 (PodDisruptionBudget): Created
202 (PodDisruptionBudget): Accepted
401: Unauthorized

update replace the specified PodDisruptionBudget

HTTP Request

PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}

Parameters
Response

200 (PodDisruptionBudget): OK
201 (PodDisruptionBudget): Created
401: Unauthorized

update replace status of the specified PodDisruptionBudget

HTTP Request

PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status

Parameters
Response

200 (PodDisruptionBudget): OK
201 (PodDisruptionBudget): Created
401: Unauthorized

patch partially update the specified PodDisruptionBudget

HTTP Request

PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}

Parameters

  • {name} (string), required
    name of the PodDisruptionBudget

  • {namespace} (string), required
    namespace

  • body (Patch), required

  • ?dryRun (string)
    dryRun

  • ?fieldManager (string)
    fieldManager

  • ?force (boolean)
    force

  • ?pretty (string)
    pretty

Response

200 (PodDisruptionBudget): OK
401: Unauthorized

patch partially update status of the specified PodDisruptionBudget

HTTP Request

PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status

Parameters

  • {name} (string), required
    name of the PodDisruptionBudget

  • {namespace} (string), required
    namespace

  • body (Patch), required

  • ?dryRun (string)
    dryRun

  • ?fieldManager (string)
    fieldManager

  • ?force (boolean)
    force

  • ?pretty (string)
    pretty

Response

200 (PodDisruptionBudget): OK
401: Unauthorized

delete delete a PodDisruptionBudget

HTTP Request

DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}

Parameters
Response

200 (Status): OK
202 (Status): Accepted
401: Unauthorized

deletecollection delete collection of PodDisruptionBudget

HTTP Request

DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets

Parameters
Response

200 (Status): OK
401: Unauthorized

What's on this Page