This is a cache of https://docs.okd.io/4.8/rest_api/workloads_apis/deploymentconfig-apps-openshift-io-v1.html. It is a snapshot of the page at 2024-11-22T01:11:14.407+0000.
<strong>deployment</strong>Config [apps.openshift.io/v1] - Workloads APIs | API reference | OKD 4.8
  1. Documentation
×

deploymentConfig [apps.openshift.io/v1]

Description

deployment Configs define the template for a pod and manages deploying new images or configuration changes. A single deployment configuration is usually analogous to a single micro-service. Can support many different deployment patterns, including full restart, customizable rolling updates, and fully custom behaviors, as well as pre- and post- deployment hooks. Each individual deployment is represented as a replication controller.

A deployment is "triggered" when its configuration is changed or a tag in an Image Stream is changed. Triggers can be disabled to allow manual control over a deployment. The "strategy" determines how the deployment is carried out and may be changed at any time. The latestVersion field is updated when a new deployment is triggered by any means.

Type

object

Required

  • spec

Specification

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta meta/v1

spec

object

deploymentConfigSpec represents the desired state of the deployment.

status

object

deploymentConfigStatus represents the current deployment state.
.spec
Description

deploymentConfigSpec represents the desired state of the deployment.

Type

object

Property Type Description

minReadySeconds

integer

MinReadySeconds is the 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

Paused indicates that the deployment config is paused resulting in no new deployments on template changes or changes in the template caused by other triggers.

replicas

integer

Replicas is the number of desired replicas.

revisionHistoryLimit

integer

RevisionHistoryLimit is the number of old ReplicationControllers to retain to allow for rollbacks. This field is a pointer to allow for differentiation between an explicit zero and not specified. Defaults to 10. (This only applies to deploymentConfigs created via the new group API resource, not the legacy resource.)

selector

object (string)

Selector is a label query over pods that should match the Replicas count.

strategy

object

deploymentStrategy describes how to perform a deployment.

template

PodTemplateSpec core/v1

Template is the object that describes the pod that will be created if insufficient replicas are detected.

test

boolean

Test ensures that this deployment config will have zero replicas except while a deployment is running. This allows the deployment config to be used as a continuous deployment test - triggering on images, running the deployment, and then succeeding or failing. Post strategy hooks and After actions can be used to integrate successful deployment with an action.

triggers

array

Triggers determine how updates to a deploymentConfig result in new deployments. If no triggers are defined, a new deployment can only occur as a result of an explicit client update to the deploymentConfig with a new LatestVersion. If null, defaults to having a config change trigger.

triggers[]

object

deploymentTriggerPolicy describes a policy for a single trigger that results in a new deployment.
.spec.strategy
Description

deploymentStrategy describes how to perform a deployment.

Type

object

Property Type Description

activeDeadlineSeconds

integer

ActiveDeadlineSeconds is the duration in seconds that the deployer pods for this deployment config may be active on a node before the system actively tries to terminate them.

annotations

object (string)

Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.

customParams

object

CustomdeploymentStrategyParams are the input to the Custom deployment strategy.

labels

object (string)

Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.

recreateParams

object

RecreatedeploymentStrategyParams are the input to the Recreate deployment strategy.

resources

ResourceRequirements core/v1

Resources contains resource requirements to execute the deployment and any hooks.

rollingParams

object

RollingdeploymentStrategyParams are the input to the Rolling deployment strategy.

type

string

Type is the name of a deployment strategy.
.spec.strategy.customParams
Description

CustomdeploymentStrategyParams are the input to the Custom deployment strategy.

Type

object

Property Type Description

command

array (string)

Command is optional and overrides CMD in the container Image.

environment

array (EnvVar core/v1)

Environment holds the environment which will be given to the container for Image.

image

string

Image specifies a container image which can carry out a deployment.
.spec.strategy.recreateParams
Description

RecreatedeploymentStrategyParams are the input to the Recreate deployment strategy.

