- DeploymentConfig [apps.openshift.io/v1]
- Specification
- API endpoints
- /apis/apps.openshift.io/v1/deploymentconfigs
- /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs
- /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}
- /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log
- /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/scale
- /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status
- /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback
- /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate
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 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 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 |
| ||
|
| DeploymentConfigSpec represents the desired state of the deployment. |
|
| DeploymentConfigStatus represents the current deployment state. |
.spec
Description
DeploymentConfigSpec represents the desired state of the deployment.
Type
object
Property | Type | Description |
---|---|---|
|
| 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 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 is the number of desired replicas. |
|
| 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 is a label query over pods that should match the Replicas count. |
|
| DeploymentStrategy describes how to perform a deployment. |
| Template is the object that describes the pod that will be created if insufficient replicas are detected. | |
|
| 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 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. |
|
| 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 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 is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. |
|
| CustomDeploymentStrategyParams are the input to the Custom deployment strategy. |
|
| Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods. |
|
| RecreateDeploymentStrategyParams are the input to the Recreate deployment strategy. |
| Resources contains resource requirements to execute the deployment and any hooks. | |
|
| RollingDeploymentStrategyParams are the input to the Rolling deployment strategy. |
|
| 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 is optional and overrides CMD in the container Image. |
| Environment holds the environment which will be given to the container for Image. | |
|
| 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 |
---|---|---|
|
| LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time. |
|
| LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time. |
|
| LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time. |
|
| 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 |
---|---|---|
|
| 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 specifies what action to take if the hook fails. |
|
| TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. |
|
| 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 is the action command and its arguments. |
|
| 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 is a set of environment variables to supply to the hook pod’s container. | |
|
| 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 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 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 |
---|---|---|
|
| 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 specifies what action to take if the hook fails. |
|
| TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. |
|
| 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 is the action command and its arguments. |
|
| 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 is a set of environment variables to supply to the hook pod’s container. | |
|
| 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 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 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 |
---|---|---|
|
| 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 specifies what action to take if the hook fails. |
|
| TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. |
|
| 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 is the action command and its arguments. |
|
| 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 is a set of environment variables to supply to the hook pod’s container. | |
|
| 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 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 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 is the time to wait between polling deployment status after update. If the value is nil, a default will be used. |
| 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 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. | |
|
| LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time. |
|
| LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time. |
|
| TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used. |
|
| 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 |
---|---|---|
|
| 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 specifies what action to take if the hook fails. |
|
| TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. |
|
| 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 is the action command and its arguments. |
|
| 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 is a set of environment variables to supply to the hook pod’s container. | |
|
| 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 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 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 |
---|---|---|
|
| 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 specifies what action to take if the hook fails. |
|
| TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag. |
|
| 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 is the action command and its arguments. |
|
| 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 is a set of environment variables to supply to the hook pod’s container. | |
|
| 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 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 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 |
---|---|---|
|
| DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger. |
|
| Type of the trigger |
.spec.triggers[].imageChangeParams
Description
DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger.
Type
object
Required
from
Property | Type | Description |
---|---|---|
|
| Automatic means that the detection of a new tag value should result in an image update inside the pod template. |
|
| 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 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 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 is the total number of available pods targeted by this deployment config. |
|
| Conditions represents the latest available observations of a deployment config’s current state. |
|
| DeploymentCondition describes the state of a deployment config at a certain point. |
|
| DeploymentDetails captures information about the causes of a deployment. |
|
| LatestVersion is used to determine whether the current deployment associated with a deployment config is out of sync. |
|
| ObservedGeneration is the most recent generation observed by the deployment config controller. |
|
| Total number of ready pods targeted by this deployment. |
|
| Replicas is the total number of pods targeted by this deployment config. |
|
| UnavailableReplicas is the total number of unavailable pods targeted by this deployment config. |
|
| 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 |
---|---|---|
| The last time the condition transitioned from one status to another. | |
| The last time this condition was updated. | |
|
| A human readable message indicating details about the transition. |
|
| The reason for the condition’s last transition. |
|
| Status of the condition, one of True, False, Unknown. |
|
| Type of deployment condition. |
.status.details
Description
DeploymentDetails captures information about the causes of a deployment.
Type
object
Required
causes
Property | Type | Description |
---|---|---|
|
| Causes are extended data associated with all the causes for creating a new deployment |
|
| DeploymentCause captures information about a particular cause of a deployment. |
|
| 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 |
---|---|---|
|
| DeploymentCauseImageTrigger represents details about the cause of a deployment originating from an image change trigger |
|
| 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 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 DeploymentConfigGET
: list or watch objects of kind DeploymentConfigPOST
: create a DeploymentConfig
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}
DELETE
: delete a DeploymentConfigGET
: read the specified DeploymentConfigPATCH
: partially update the specified DeploymentConfigPUT
: 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 DeploymentConfigPATCH
: partially update scale of the specified DeploymentConfigPUT
: replace scale of the specified DeploymentConfig
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status
GET
: read status of the specified DeploymentConfigPATCH
: partially update status of the specified DeploymentConfigPUT
: 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
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
|
| If ‘true’, then the output is pretty printed. |
|
| 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| 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
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs
Parameter | Type | Description |
---|---|---|
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete collection of DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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 |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
|
| 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. |
|
| 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 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list or watch objects of kind DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | Empty |
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the DeploymentConfig |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete a DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| 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. |
|
| 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. |
|
| 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
202 - Accepted | |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| Should the export be exact. Exact export maintains cluster-specific fields like ‘Namespace’. Deprecated. Planned for removal in 1.18. |
|
| Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | Empty |
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log
Parameter | Type | Description |
---|---|---|
|
| name of the DeploymentLog |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| The container for which to stream logs. Defaults to only container if there is one container in the pod. |
|
| Follow if true indicates that the build log should be streamed until the build terminates. |
|
| 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 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. |
|
| If ‘true’, then the output is pretty printed. |
|
| Return previous deployment logs. Defaults to false. |
|
| 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. |
|
| 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 |
|
| If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. |
|
| Version of the deployment for which to view logs. |
HTTP method
GET
Description
read log of the specified DeploymentConfig
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/scale
Parameter | Type | Description |
---|---|---|
|
| name of the Scale |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
GET
Description
read scale of the specified DeploymentConfig
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update scale of the specified DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace scale of the specified DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | Empty |
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the DeploymentConfig |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
GET
Description
read status of the specified DeploymentConfig
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | Empty |
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback
Parameter | Type | Description |
---|---|---|
|
| name of the DeploymentConfigRollback |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
|
| If ‘true’, then the output is pretty printed. |
HTTP method
POST
Description
create rollback of a DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | Empty |
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate
Parameter | Type | Description |
---|---|---|
|
| name of the DeploymentRequest |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
|
| If ‘true’, then the output is pretty printed. |
HTTP method
POST
Description
create instantiate of a DeploymentConfig
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | Empty |