Chapter 16. ReplicaSet [apps/v1]
- Description
- ReplicaSet ensures that a specified number of pod replicas are running at any given time.
- Type
-
object
16.1. Specification
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| ReplicaSetSpec is the specification of a ReplicaSet. |
|
|
| ReplicaSetStatus represents the current status of a ReplicaSet. |
16.1.1. .spec
- Description
- ReplicaSetSpec is the specification of a ReplicaSet.
- Type
-
object - Required
-
selector
-
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 |
|
| Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
| Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
16.1.2. .status
- Description
- ReplicaSetStatus represents the current status of a ReplicaSet.
- Type
-
object - Required
-
replicas
-
| Property | Type | Description |
|---|---|---|
|
|
| The number of available replicas (ready for at least minReadySeconds) for this replica set. |
|
|
| Represents the latest available observations of a replica set’s current state. |
|
|
| ReplicaSetCondition describes the state of a replica set at a certain point. |
|
|
| The number of pods that have labels matching the labels of the pod template of the replicaset. |
|
|
| ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
|
|
| readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition. |
|
|
| Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
16.1.3. .status.conditions
- Description
- Represents the latest available observations of a replica set’s current state.
- Type
-
array
16.1.4. .status.conditions[]
- Description
- ReplicaSetCondition describes the state of a replica set at a certain point.
- Type
-
object - Required
-
type -
status
-
| Property | Type | Description |
|---|---|---|
|
| The last time the condition transitioned from one status to another. | |
|
|
| A human readable message indicating details about the transition. |
|
|
| The reason for the condition’s last transition. |
|
|
| Status of the condition, one of True, False, Unknown. |
|
|
| Type of replica set condition. |
16.2. API endpoints
The following API endpoints are available:
/apis/apps/v1/replicasets-
GET: list or watch objects of kind ReplicaSet
-
/apis/apps/v1/watch/replicasets-
GET: watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/apps/v1/namespaces/{namespace}/replicasets-
DELETE: delete collection of ReplicaSet -
GET: list or watch objects of kind ReplicaSet -
POST: create a ReplicaSet
-
/apis/apps/v1/watch/namespaces/{namespace}/replicasets-
GET: watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}-
DELETE: delete a ReplicaSet -
GET: read the specified ReplicaSet -
PATCH: partially update the specified ReplicaSet -
PUT: replace the specified ReplicaSet
-
/apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}-
GET: watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status-
GET: read status of the specified ReplicaSet -
PATCH: partially update status of the specified ReplicaSet -
PUT: replace status of the specified ReplicaSet
-
16.2.1. /apis/apps/v1/replicasets
- HTTP method
-
GET - Description
- list or watch objects of kind ReplicaSet
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
16.2.2. /apis/apps/v1/watch/replicasets
- HTTP method
-
GET - Description
- watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
16.2.3. /apis/apps/v1/namespaces/{namespace}/replicasets
- HTTP method
-
DELETE - Description
- delete collection of ReplicaSet
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list or watch objects of kind ReplicaSet
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a ReplicaSet
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
16.2.4. /apis/apps/v1/watch/namespaces/{namespace}/replicasets
- HTTP method
-
GET - Description
- watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
16.2.5. /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ReplicaSet |
- HTTP method
-
DELETE - Description
- delete a ReplicaSet
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified ReplicaSet
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified ReplicaSet
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified ReplicaSet
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
16.2.6. /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ReplicaSet |
- HTTP method
-
GET - Description
- watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
16.2.7. /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ReplicaSet |
- HTTP method
-
GET - Description
- read status of the specified ReplicaSet
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified ReplicaSet
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified ReplicaSet
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
