Deployment [apps/v1] - apps | API reference

Specification
API endpoints

Description: Deployment enables declarative updates for Pods and ReplicaSets.
Type: object

Specification

Property Type Description

Property	Type	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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object metadata.
`.spec`	`object`	DeploymentSpec is the specification of the desired behavior of the Deployment.
`.status`	`object`	DeploymentStatus is the most recently observed status of the Deployment.

.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: https://git.k8s.io/community/contributors/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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object metadata.

.spec

object

DeploymentSpec is the specification of the desired behavior of the Deployment.

.status

object

DeploymentStatus is the most recently observed status of the Deployment.

.spec

Description

DeploymentSpec is the specification of the desired behavior of the Deployment.

Type

object

Required

selector
template

Property Type Description

Property	Type	Description
`minReadySeconds`	`integer`	Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
`paused`	`boolean`	Indicates that the deployment is paused.
`progressDeadlineSeconds`	`integer`	The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
`replicas`	`integer`	Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
`revisionHistoryLimit`	`integer`	The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
`selector`	`LabelSelector meta/v1`	Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template’s labels.
`strategy`	`object`	DeploymentStrategy describes how to replace existing pods with new ones.
`template`	`PodTemplateSpec core/v1`	Template describes the pods that will be created.

minReadySeconds

integer

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

paused

boolean

Indicates that the deployment is paused.

progressDeadlineSeconds

integer

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

replicas

integer

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

revisionHistoryLimit

integer

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

selector

LabelSelector meta/v1

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template’s labels.

strategy

object

DeploymentStrategy describes how to replace existing pods with new ones.

template

PodTemplateSpec core/v1

Template describes the pods that will be created.

.spec.strategy

Description: DeploymentStrategy describes how to replace existing pods with new ones.
Type: object

Property Type Description

Property	Type	Description
`rollingUpdate`	`object`	Spec to control the desired behavior of rolling update.
`type`	`string`	Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

rollingUpdate

object

Spec to control the desired behavior of rolling update.

type

string

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

.spec.strategy.rollingUpdate

Description: Spec to control the desired behavior of rolling update.
Type: object

Property Type Description

Property	Type	Description
`maxSurge`	`IntOrString util/intstr`	The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
`maxUnavailable`	`IntOrString util/intstr`	The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

maxSurge

IntOrString util/intstr

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

maxUnavailable

IntOrString util/intstr

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

.status

Description: DeploymentStatus is the most recently observed status of the Deployment.
Type: object

Property Type Description

Property	Type	Description
`availableReplicas`	`integer`	Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
`collisionCount`	`integer`	Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
`conditions`	`array`	Represents the latest available observations of a deployment’s current state.
`conditions[]`	`object`	DeploymentCondition describes the state of a deployment at a certain point.
`observedGeneration`	`integer`	The generation observed by the deployment controller.
`readyReplicas`	`integer`	Total number of ready pods targeted by this deployment.
`replicas`	`integer`	Total number of non-terminated pods targeted by this deployment (their labels match the selector).
`unavailableReplicas`	`integer`	Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
`updatedReplicas`	`integer`	Total number of non-terminated pods targeted by this deployment that have the desired template spec.

availableReplicas

integer

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

collisionCount

integer

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

conditions

array

Represents the latest available observations of a deployment’s current state.

conditions[]

object

DeploymentCondition describes the state of a deployment at a certain point.

observedGeneration

integer

The generation observed by the deployment controller.

readyReplicas

integer

Total number of ready pods targeted by this deployment.

replicas

integer

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

unavailableReplicas

integer

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

updatedReplicas

integer

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

.status.conditions

Description: Represents the latest available observations of a deployment’s current state.
Type: array

.status.conditions[]

Description

DeploymentCondition describes the state of a deployment at a certain point.

Type

object

Required

type
status

Property Type Description

Property	Type	Description
`lastTransitionTime`	`Time meta/v1`	Last time the condition transitioned from one status to another.
`lastUpdateTime`	`Time meta/v1`	The last time this condition was updated.
`message`	`string`	A human readable message indicating details about the transition.
`reason`	`string`	The reason for the condition’s last transition.
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of deployment condition.