Type

object

Property Type Description

mid

object

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

post

object

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

pre

object

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

timeoutSeconds

integer

TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.
.spec.strategy.recreateParams.mid
Description

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

Type

object

Required

  • failurePolicy

Property Type Description

execNewPod

object

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

failurePolicy

string

FailurePolicy specifies what action to take if the hook fails.

tagImages

array

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

tagImages[]

object

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.
.spec.strategy.recreateParams.mid.execNewPod
Description

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

Type

object

Required

  • command

  • containerName

Property Type Description

command

array (string)

Command is the action command and its arguments.

containerName

string

ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod’s container.

env

array (EnvVar core/v1)

Env is a set of environment variables to supply to the hook pod’s container.

volumes

array (string)

Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied.
.spec.strategy.recreateParams.mid.tagImages
Description

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

Type

array

.spec.strategy.recreateParams.mid.tagImages[]
Description

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.

Type

object

Required

  • containerName

  • to

Property Type Description

containerName

string

ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container.

to

ObjectReference core/v1

To is the target ImageStreamTag to set the container’s image onto.
.spec.strategy.recreateParams.post
Description

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

Type

object

Required

  • failurePolicy

Property Type Description

execNewPod

object

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

failurePolicy

string

FailurePolicy specifies what action to take if the hook fails.

tagImages

array

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

tagImages[]

object

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.
.spec.strategy.recreateParams.post.execNewPod
Description

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

Type

object

Required

  • command

  • containerName

Property Type Description

command

array (string)

Command is the action command and its arguments.

containerName

string

ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod’s container.

env

array (EnvVar core/v1)

Env is a set of environment variables to supply to the hook pod’s container.

volumes

array (string)

Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied.
.spec.strategy.recreateParams.post.tagImages
Description

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

Type

array

.spec.strategy.recreateParams.post.tagImages[]
Description

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.

Type

object

Required

  • containerName

  • to

Property Type Description

containerName

string

ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container.

to

ObjectReference core/v1

To is the target ImageStreamTag to set the container’s image onto.
.spec.strategy.recreateParams.pre
Description

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

Type

object

Required

  • failurePolicy

Property Type Description

execNewPod

object

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

failurePolicy

string

FailurePolicy specifies what action to take if the hook fails.

tagImages

array

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

tagImages[]

object

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.
.spec.strategy.recreateParams.pre.execNewPod
Description

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

Type

object

Required

  • command

  • containerName

Property Type Description

command

array (string)

Command is the action command and its arguments.

containerName

string

ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod’s container.

env

array (EnvVar core/v1)

Env is a set of environment variables to supply to the hook pod’s container.

volumes

array (string)

Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied.
.spec.strategy.recreateParams.pre.tagImages
Description

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

Type

array

.spec.strategy.recreateParams.pre.tagImages[]
Description

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.

Type

object

Required

  • containerName

  • to

Property Type Description

containerName

string

ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container.

to

ObjectReference core/v1

To is the target ImageStreamTag to set the container’s image onto.
.spec.strategy.rollingParams
Description

RollingdeploymentStrategyParams are the input to the Rolling deployment strategy.

Type

object

Property Type Description

intervalSeconds

integer

IntervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used.

maxSurge

IntOrString util/none

MaxSurge is the maximum number of pods that can be scheduled above the original number of pods. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up.

This cannot be 0 if MaxUnavailable is 0. By default, 25% is used.

Example: when this is set to 30%, the new RC can be scaled up by 30% immediately when the rolling update starts. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of original pods.

maxUnavailable

IntOrString util/none

MaxUnavailable is the maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of update (ex: 10%). Absolute number is calculated from percentage by rounding down.

This cannot be 0 if MaxSurge is 0. By default, 25% is used.

Example: when this is set to 30%, the old RC can be scaled down by 30% immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that at least 70% of original number of pods are available at all times during the update.

post

object

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

pre

object

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

timeoutSeconds

