kubernetes reference apiVersion v1 contenttype apireference title ReplicationController apimetadata weight 4 kind ReplicationController autogenerated true ReplicationController represents the configuration of a replication controller import k8s io api core v1

Answer:
---
api_metadata:
  apiVersion: "v1"
  import: "k8s.io/api/core/v1"
  kind: "ReplicationController"
content_type: "api_reference"
description: "ReplicationController represents the configuration of a replication controller."
title: "ReplicationController"
weight: 4
auto_generated: true
---

`apiVersion: v1`

`import "k8s.io/api/core/v1"`

## ReplicationController {#ReplicationController}

ReplicationController represents the configuration of a replication controller.

- **apiVersion**: v1

- **kind**: ReplicationController

- **metadata** (ObjectMeta)

  If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **spec** (ReplicationControllerSpec)

  Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

- **status** (ReplicationControllerStatus)

  Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

## ReplicationControllerSpec {#ReplicationControllerSpec}

ReplicationControllerSpec is the specification of a replication controller.

- **selector** (map[string]string)

  Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

- **template** (PodTemplateSpec)

  Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

- **replicas** (int32)

  Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

- **minReadySeconds** (int32)

  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)

## ReplicationControllerStatus {#ReplicationControllerStatus}

ReplicationControllerStatus represents the current status of a replication controller.

- **replicas** (int32), required

  Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

- **availableReplicas** (int32)

  The number of available replicas (ready for at least minReadySeconds) for this replication controller.

- **readyReplicas** (int32)

  The number of ready replicas for this replication controller.

- **fullyLabeledReplicas** (int32)

  The number of pods that have labels matching the labels of the pod template of the replication controller.

- **conditions** ([]ReplicationControllerCondition)

  *Patch strategy: merge on key `type`*

  *Map: unique values on key type will be kept during a merge*

  Represents the latest available observations of a replication controller's current state.

  *ReplicationControllerCondition describes the state of a replication controller at a certain point.*

  - **conditions.status** (string), required

    Status of the condition, one of True, False, Unknown.

  - **conditions.type** (string), required

    Type of replication controller condition.

  - **conditions.lastTransitionTime** (Time)

    The last time the condition transitioned from one status to another.

    *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.*

  - **conditions.message** (string)

    A human readable message indicating details about the transition.

  - **conditions.reason** (string)

    The reason for the condition's last transition.

- **observedGeneration** (int64)

  ObservedGeneration reflects the generation of the most recently observed replication controller.

## ReplicationControllerList {#ReplicationControllerList}

ReplicationControllerList is a collection of replication controllers.

- **apiVersion**: v1

- **kind**: ReplicationControllerList

- **metadata** (ListMeta)

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

- **items** ([]ReplicationController), required

  List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

## Operations {#Operations}

### `get` read the specified ReplicationController

#### HTTP Request

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicationController

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicationController): OK

401: Unauthorized

### `get` read status of the specified ReplicationController

#### HTTP Request

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicationController

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicationController): OK

401: Unauthorized

### `list` list or watch objects of kind ReplicationController

#### HTTP Request

GET /api/v1/namespaces/{namespace}/replicationcontrollers

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (ReplicationControllerList): OK

401: Unauthorized

### `list` list or watch objects of kind ReplicationController

#### HTTP Request

GET /api/v1/replicationcontrollers

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (ReplicationControllerList): OK

401: Unauthorized

### `create` create a ReplicationController

#### HTTP Request

POST /api/v1/namespaces/{namespace}/replicationcontrollers

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: ReplicationController, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicationController): OK

201 (ReplicationController): Created

202 (ReplicationController): Accepted

401: Unauthorized

### `update` replace the specified ReplicationController

#### HTTP Request

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicationController

- **namespace** (*in path*): string, required

  namespace

- **body**: ReplicationController, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicationController): OK

201 (ReplicationController): Created

401: Unauthorized

### `update` replace status of the specified ReplicationController

#### HTTP Request

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicationController

- **namespace** (*in path*): string, required

  namespace

- **body**: ReplicationController, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicationController): OK

201 (ReplicationController): Created

401: Unauthorized

### `patch` partially update the specified ReplicationController

#### HTTP Request

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicationController

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicationController): OK

201 (ReplicationController): Created

401: Unauthorized

### `patch` partially update status of the specified ReplicationController

#### HTTP Request

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicationController

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicationController): OK

201 (ReplicationController): Created