lastTransitionTime

Time meta/v1

Last time the condition transitioned from one status to another.

lastUpdateTime

Time meta/v1

The last time this condition was updated.

message

string

A human readable message indicating details about the transition.

reason

string

The reason for the condition’s last transition.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of deployment condition.

API endpoints

The following API endpoints are available:

/apis/apps/v1/deployments
- GET: list or watch objects of kind Deployment
/apis/apps/v1/namespaces/{namespace}/deployments
- DELETE: delete collection of Deployment
- GET: list or watch objects of kind Deployment
- POST: create a Deployment
/apis/apps/v1/namespaces/{namespace}/deployments/{name}
- DELETE: delete a Deployment
- GET: read the specified Deployment
- PATCH: partially update the specified Deployment
- PUT: replace the specified Deployment
/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
- GET: read scale of the specified Deployment
- PATCH: partially update scale of the specified Deployment
- PUT: replace scale of the specified Deployment
/apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
- GET: read status of the specified Deployment
- PATCH: partially update status of the specified Deployment
- PUT: replace status of the specified Deployment

/apis/apps/v1/deployments

Table 1. Global guery parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`pretty`	`string`	If 'true', then the output is pretty printed.
`resourceVersion`	`string`	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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

HTTP method: GET
Description: list or watch objects of kind Deployment

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`DeploymentList apps/v1`
401 - Unauthorized	Empty

/apis/apps/v1/namespaces/{namespace}/deployments

Table 3. Global path parameters
Parameter	Type	Description
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 4. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of Deployment

Table 5. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind Deployment

Table 7. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`DeploymentList apps/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a Deployment

Table 9. Body parameters
Parameter	Type	Description
`body`	`Deployment apps/v1`

Table 10. HTTP responses
HTTP code	Reponse body
200 - OK	`Deployment apps/v1`
201 - Created	`Deployment apps/v1`
202 - Accepted	`Deployment apps/v1`
401 - Unauthorized	Empty

/apis/apps/v1/namespaces/{namespace}/deployments/{name}

Table 11. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Deployment
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 12. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a Deployment

Table 13. Query parameters
Parameter	Type	Description
`gracePeriodSeconds`	`integer`	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`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 14. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified Deployment

Table 16. Query parameters
Parameter	Type	Description
`exact`	`boolean`	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
`export`	`boolean`	Should this value be exported. Export strips fields that a user can not specify.

Table 17. HTTP responses
HTTP code	Reponse body
200 - OK	`Deployment apps/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified Deployment

Table 18. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 19. HTTP responses
HTTP code	Reponse body
200 - OK	`Deployment apps/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified Deployment

Table 20. Body parameters
Parameter	Type	Description
`body`	`Deployment apps/v1`

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`Deployment apps/v1`
201 - Created	`Deployment apps/v1`
401 - Unauthorized	Empty

/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale

Table 22. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Scale
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 23. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read scale of the specified Deployment

Table 24. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale autoscaling/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update scale of the specified Deployment

Table 25. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 26. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale autoscaling/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace scale of the specified Deployment

Table 27. Body parameters
Parameter	Type	Description
`body`	`Scale autoscaling/v1`

Table 28. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale autoscaling/v1`
201 - Created	`Scale autoscaling/v1`
401 - Unauthorized	Empty

/apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

Table 29. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Deployment
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 30. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read status of the specified Deployment

Table 31. HTTP responses
HTTP code	Reponse body
200 - OK	`Deployment apps/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified Deployment

Table 32. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 33. HTTP responses
HTTP code	Reponse body
200 - OK	`Deployment apps/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified Deployment

Table 34. Body parameters
Parameter	Type	Description
`body`	`Deployment apps/v1`

Table 35. HTTP responses
HTTP code	Reponse body
200 - OK	`Deployment apps/v1`
201 - Created	`Deployment apps/v1`
401 - Unauthorized	Empty