website/docs/api-reference/v1.5/documents/_generated_replicationcontroller_v1_concept.md

---

ReplicationController v1

bdocs-tab:kubectl ReplicationController Config to run 3 nginx instances.

apiVersion: v1
kind: ReplicationController
metadata:
  # Unique key of the ReplicationController instance
  name: replicationcontroller-example
spec:
  # 3 Pods should exist at all times.
  replicas: 3
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      # Run the nginx image
      - name: nginx
        image: nginx:1.10

bdocs-tab:curl ReplicationController Config to run 3 nginx instances.

apiVersion: v1
kind: ReplicationController
metadata:
  # Unique key of the ReplicationController instance
  name: replicationcontroller-example
spec:
  # 3 Pods should exist at all times.
  replicas: 3
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      # Run the nginx image
      - name: nginx
        image: nginx:1.10

Group	Version	Kind
Core	v1	ReplicationController

In many cases it is recommended to create a Deployment instead of a ReplicationController.

ReplicationController represents the configuration of a replication controller.

Appears In ReplicationControllerList

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec ReplicationControllerSpec	Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

ReplicationControllerSpec v1

Appears In ReplicationController

Field	Description
minReadySeconds integer	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)
replicas integer	Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller
selector object	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: http://kubernetes.io/docs/user-guide/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. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

ReplicationControllerStatus v1

Appears In ReplicationController

Field	Description
availableReplicas integer	The number of available replicas (ready for at least minReadySeconds) for this replication controller.
conditions ReplicationControllerCondition array	Represents the latest available observations of a replication controller's current state.
fullyLabeledReplicas integer	The number of pods that have labels matching the labels of the pod template of the replication controller.
observedGeneration integer	ObservedGeneration reflects the generation of the most recently observed replication controller.
readyReplicas integer	The number of ready replicas for this replication controller.
replicas integer	Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

ReplicationControllerList v1

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ReplicationController array	List of replication controllers. More info: http://kubernetes.io/docs/user-guide/replication-controller
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

create a ReplicationController

HTTP Request

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

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body ReplicationController

Response

Code	Description
200 ReplicationController	OK

Replace

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

replace the specified ReplicationController

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the ReplicationController
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body ReplicationController

Response

Code	Description
200 ReplicationController	OK

Patch

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

partially update the specified ReplicationController

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the ReplicationController
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body Patch

Response

Code	Description
200 ReplicationController	OK

Delete

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

delete a ReplicationController

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the ReplicationController
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.

Body Parameters

Parameter	Description
body DeleteOptions

Response

Code	Description
200 Status	OK

Delete Collection

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

delete collection of ReplicationController

HTTP Request

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

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Status	OK

Read Operations

See supported operations below...

Read

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

read the specified ReplicationController

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the ReplicationController
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
export	Should this value be exported. Export strips fields that a user can not specify.

Response

Code	Description
200 ReplicationController	OK

List

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

list or watch objects of kind ReplicationController

HTTP Request

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

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 ReplicationControllerList	OK

List All Namespaces

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

list or watch objects of kind ReplicationController

HTTP Request

GET /api/v1/replicationcontrollers

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 ReplicationControllerList	OK

Watch

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

watch changes to an object of kind ReplicationController

HTTP Request

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

Path Parameters

Parameter	Description
name	name of the ReplicationController
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Event	OK

Watch List All Namespaces

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

watch individual changes to a list of ReplicationController

HTTP Request

GET /api/v1/watch/replicationcontrollers

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Event	OK