integer

TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.

updatePeriodSeconds

integer

UpdatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used.
.spec.strategy.rollingParams.post
Description

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

Type

object

Required

  • failurePolicy

Property Type Description

execNewPod

object

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

failurePolicy

string

FailurePolicy specifies what action to take if the hook fails.

tagImages

array

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

tagImages[]

object

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.
.spec.strategy.rollingParams.post.execNewPod
Description

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

Type

object

Required

  • command

  • containerName

Property Type Description

command

array (string)

Command is the action command and its arguments.

containerName

string

ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod’s container.

env

array (EnvVar core/v1)

Env is a set of environment variables to supply to the hook pod’s container.

volumes

array (string)

Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied.
.spec.strategy.rollingParams.post.tagImages
Description

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

Type

array

.spec.strategy.rollingParams.post.tagImages[]
Description

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.

Type

object

Required

  • containerName

  • to

Property Type Description

containerName

string

ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container.

to

ObjectReference core/v1

To is the target ImageStreamTag to set the container’s image onto.
.spec.strategy.rollingParams.pre
Description

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

Type

object

Required

  • failurePolicy

Property Type Description

execNewPod

object

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

failurePolicy

string

FailurePolicy specifies what action to take if the hook fails.

tagImages

array

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

tagImages[]

object

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.
.spec.strategy.rollingParams.pre.execNewPod
Description

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

Type

object

Required

  • command

  • containerName

Property Type Description

command

array (string)

Command is the action command and its arguments.

containerName

string

ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod’s container.

env

array (EnvVar core/v1)

Env is a set of environment variables to supply to the hook pod’s container.

volumes

array (string)

Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied.
.spec.strategy.rollingParams.pre.tagImages
Description

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

Type

array

.spec.strategy.rollingParams.pre.tagImages[]
Description

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.

Type

object

Required

  • containerName

  • to

Property Type Description

containerName

string

ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container.

to

ObjectReference core/v1

To is the target ImageStreamTag to set the container’s image onto.
.spec.triggers
Description

Triggers determine how updates to a deploymentConfig result in new deployments. If no triggers are defined, a new deployment can only occur as a result of an explicit client update to the deploymentConfig with a new LatestVersion. If null, defaults to having a config change trigger.

Type

array

.spec.triggers[]
Description

deploymentTriggerPolicy describes a policy for a single trigger that results in a new deployment.

Type

object

Property Type Description

imageChangeParams

object

deploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger.

type

string

Type of the trigger
.spec.triggers[].imageChangeParams
Description

deploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger.

Type

object

Required

  • from

Property Type Description

automatic

boolean

Automatic means that the detection of a new tag value should result in an image update inside the pod template.

containerNames

array (string)

ContainerNames is used to restrict tag updates to the specified set of container names in a pod. If multiple triggers point to the same containers, the resulting behavior is undefined. Future API versions will make this a validation error. If ContainerNames does not point to a valid container, the trigger will be ignored. Future API versions will make this a validation error.

from

ObjectReference core/v1

From is a reference to an image stream tag to watch for changes. From.Name is the only required subfield - if From.Namespace is blank, the namespace of the current deployment trigger will be used.

lastTriggeredImage

string

LastTriggeredImage is the last image to be triggered.
.status
Description

deploymentConfigStatus represents the current deployment state.

Type

object

Required

  • latestVersion

  • observedGeneration

  • replicas

  • updatedReplicas

  • availableReplicas

  • unavailableReplicas

Property Type Description

availableReplicas

integer

AvailableReplicas is the total number of available pods targeted by this deployment config.

conditions

array

Conditions represents the latest available observations of a deployment config’s current state.

conditions[]

object

deploymentCondition describes the state of a deployment config at a certain point.

details

object

deploymentDetails captures information about the causes of a deployment.

latestVersion

integer

LatestVersion is used to determine whether the current deployment associated with a deployment config is out of sync.

observedGeneration

integer