401: Unauthorized

### `delete` delete a ReplicationController

#### HTTP Request

DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicationController

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of ReplicationController

#### HTTP Request

DELETE /api/v1/namespaces/{namespace}/replicationcontrollers

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   v1    import   k8s io api core v1    kind   ReplicationController  content type   api reference  description   ReplicationController represents the configuration of a replication controller   title   ReplicationController  weight  4 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  v1    import  k8s io api core v1        ReplicationController   ReplicationController   ReplicationController represents the configuration of a replication controller    hr       apiVersion    v1       kind    ReplicationController       metadata     a href    ObjectMeta  a      If the Labels of a ReplicationController are empty  they are defaulted to be the same as the Pod s  that the replication controller manages  Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      spec     a href    ReplicationControllerSpec  a      Spec defines the specification of the desired behavior of the replication controller  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status      status     a href    ReplicationControllerStatus  a      Status is the most recently observed status of the replication controller  This data may be out of date by some window of time  Populated by the system  Read only  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status         ReplicationControllerSpec   ReplicationControllerSpec   ReplicationControllerSpec is the specification of a replication controller    hr       selector    map string string     Selector is a label query over pods that should match the Replicas count  If Selector is empty  it is defaulted to the labels present on the Pod template  Label keys and values that must match in order to be controlled by this replication controller  if empty defaulted to labels on Pod template  More info  https   kubernetes io docs concepts overview working with objects labels  label selectors      template     a href    PodTemplateSpec  a      Template is the object that describes the pod that will be created if insufficient replicas are detected  This takes precedence over a TemplateRef  The only allowed template spec restartPolicy value is  Always   More info  https   kubernetes io docs concepts workloads controllers replicationcontroller pod template      replicas    int32     Replicas is the number of desired replicas  This is a pointer to distinguish between explicit zero and unspecified  Defaults to 1  More info  https   kubernetes io docs concepts workloads controllers replicationcontroller what is a replicationcontroller      minReadySeconds    int32     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          ReplicationControllerStatus   ReplicationControllerStatus   ReplicationControllerStatus represents the current status of a replication controller    hr       replicas    int32   required    Replicas is the most recently observed number of replicas  More info  https   kubernetes io docs concepts workloads controllers replicationcontroller what is a replicationcontroller      availableReplicas    int32     The number of available replicas  ready for at least minReadySeconds  for this replication controller       readyReplicas    int32     The number of ready replicas for this replication controller       fullyLabeledReplicas    int32     The number of pods that have labels matching the labels of the pod template of the replication controller       conditions      ReplicationControllerCondition      Patch strategy  merge on key  type         Map  unique values on key type will be kept during a merge       Represents the latest available observations of a replication controller s current state      a name  ReplicationControllerCondition    a     ReplicationControllerCondition describes the state of a replication controller at a certain point          conditions status    string   required      Status of the condition  one of True  False  Unknown         conditions type    string   required      Type of replication controller condition         conditions lastTransitionTime    Time       The last time the condition transitioned from one status to another        a name  Time    a       Time is a wrapper around time Time which supports correct marshaling to YAML and JSON   Wrappers are provided for many of the factory methods that the time package offers          conditions message    string       A human readable message indicating details about the transition         conditions reason    string       The reason for the condition s last transition       observedGeneration    int64     ObservedGeneration reflects the generation of the most recently observed replication controller          ReplicationControllerList   ReplicationControllerList   ReplicationControllerList is a collection of replication controllers    hr       apiVersion    v1       kind    ReplicationControllerList       metadata     a href    ListMeta  a      Standard list metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md types kinds      items       a href    ReplicationController  a    required    List of replication controllers  More info  https   kubernetes io docs concepts workloads controllers replicationcontroller         Operations   Operations      hr             get  read the specified ReplicationController       HTTP Request  GET  api v1 namespaces  namespace  replicationcontrollers  name        Parameters       name     in path    string  required    name of the ReplicationController       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicationController  a    OK  401  Unauthorized        get  read status of the specified ReplicationController       HTTP Request  GET  api v1 namespaces  namespace  replicationcontrollers  name  status       Parameters       name     in path    string  required    name of the ReplicationController       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicationController  a    OK  401  Unauthorized        list  list or watch objects of kind ReplicationController       HTTP Request  GET  api v1 namespaces  namespace  replicationcontrollers       Parameters       namespace     in path    string  required     a href    namespace  a        allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    ReplicationControllerList  a    OK  401  Unauthorized        list  list or watch objects of kind ReplicationController       HTTP Request  GET  api v1 replicationcontrollers       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    ReplicationControllerList  a    OK  401  Unauthorized        create  create a ReplicationController       HTTP Request  POST  api v1 namespaces  namespace  replicationcontrollers       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    ReplicationController  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicationController  a    OK  201   a href    ReplicationController  a    Created  202   a href    ReplicationController  a    Accepted  401  Unauthorized        update  replace the specified ReplicationController       HTTP Request  PUT  api v1 namespaces  namespace  replicationcontrollers  name        Parameters       name     in path    string  required    name of the ReplicationController       namespace     in path    string  required     a href    namespace  a        body     a href    ReplicationController  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicationController  a    OK  201   a href    ReplicationController  a    Created  401  Unauthorized        update  replace status of the specified ReplicationController       HTTP Request  PUT  api v1 namespaces  namespace  replicationcontrollers  name  status       Parameters       name     in path    string  required    name of the ReplicationController       namespace     in path    string  required     a href    namespace  a        body     a href    ReplicationController  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicationController  a    OK  201   a href    ReplicationController  a    Created  401  Unauthorized        patch  partially update the specified ReplicationController       HTTP Request  PATCH  api v1 namespaces  namespace  replicationcontrollers  name        Parameters       name     in path    string  required    name of the ReplicationController       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicationController  a    OK  201   a href    ReplicationController  a    Created  401  Unauthorized        patch  partially update status of the specified ReplicationController       HTTP Request  PATCH  api v1 namespaces  namespace  replicationcontrollers  name  status       Parameters       name     in path    string  required    name of the ReplicationController       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicationController  a    OK  201   a href    ReplicationController  a    Created  401  Unauthorized        delete  delete a ReplicationController       HTTP Request  DELETE  api v1 namespaces  namespace  replicationcontrollers  name        Parameters       name     in path    string  required    name of the ReplicationController       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of ReplicationController       HTTP Request  DELETE  api v1 namespaces  namespace  replicationcontrollers       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized


