Chapter 12. DeploymentRequest [apps.openshift.io/v1]
- Description
DeploymentRequest is a request to a deployment config for a new deployment.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
-
object - Required
-
name -
latest -
force
-
12.1. 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 |
|
|
| ExcludeTriggers instructs the instantiator to avoid processing the specified triggers. This field overrides the triggers from latest and allows clients to control specific logic. This field is ignored if not specified. |
|
|
| Force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error. |
|
|
| 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 |
|
|
| Latest will update the deployment config with the latest state from all triggers. |
|
|
| Name of the deployment config for requesting a new deployment. |
12.2. API endpoints
The following API endpoints are available:
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate-
POST: create instantiate of a DeploymentConfig
-
12.2.1. /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. |
|
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
|
|
| 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 |
