This is a cache of https://docs.okd.io/4.10/rest_api/workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.html. It is a snapshot of the page at 2024-11-21T22:48:37.292+0000.
DeploymentConfigRollback [apps.openshift.io/v1] - Workloads <strong>api</strong>s | <strong>api</strong> reference | OKD 4.10
  1. Documentation
×

DeploymentConfigRollback [apps.openshift.io/v1]

Description

DeploymentConfigRollback provides the input to rollback generation.

Type

object

Required

  • name

  • 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

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

from

ObjectReference_v2

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