kubernetes reference apiVersion apps v1 contenttype apireference kind ControllerRevision weight 8 apimetadata title ControllerRevision autogenerated true import k8s io api apps v1 ControllerRevision implements an immutable snapshot of state data

Answer:
---
api_metadata:
  apiVersion: "apps/v1"
  import: "k8s.io/api/apps/v1"
  kind: "ControllerRevision"
content_type: "api_reference"
description: "ControllerRevision implements an immutable snapshot of state data."
title: "ControllerRevision"
weight: 8
auto_generated: true
---

`apiVersion: apps/v1`

`import "k8s.io/api/apps/v1"`

## ControllerRevision {#ControllerRevision}

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

- **apiVersion**: apps/v1

- **kind**: ControllerRevision

- **metadata** (ObjectMeta)

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **revision** (int64), required

  Revision indicates the revision of the state represented by Data.

- **data** (RawExtension)

  Data is the serialized representation of the state.

  *RawExtension is used to hold extensions in external versions.

  To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.

  // Internal package:

  	type MyAPIObject struct {
  		runtime.TypeMeta `json:",inline"`
  		MyPlugin runtime.Object `json:"myPlugin"`
  	}

  	type PluginA struct {
  		AOption string `json:"aOption"`
  	}

  // External package:

  	type MyAPIObject struct {
  		runtime.TypeMeta `json:",inline"`
  		MyPlugin runtime.RawExtension `json:"myPlugin"`
  	}

  	type PluginA struct {
  		AOption string `json:"aOption"`
  	}

  // On the wire, the JSON will look something like this:

  	{
  		"kind":"MyAPIObject",
  		"apiVersion":"v1",
  		"myPlugin": {
  			"kind":"PluginA",
  			"aOption":"foo",
  		},
  	}

  So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*

## ControllerRevisionList {#ControllerRevisionList}

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

- **apiVersion**: apps/v1

- **kind**: ControllerRevisionList

- **metadata** (ListMeta)

  More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **items** ([]ControllerRevision), required

  Items is the list of ControllerRevisions

## Operations {#Operations}

### `get` read the specified ControllerRevision

#### HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ControllerRevision

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (ControllerRevision): OK

401: Unauthorized

### `list` list or watch objects of kind ControllerRevision

#### HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (ControllerRevisionList): OK

401: Unauthorized

### `list` list or watch objects of kind ControllerRevision

#### HTTP Request

GET /apis/apps/v1/controllerrevisions

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (ControllerRevisionList): OK

401: Unauthorized

### `create` create a ControllerRevision

#### HTTP Request

POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: ControllerRevision, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (ControllerRevision): OK

201 (ControllerRevision): Created

202 (ControllerRevision): Accepted

401: Unauthorized

### `update` replace the specified ControllerRevision

#### HTTP Request

PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ControllerRevision

- **namespace** (*in path*): string, required

  namespace

- **body**: ControllerRevision, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (ControllerRevision): OK

201 (ControllerRevision): Created

401: Unauthorized

### `patch` partially update the specified ControllerRevision

#### HTTP Request

PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ControllerRevision

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (ControllerRevision): OK

201 (ControllerRevision): Created

401: Unauthorized

### `delete` delete a ControllerRevision

#### HTTP Request

DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ControllerRevision

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of ControllerRevision

#### HTTP Request

DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   apps v1    import   k8s io api apps v1    kind   ControllerRevision  content type   api reference  description   ControllerRevision implements an immutable snapshot of state data   title   ControllerRevision  weight  8 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  apps v1    import  k8s io api apps v1        ControllerRevision   ControllerRevision   ControllerRevision implements an immutable snapshot of state data  Clients are responsible for serializing and deserializing the objects that contain their internal state  Once a ControllerRevision has been successfully created  it can not be updated  The API Server will fail validation of all requests that attempt to mutate the Data field  ControllerRevisions may  however  be deleted  Note that  due to its use by both the DaemonSet and StatefulSet controllers for update and rollback  this object is beta  However  it may be subject to name and representation changes in future releases  and clients should not depend on its stability  It is primarily for internal use by controllers    hr       apiVersion    apps v1       kind    ControllerRevision       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      revision    int64   required    Revision indicates the revision of the state represented by Data       data    RawExtension     Data is the serialized representation of the state      a name  RawExtension    a     RawExtension is used to hold extensions in external versions       To use this  make a field which has RawExtension as its type in your external  versioned struct  and Object in your internal struct  You also need to register your various plugin types          Internal package        type MyAPIObject struct       runtime TypeMeta  json   inline       MyPlugin runtime Object  json  myPlugin              type PluginA struct       AOption string  json  aOption                External package        type MyAPIObject struct       runtime TypeMeta  json   inline       MyPlugin runtime RawExtension  json  myPlugin              type PluginA struct       AOption string  json  aOption                On the wire  the JSON will look something like this               kind   MyAPIObject        apiVersion   v1        myPlugin           kind   PluginA         aOption   foo                    So what happens  Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject  That causes the raw JSON to be stored  but not unpacked  The next step is to copy  using pkg conversion  into the internal struct  The runtime package s DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension  turning it into the correct object type  and storing it in the Object   TODO  In the case where the object is of an unknown type  a runtime Unknown object will be created and stored            ControllerRevisionList   ControllerRevisionList   ControllerRevisionList is a resource containing a list of ControllerRevision objects    hr       apiVersion    apps v1       kind    ControllerRevisionList       metadata     a href    ListMeta  a      More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    ControllerRevision  a    required    Items is the list of ControllerRevisions         Operations   Operations      hr             get  read the specified ControllerRevision       HTTP Request  GET  apis apps v1 namespaces  namespace  controllerrevisions  name        Parameters       name     in path    string  required    name of the ControllerRevision       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ControllerRevision  a    OK  401  Unauthorized        list  list or watch objects of kind ControllerRevision       HTTP Request  GET  apis apps v1 namespaces  namespace  controllerrevisions       Parameters       namespace     in path    string  required     a href    namespace  a        allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    ControllerRevisionList  a    OK  401  Unauthorized        list  list or watch objects of kind ControllerRevision       HTTP Request  GET  apis apps v1 controllerrevisions       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    ControllerRevisionList  a    OK  401  Unauthorized        create  create a ControllerRevision       HTTP Request  POST  apis apps v1 namespaces  namespace  controllerrevisions       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    ControllerRevision  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ControllerRevision  a    OK  201   a href    ControllerRevision  a    Created  202   a href    ControllerRevision  a    Accepted  401  Unauthorized        update  replace the specified ControllerRevision       HTTP Request  PUT  apis apps v1 namespaces  namespace  controllerrevisions  name        Parameters       name     in path    string  required    name of the ControllerRevision       namespace     in path    string  required     a href    namespace  a        body     a href    ControllerRevision  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ControllerRevision  a    OK  201   a href    ControllerRevision  a    Created  401  Unauthorized        patch  partially update the specified ControllerRevision       HTTP Request  PATCH  apis apps v1 namespaces  namespace  controllerrevisions  name        Parameters       name     in path    string  required    name of the ControllerRevision       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ControllerRevision  a    OK  201   a href    ControllerRevision  a    Created  401  Unauthorized        delete  delete a ControllerRevision       HTTP Request  DELETE  apis apps v1 namespaces  namespace  controllerrevisions  name        Parameters       name     in path    string  required    name of the ControllerRevision       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of ControllerRevision       HTTP Request  DELETE  apis apps v1 namespaces  namespace  controllerrevisions       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized


