<strong>deployment</strong>ConfigRollback [apps.openshift.io/v1] - Workloads APIs | API reference

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

Description

deploymentConfigRollback provides the input to rollback generation.

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
spec

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
`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
`name`	`string`	Name of the deployment config that will be rolled back.
`spec`	`object`	deploymentConfigRollbackSpec represents the options for rollback generation.
`updatedAnnotations`	`object (string)`	UpdatedAnnotations is a set of new annotations that will be added in the deployment config.

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

name

string

Name of the deployment config that will be rolled back.

spec

object

deploymentConfigRollbackSpec represents the options for rollback generation.

updatedAnnotations

object (string)

UpdatedAnnotations is a set of new annotations that will be added in the deployment config.

.spec

Description

deploymentConfigRollbackSpec represents the options for rollback generation.

Type

object

Required

from
includeTriggers
includeTemplate
includeReplicationMeta
includeStrategy

Property Type Description

Property	Type	Description
`from`	`ObjectReference`	From points to a ReplicationController which is a deployment.
`includeReplicationMeta`	`boolean`	IncludeReplicationMeta specifies whether to include the replica count and selector.
`includeStrategy`	`boolean`	IncludeStrategy specifies whether to include the deployment Strategy.
`includeTemplate`	`boolean`	IncludeTemplate specifies whether to include the PodTemplateSpec.
`includeTriggers`	`boolean`	IncludeTriggers specifies whether to include config Triggers.
`revision`	`integer`	Revision to rollback to. If set to 0, rollback to the last revision.

from

ObjectReference

From points to a ReplicationController which is a deployment.

includeReplicationMeta

boolean

IncludeReplicationMeta specifies whether to include the replica count and selector.

includeStrategy

boolean

IncludeStrategy specifies whether to include the deployment Strategy.

includeTemplate

boolean

IncludeTemplate specifies whether to include the PodTemplateSpec.

includeTriggers

boolean

IncludeTriggers specifies whether to include config Triggers.

revision

integer

Revision to rollback to. If set to 0, rollback to the last revision.

API endpoints

The following API endpoints are available:

/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}/rollback

Table 1. 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 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 rollback of a deploymentConfig

Table 3. Body parameters
Parameter	Type	Description
`body`	`deploymentConfigRollback` schema

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

deploymentConfigRollback [apps.openshift.io/v1]

Specification

.spec

API endpoints

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