DeploymentRequest [apps.openshift.io/v1] - Workloads APIs | API reference

Specification
API endpoints
- /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate

Description

DeploymentRequest is a request to a deployment config for a new deployment.

Type

object

Required

name
latest
force

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`excludeTriggers`	`array (string)`	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`	`boolean`	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`	`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
`latest`	`boolean`	Latest will update the deployment config with the latest state from all triggers.
`name`	`string`	Name of the deployment config for requesting a new deployment.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

excludeTriggers

array (string)

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

boolean

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

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

latest

boolean

Latest will update the deployment config with the latest state from all triggers.

name

string

Name of the deployment config for requesting a new deployment.

API endpoints

The following API endpoints are available:

/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate
- POST: create instantiate of a DeploymentConfig

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

Table 1. 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 2. 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 3. Body parameters
Parameter	Type	Description
`body`	`DeploymentRequest` schema

Table 4. HTTP responses
HTTP code	Reponse body
200 - OK	`DeploymentRequest` schema
201 - Created	`DeploymentRequest` schema
202 - Accepted	`DeploymentRequest` schema
401 - Unauthorized	Empty