kubernetes reference Binding ties one object to another for example a pod is bound to a node by a scheduler apiVersion v1 weight 2 contenttype apireference apimetadata title Binding autogenerated true kind Binding import k8s io api core v1

Answer:
---
api_metadata:
  apiVersion: "v1"
  import: "k8s.io/api/core/v1"
  kind: "Binding"
content_type: "api_reference"
description: "Binding ties one object to another; for example, a pod is bound to a node by a scheduler."
title: "Binding"
weight: 2
auto_generated: true
---

`apiVersion: v1`

`import "k8s.io/api/core/v1"`

## Binding {#Binding}

Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.

- **apiVersion**: v1

- **kind**: Binding

- **metadata** (ObjectMeta)

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **target** (ObjectReference), required

  The target object that you want to bind to the standard object.

## Operations {#Operations}

### `create` create a Binding

#### HTTP Request

POST /api/v1/namespaces/{namespace}/bindings

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: Binding, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Binding): OK

201 (Binding): Created

202 (Binding): Accepted

401: Unauthorized

### `create` create binding of a Pod

#### HTTP Request

POST /api/v1/namespaces/{namespace}/pods/{name}/binding

#### Parameters

- **name** (*in path*): string, required

  name of the Binding

- **namespace** (*in path*): string, required

  namespace

- **body**: Binding, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Binding): OK

201 (Binding): Created

202 (Binding): Accepted

401: Unauthorized

api metadata    apiVersion   v1    import   k8s io api core v1    kind   Binding  content type   api reference  description   Binding ties one object to another  for example  a pod is bound to a node by a scheduler   title   Binding  weight  2 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  v1    import  k8s io api core v1        Binding   Binding   Binding ties one object to another  for example  a pod is bound to a node by a scheduler  Deprecated in 1 7  please use the bindings subresource of pods instead    hr       apiVersion    v1       kind    Binding       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      target     a href    ObjectReference  a    required    The target object that you want to bind to the standard object          Operations   Operations      hr             create  create a Binding       HTTP Request  POST  api v1 namespaces  namespace  bindings       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    Binding  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Binding  a    OK  201   a href    Binding  a    Created  202   a href    Binding  a    Accepted  401  Unauthorized        create  create binding of a Pod       HTTP Request  POST  api v1 namespaces  namespace  pods  name  binding       Parameters       name     in path    string  required    name of the Binding       namespace     in path    string  required     a href    namespace  a        body     a href    Binding  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Binding  a    OK  201   a href    Binding  a    Created  202   a href    Binding  a    Accepted  401  Unauthorized


kubernetes reference weight 6 apiVersion apps v1 contenttype apireference kind Deployment apimetadata autogenerated true import k8s io api apps v1 title Deployment Deployment enables declarative updates for Pods and ReplicaSets

Answer:
---
api_metadata:
  apiVersion: "apps/v1"
  import: "k8s.io/api/apps/v1"
  kind: "Deployment"
content_type: "api_reference"
description: "Deployment enables declarative updates for Pods and ReplicaSets."
title: "Deployment"
weight: 6
auto_generated: true
---

`apiVersion: apps/v1`

`import "k8s.io/api/apps/v1"`

## Deployment {#Deployment}

Deployment enables declarative updates for Pods and ReplicaSets.

- **apiVersion**: apps/v1

- **kind**: Deployment

- **metadata** (ObjectMeta)

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **spec** (DeploymentSpec)

  Specification of the desired behavior of the Deployment.

