website/docs/api-reference/v1.5/documents/_generated_poddisruptionbudget_v1beta1_concept.md

---

PodDisruptionBudget v1beta1

Group	Version	Kind
Policy	v1beta1	PodDisruptionBudget

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

Appears In PodDisruptionBudgetList

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta
spec PodDisruptionBudgetSpec	Specification of the desired behavior of the PodDisruptionBudget.
status PodDisruptionBudgetStatus	Most recently observed status of the PodDisruptionBudget.

PodDisruptionBudgetSpec v1beta1

Appears In PodDisruptionBudget

Field	Description
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%".
selector LabelSelector	Label query over pods whose evictions are managed by the disruption budget.

PodDisruptionBudgetStatus v1beta1

Appears In PodDisruptionBudget

Field	Description
currentHealthy integer	current number of healthy pods
desiredHealthy integer	minimum desired number of healthy pods
disruptedPods object	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.
disruptionsAllowed integer	Number of pod disruptions that are currently allowed.
expectedPods integer	total number of pods counted by this disruption budget
observedGeneration integer	Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation.

PodDisruptionBudgetList v1beta1

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items PodDisruptionBudget array
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta

Write Operations

See supported operations below...

Create

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

create a PodDisruptionBudget

HTTP Request

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

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body PodDisruptionBudget

Response

Code	Description
200 PodDisruptionBudget	OK

Replace

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

replace the specified PodDisruptionBudget

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the PodDisruptionBudget
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body PodDisruptionBudget

Response

Code	Description
200 PodDisruptionBudget	OK

Patch

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

partially update the specified PodDisruptionBudget

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the PodDisruptionBudget
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body Patch

Response

Code	Description
200 PodDisruptionBudget	OK

Delete

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

delete a PodDisruptionBudget

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the PodDisruptionBudget
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.

Body Parameters

Parameter	Description
body DeleteOptions

Response

Code	Description
200 Status	OK

Delete Collection

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

delete collection of PodDisruptionBudget

HTTP Request

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

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Status	OK

Read Operations

See supported operations below...

Read

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

read the specified PodDisruptionBudget

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the PodDisruptionBudget
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
export	Should this value be exported. Export strips fields that a user can not specify.

Response

Code	Description
200 PodDisruptionBudget	OK

List

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

list or watch objects of kind PodDisruptionBudget

HTTP Request

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

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 PodDisruptionBudgetList	OK

List All Namespaces

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

list or watch objects of kind PodDisruptionBudget

HTTP Request

GET /apis/policy/v1beta1/poddisruptionbudgets

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 PodDisruptionBudgetList	OK

Watch

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

watch changes to an object of kind PodDisruptionBudget

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the PodDisruptionBudget
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Event	OK

Watch List All Namespaces

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

watch individual changes to a list of PodDisruptionBudget

HTTP Request

GET /apis/policy/v1beta1/watch/poddisruptionbudgets

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Event	OK