ObservedGeneration is the most recent generation observed by the deployment config controller.

readyReplicas

integer

Total number of ready pods targeted by this deployment.

replicas

integer

Replicas is the total number of pods targeted by this deployment config.

unavailableReplicas

integer

UnavailableReplicas is the total number of unavailable pods targeted by this deployment config.

updatedReplicas

integer

UpdatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec.
.status.conditions
Description

Conditions represents the latest available observations of a deployment config’s current state.

Type

array

.status.conditions[]
Description

deploymentCondition describes the state of a deployment config at a certain point.

Type

object

Required

  • type

  • status

Property Type Description

lastTransitionTime

Time meta/v1

The 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.
.status.details
Description

deploymentDetails captures information about the causes of a deployment.

Type

object

Required

  • causes

Property Type Description

causes

array

Causes are extended data associated with all the causes for creating a new deployment

causes[]

object

deploymentCause captures information about a particular cause of a deployment.

message

string

Message is the user specified change message, if this deployment was triggered manually by the user
.status.details.causes
Description

Causes are extended data associated with all the causes for creating a new deployment

Type

array

.status.details.causes[]
Description

deploymentCause captures information about a particular cause of a deployment.

Type

object

Required

  • type

Property Type Description

imageTrigger

object

deploymentCauseImageTrigger represents details about the cause of a deployment originating from an image change trigger

type

string

Type of the trigger that resulted in the creation of a new deployment
.status.details.causes[].imageTrigger
Description

deploymentCauseImageTrigger represents details about the cause of a deployment originating from an image change trigger

Type

object

Required

  • from

Property Type Description

from

ObjectReference core/v1

From is a reference to the changed object which triggered a deployment. The field may have the kinds DockerImage, ImageStreamTag, or ImageStreamImage.

API endpoints

The following API endpoints are available:

  • /apis/apps.openshift.io/v1/deploymentconfigs

    • GET: list or watch objects of kind deploymentConfig

  • /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs

    • DELETE: delete collection of deploymentConfig

    • GET: list or watch objects of kind deploymentConfig

    • POST: create a deploymentConfig

  • /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}

    • DELETE: delete a deploymentConfig

    • GET: read the specified deploymentConfig

    • PATCH: partially update the specified deploymentConfig

    • PUT: replace the specified deploymentConfig

  • /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log

    • GET: read log of the specified deploymentConfig

  • /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/scale

    • GET: read scale of the specified deploymentConfig

    • PATCH: partially update scale of the specified deploymentConfig

    • PUT: replace scale of the specified deploymentConfig

  • /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status

    • GET: read status of the specified deploymentConfig

    • PATCH: partially update status of the specified deploymentConfig

    • PUT: replace status of the specified deploymentConfig

  • /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback

    • POST: create rollback of a deploymentConfig

  • /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate

    • POST: create instantiate of a deploymentConfig

/apis/apps.openshift.io/v1/deploymentconfigs

Table 1. Global query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

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.

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

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

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 deploymentConfig

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfigList apps.openshift.io/v1

/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs

Table 3. Global path parameters
Parameter Type Description

namespace

string

object name and auth scope, such as for teams and projects
Table 4. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete collection of deploymentConfig

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

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.

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

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.

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.

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.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Table 6. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 7. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1
HTTP method

GET

Description

list or watch objects of kind deploymentConfig

Table 8. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

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.

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

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

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 9. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfigList apps.openshift.io/v1
HTTP method

POST

Description

create a deploymentConfig

Table 10. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 11. Body parameters
Parameter Type Description

body

deploymentConfig apps.openshift.io/v1
Table 12. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfig apps.openshift.io/v1

/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}

Table 13. Global path parameters
Parameter Type Description

name

string

name of the deploymentConfig

namespace

string

object name and auth scope, such as for teams and projects
Table 14. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete a deploymentConfig

Table 15. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

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 16. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 17. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1
HTTP method

GET

Description