- **status** (DeploymentStatus)

  Most recently observed status of the Deployment.

## DeploymentSpec {#DeploymentSpec}

DeploymentSpec is the specification of the desired behavior of the Deployment.

- **selector** (LabelSelector), required

  Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.

- **template** (PodTemplateSpec), required

  Template describes the pods that will be created. The only allowed template.spec.restartPolicy value is "Always".

- **replicas** (int32)

  Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

- **minReadySeconds** (int32)

  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)

- **strategy** (DeploymentStrategy)

  *Patch strategy: retainKeys*

  The deployment strategy to use to replace existing pods with new ones.

  *DeploymentStrategy describes how to replace existing pods with new ones.*

  - **strategy.type** (string)

    Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

  - **strategy.rollingUpdate** (RollingUpdateDeployment)

    Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

    *Spec to control the desired behavior of rolling update.*

    - **strategy.rollingUpdate.maxSurge** (IntOrString)

      The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

      *IntOrString is a type that can hold an int32 or a string.  When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type.  This allows you to have, for example, a JSON field that can accept a name or number.*

    - **strategy.rollingUpdate.maxUnavailable** (IntOrString)

      The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

      *IntOrString is a type that can hold an int32 or a string.  When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type.  This allows you to have, for example, a JSON field that can accept a name or number.*

- **revisionHistoryLimit** (int32)

  The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

- **progressDeadlineSeconds** (int32)

  The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

- **paused** (boolean)

  Indicates that the deployment is paused.

## DeploymentStatus {#DeploymentStatus}

DeploymentStatus is the most recently observed status of the Deployment.

- **replicas** (int32)

  Total number of non-terminated pods targeted by this deployment (their labels match the selector).

- **availableReplicas** (int32)

  Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

- **readyReplicas** (int32)

  readyReplicas is the number of pods targeted by this Deployment with a Ready Condition.

- **unavailableReplicas** (int32)

  Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

- **updatedReplicas** (int32)

  Total number of non-terminated pods targeted by this deployment that have the desired template spec.

- **collisionCount** (int32)

  Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

- **conditions** ([]DeploymentCondition)

  *Patch strategy: merge on key `type`*

  *Map: unique values on key type will be kept during a merge*

  Represents the latest available observations of a deployment's current state.

  *DeploymentCondition describes the state of a deployment at a certain point.*

  - **conditions.status** (string), required

    Status of the condition, one of True, False, Unknown.

  - **conditions.type** (string), required

    Type of deployment condition.

  - **conditions.lastTransitionTime** (Time)

    Last time the condition transitioned from one status to another.

    *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.*

  - **conditions.lastUpdateTime** (Time)

    The last time this condition was updated.

    *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.*

  - **conditions.message** (string)

    A human readable message indicating details about the transition.

  - **conditions.reason** (string)

    The reason for the condition's last transition.

- **observedGeneration** (int64)

  The generation observed by the deployment controller.

## DeploymentList {#DeploymentList}

DeploymentList is a list of Deployments.

- **apiVersion**: apps/v1

- **kind**: DeploymentList

- **metadata** (ListMeta)

  Standard list metadata.

- **items** ([]Deployment), required

  Items is the list of Deployments.

## Operations {#Operations}

### `get` read the specified Deployment

#### HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the Deployment

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (Deployment): OK

401: Unauthorized

### `get` read status of the specified Deployment

#### HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the Deployment

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (Deployment): OK

401: Unauthorized

### `list` list or watch objects of kind Deployment

#### HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/deployments

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (DeploymentList): OK

401: Unauthorized

### `list` list or watch objects of kind Deployment

#### HTTP Request

GET /apis/apps/v1/deployments

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (DeploymentList): OK

401: Unauthorized

### `create` create a Deployment

#### HTTP Request

POST /apis/apps/v1/namespaces/{namespace}/deployments

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: Deployment, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Deployment): OK

201 (Deployment): Created

202 (Deployment): Accepted

401: Unauthorized

### `update` replace the specified Deployment

#### HTTP Request

PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the Deployment

- **namespace** (*in path*): string, required

  namespace

- **body**: Deployment, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Deployment): OK

201 (Deployment): Created

401: Unauthorized

### `update` replace status of the specified Deployment

#### HTTP Request

PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the Deployment

- **namespace** (*in path*): string, required

  namespace

- **body**: Deployment, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Deployment): OK

201 (Deployment): Created

