website/content/en/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md

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

apiVersion: v1

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

ReplicationController

ReplicationController represents the configuration of a replication controller.

---

• apiVersion: v1

• kind: ReplicationController

• metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">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 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationControllerSpec" >}}">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 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationControllerStatus" >}}">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 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 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec)

  Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. 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 represents the current status of a replication controller.

---

• replicas (int32), required

  Replicas is the most recently oberved 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

  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 is a collection of replication controllers.

---

• apiVersion: v1

• kind: ReplicationControllerList

• metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)

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

• items ([]<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController), required

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

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

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">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

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">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

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• allowWatchBookmarks (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks

• continue (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue

• fieldSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector

• labelSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector

• limit (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• resourceVersion (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion

• resourceVersionMatch (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch

• timeoutSeconds (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

• watch (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationControllerList" >}}">ReplicationControllerList): OK

401: Unauthorized

list list or watch objects of kind ReplicationController

HTTP Request

GET /api/v1/replicationcontrollers

Parameters

• allowWatchBookmarks (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks

• continue (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue

• fieldSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector

• labelSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector

• limit (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• resourceVersion (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion

• resourceVersionMatch (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch

• timeoutSeconds (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

• watch (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationControllerList" >}}">ReplicationControllerList): OK

401: Unauthorized

create create a ReplicationController

HTTP Request

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

Parameters

• namespace (in path): string, required

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController): OK

201 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController): Created

202 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">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

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController): OK

201 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">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

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController): OK

201 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">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

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• force (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController): OK

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="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• force (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController): OK

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="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• gracePeriodSeconds (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• propagationPolicy (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy

Response

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): Accepted

401: Unauthorized

deletecollection delete collection of ReplicationController

HTTP Request

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

Parameters

• namespace (in path): string, required

  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace

• body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions

• continue (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector

• gracePeriodSeconds (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds

• labelSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector

• limit (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• propagationPolicy (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy

• resourceVersion (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion

• resourceVersionMatch (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch

• timeoutSeconds (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

Response

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

401: Unauthorized