read the specified deploymentConfig

Table 18. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfig apps.openshift.io/v1
HTTP method

PATCH

Description

partially update the specified deploymentConfig

Table 19. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

force

boolean

Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
Table 20. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 21. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfig apps.openshift.io/v1
HTTP method

PUT

Description

replace the specified deploymentConfig

Table 22. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 23. Body parameters
Parameter Type Description

body

deploymentConfig apps.openshift.io/v1
Table 24. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfig apps.openshift.io/v1

/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log

Table 25. Global path parameters
Parameter Type Description

name

string

name of the deploymentLog

namespace

string

object name and auth scope, such as for teams and projects
Table 26. Global query parameters
Parameter Type Description

container

string

The container for which to stream logs. Defaults to only container if there is one container in the pod.

follow

boolean

Follow if true indicates that the build log should be streamed until the build terminates.

limitBytes

integer

If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.

nowait

boolean

NoWait if true causes the call to return immediately even if the deployment is not available yet. Otherwise the server will wait until the deployment has started.

pretty

string

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

previous

boolean

Return previous deployment logs. Defaults to false.

sinceSeconds

integer

A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

tailLines

integer

If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime

timestamps

boolean

If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

version

integer

Version of the deployment for which to view logs.
HTTP method

GET

Description

read log of the specified deploymentConfig

Table 27. HTTP responses
HTTP code Reponse body

200 - OK

deploymentLog apps.openshift.io/v1

/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/scale

Table 28. 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 29. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

GET

Description

read scale of the specified deploymentConfig

Table 30. HTTP responses
HTTP code Reponse body

200 - OK

Scale extensions/v1beta1
HTTP method

PATCH

Description

partially update scale of the specified deploymentConfig

Table 31. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

force

boolean

Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
Table 32. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 33. HTTP responses
HTTP code Reponse body

200 - OK

Scale extensions/v1beta1
HTTP method

PUT

Description

replace scale of the specified deploymentConfig

Table 34. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 35. Body parameters
Parameter Type Description

body

Scale extensions/v1beta1
Table 36. HTTP responses
HTTP code Reponse body

200 - OK

Scale extensions/v1beta1

/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status

Table 37. Global path parameters
Parameter Type Description

name

string

name of the deploymentConfig

namespace

string

object name and auth scope, such as for teams and projects
Table 38. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

GET

Description

read status of the specified deploymentConfig

Table 39. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfig apps.openshift.io/v1
HTTP method

PATCH

Description

partially update status of the specified deploymentConfig

Table 40. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

force

boolean

Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
Table 41. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 42. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfig apps.openshift.io/v1
HTTP method

PUT

Description

replace status of the specified deploymentConfig

Table 43. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 44. Body parameters
Parameter Type Description

body

deploymentConfig apps.openshift.io/v1
Table 45. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfig apps.openshift.io/v1

/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback

Table 46. Global path parameters
Parameter Type Description

name

string

name of the deploymentConfigRollback

namespace

string

object name and auth scope, such as for teams and projects
Table 47. Global query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

pretty

string

If 'true', then the output is pretty printed.
HTTP method

POST

Description

create rollback of a deploymentConfig

Table 48. Body parameters
Parameter Type Description

body

deploymentConfigRollback apps.openshift.io/v1
Table 49. HTTP responses
HTTP code Reponse body

200 - OK

deploymentConfigRollback apps.openshift.io/v1

/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate

Table 50. Global path parameters
Parameter Type Description

name

string

name of the deploymentRequest

namespace

string

object name and auth scope, such as for teams and projects
Table 51. Global query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

pretty

string

If 'true', then the output is pretty printed.
HTTP method

POST

Description

create instantiate of a deploymentConfig

Table 52. Body parameters
Parameter Type Description

body

deploymentRequest apps.openshift.io/v1
Table 53. HTTP responses
HTTP code Reponse body

200 - OK

deploymentRequest apps.openshift.io/v1