401: Unauthorized

### `patch` partially update the specified Deployment

#### HTTP Request

PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the Deployment

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (Deployment): OK

201 (Deployment): Created

401: Unauthorized

### `patch` partially update status of the specified Deployment

#### HTTP Request

PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the Deployment

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (Deployment): OK

201 (Deployment): Created

401: Unauthorized

### `delete` delete a Deployment

#### HTTP Request

DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the Deployment

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of Deployment

#### HTTP Request

DELETE /apis/apps/v1/namespaces/{namespace}/deployments

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   apps v1    import   k8s io api apps v1    kind   Deployment  content type   api reference  description   Deployment enables declarative updates for Pods and ReplicaSets   title   Deployment  weight  6 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  apps v1    import  k8s io api apps v1        Deployment   Deployment   Deployment enables declarative updates for Pods and ReplicaSets    hr       apiVersion    apps v1       kind    Deployment       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      spec     a href    DeploymentSpec  a      Specification of the desired behavior of the Deployment       status     a href    DeploymentStatus  a      Most recently observed status of the Deployment          DeploymentSpec   DeploymentSpec   DeploymentSpec is the specification of the desired behavior of the Deployment    hr       selector     a href    LabelSelector  a    required    Label selector for pods  Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment  It must match the pod template s labels       template     a href    PodTemplateSpec  a    required    Template describes the pods that will be created  The only allowed template spec restartPolicy value is  Always        replicas    int32     Number of desired pods  This is a pointer to distinguish between explicit zero and not specified  Defaults to 1       minReadySeconds    int32     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       strategy    DeploymentStrategy      Patch strategy  retainKeys       The deployment strategy to use to replace existing pods with new ones      a name  DeploymentStrategy    a     DeploymentStrategy describes how to replace existing pods with new ones          strategy type    string       Type of deployment  Can be  Recreate  or  RollingUpdate   Default is RollingUpdate         strategy rollingUpdate    RollingUpdateDeployment       Rolling update config params  Present only if DeploymentStrategyType   RollingUpdate        a name  RollingUpdateDeployment    a       Spec to control the desired behavior of rolling update            strategy rollingUpdate maxSurge    IntOrString         The maximum number of pods that can be scheduled above the desired number of pods  Value can be an absolute number  ex  5  or a percentage of desired pods  ex  10    This can not be 0 if MaxUnavailable is 0  Absolute number is calculated from percentage by rounding up  Defaults to 25   Example  when this is set to 30   the new ReplicaSet can be scaled up immediately when the rolling update starts  such that the total number of old and new pods do not exceed 130  of desired pods  Once old pods have been killed  new ReplicaSet can be scaled up further  ensuring that total number of pods running at any time during the update is at most 130  of desired pods          a name  IntOrString    a         IntOrString is a type that can hold an int32 or a string   When used in JSON or YAML marshalling and unmarshalling  it produces or consumes the inner type   This allows you to have  for example  a JSON field that can accept a name or number            strategy rollingUpdate maxUnavailable    IntOrString         The maximum number of pods that can be unavailable during the update  Value can be an absolute number  ex  5  or a percentage of desired pods  ex  10    Absolute number is calculated from percentage by rounding down  This can not be 0 if MaxSurge is 0  Defaults to 25   Example  when this is set to 30   the old ReplicaSet can be scaled down to 70  of desired pods immediately when the rolling update starts  Once new pods are ready  old ReplicaSet can be scaled down further  followed by scaling up the new ReplicaSet  ensuring that the total number of pods available at all times during the update is at least 70  of desired pods          a name  IntOrString    a         IntOrString is a type that can hold an int32 or a string   When used in JSON or YAML marshalling and unmarshalling  it produces or consumes the inner type   This allows you to have  for example  a JSON field that can accept a name or number        revisionHistoryLimit    int32     The number of old ReplicaSets to retain to allow rollback  This is a pointer to distinguish between explicit zero and not specified  Defaults to 10       progressDeadlineSeconds    int32     The maximum time in seconds for a deployment to make progress before it is considered to be failed  The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status  Note that progress will not be estimated during the time a deployment is paused  Defaults to 600s       paused    boolean     Indicates that the deployment is paused          DeploymentStatus   DeploymentStatus   DeploymentStatus is the most recently observed status of the Deployment    hr       replicas    int32     Total number of non terminated pods targeted by this deployment  their labels match the selector        availableReplicas    int32     Total number of available pods  ready for at least minReadySeconds  targeted by this deployment       readyReplicas    int32     readyReplicas is the number of pods targeted by this Deployment with a Ready Condition       unavailableReplicas    int32     Total number of unavailable pods targeted by this deployment  This is the total number of pods that are still required for the deployment to have 100  available capacity  They may either be pods that are running but not yet available or pods that still have not been created       updatedReplicas    int32     Total number of non terminated pods targeted by this deployment that have the desired template spec       collisionCount    int32     Count of hash collisions for the Deployment  The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet       conditions      DeploymentCondition      Patch strategy  merge on key  type         Map  unique values on key type will be kept during a merge       Represents the latest available observations of a deployment s current state      a name  DeploymentCondition    a     DeploymentCondition describes the state of a deployment at a certain point          conditions status    string   required      Status of the condition  one of True  False  Unknown         conditions type    string   required      Type of deployment condition         conditions lastTransitionTime    Time       Last time the condition transitioned from one status to another        a name  Time    a       Time is a wrapper around time Time which supports correct marshaling to YAML and JSON   Wrappers are provided for many of the factory methods that the time package offers          conditions lastUpdateTime    Time       The last time this condition was updated        a name  Time    a       Time is a wrapper around time Time which supports correct marshaling to YAML and JSON   Wrappers are provided for many of the factory methods that the time package offers          conditions message    string       A human readable message indicating details about the transition         conditions reason    string       The reason for the condition s last transition       observedGeneration    int64     The generation observed by the deployment controller          DeploymentList   DeploymentList   DeploymentList is a list of Deployments    hr       apiVersion    apps v1       kind    DeploymentList       metadata     a href    ListMeta  a      Standard list metadata       items       a href    Deployment  a    required    Items is the list of Deployments          Operations   Operations      hr             get  read the specified Deployment       HTTP Request  GET  apis apps v1 namespaces  namespace  deployments  name        Parameters       name     in path    string  required    name of the Deployment       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Deployment  a    OK  401  Unauthorized        get  read status of the specified Deployment       HTTP Request  GET  apis apps v1 namespaces  namespace  deployments  name  status       Parameters       name     in path    string  required    name of the Deployment       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Deployment  a    OK  401  Unauthorized        list  list or watch objects of kind Deployment       HTTP Request  GET  apis apps v1 namespaces  namespace  deployments       Parameters       namespace     in path    string  required     a href    namespace  a        allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    DeploymentList  a    OK  401  Unauthorized        list  list or watch objects of kind Deployment       HTTP Request  GET  apis apps v1 deployments       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    DeploymentList  a    OK  401  Unauthorized        create  create a Deployment       HTTP Request  POST  apis apps v1 namespaces  namespace  deployments       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    Deployment  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Deployment  a    OK  201   a href    Deployment  a    Created  202   a href    Deployment  a    Accepted  401  Unauthorized        update  replace the specified Deployment       HTTP Request  PUT  apis apps v1 namespaces  namespace  deployments  name        Parameters       name     in path    string  required    name of the Deployment       namespace     in path    string  required     a href    namespace  a        body     a href    Deployment  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Deployment  a    OK  201   a href    Deployment  a    Created  401  Unauthorized        update  replace status of the specified Deployment       HTTP Request  PUT  apis apps v1 namespaces  namespace  deployments  name  status       Parameters       name     in path    string  required    name of the Deployment       namespace     in path    string  required     a href    namespace  a        body     a href    Deployment  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Deployment  a    OK  201   a href    Deployment  a    Created  401  Unauthorized        patch  partially update the specified Deployment       HTTP Request  PATCH  apis apps v1 namespaces  namespace  deployments  name        Parameters       name     in path    string  required    name of the Deployment       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Deployment  a    OK  201   a href    Deployment  a    Created  401  Unauthorized        patch  partially update status of the specified Deployment       HTTP Request  PATCH  apis apps v1 namespaces  namespace  deployments  name  status       Parameters       name     in path    string  required    name of the Deployment       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Deployment  a    OK  201   a href    Deployment  a    Created  401  Unauthorized        delete  delete a Deployment       HTTP Request  DELETE  apis apps v1 namespaces  namespace  deployments  name        Parameters       name     in path    string  required    name of the Deployment       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of Deployment       HTTP Request  DELETE  apis apps v1 namespaces  namespace  deployments       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized