ReplicaSet

    apiVersion: apps/v1

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

    ReplicaSet ensures that a specified number of pod replicas are running at any given time.


    • apiVersion: apps/v1

    • kind: ReplicaSet

    • spec (ReplicaSetSpec)

      Spec defines the specification of the desired behavior of the ReplicaSet. More info:

    • status (ReplicaSetStatus)

      Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info:

    ReplicaSetSpec is the specification of a ReplicaSet.


    • selector (LabelSelector), required

      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:

    • template (PodTemplateSpec)

      Template is the object that describes the pod that will be created if insufficient replicas are detected. More info:

    • 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)

    ReplicaSetStatus represents the current status of a ReplicaSet.


    • replicas (int32), required

      Replicas is the most recently oberved number of replicas. More info:

    • availableReplicas (int32)

      The number of available replicas (ready for at least minReadySeconds) for this replica set.

    • readyReplicas (int32)

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

    • fullyLabeledReplicas (int32)

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

    • conditions ([]ReplicaSetCondition)

      Patch strategy: merge on key type

      Represents the latest available observations of a replica set’s current state.

      ReplicaSetCondition describes the state of a replica set at a certain point.

      • conditions.status (string), required

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

      • conditions.type (string), required

        Type of replica set 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 ReplicaSet.

    ReplicaSetList is a collection of ReplicaSets.


    • apiVersion: apps/v1

    • kind: ReplicaSetList

    • metadata (ListMeta)

      Standard list metadata. More info:

    • items ([]ReplicaSet), required

      List of ReplicaSets. More info:


    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ReplicaSet

    • namespace (in path): string, required

      namespace

    • pretty (in query): string

    Response

    200 (): OK

    401: Unauthorized

    get read status of the specified ReplicaSet

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ReplicaSet

    • namespace (in path): string, required

    • pretty (in query): string

      pretty

    Response

    200 (ReplicaSet): OK

    401: Unauthorized

    list or watch objects of kind ReplicaSet

    HTTP Request

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

    Parameters

    • namespace (in path): string, required

      namespace

    • allowWatchBookmarks (in query): boolean

    • continue (in query): string

      continue

    • fieldSelector (in query): string

    • labelSelector (in query): string

      labelSelector

    • limit (in query): integer

    • pretty (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • timeoutSeconds (in query): integer

      timeoutSeconds

    • watch (in query): boolean

    Response

    200 (): OK

    401: Unauthorized

    HTTP Request

    GET /apis/apps/v1/replicasets

    Parameters

    • allowWatchBookmarks (in query): boolean

      allowWatchBookmarks

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • timeoutSeconds (in query): integer

      timeoutSeconds

    • watch (in query): boolean

    Response

    200 (): OK

    401: Unauthorized

    create create a ReplicaSet

    HTTP Request

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

    Parameters

    • namespace (in path): string, required

    • body: ReplicaSet, required

    • dryRun (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    201 (ReplicaSet): Created

    202 (): Accepted

    401: Unauthorized

    update replace the specified ReplicaSet

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ReplicaSet

    • namespace (in path): string, required

    • body: ReplicaSet, required

    • dryRun (in query): string

    • fieldManager (in query): string

      fieldManager

    • fieldValidation (in query): string

    • pretty (in query): string

      pretty

    Response

    200 (ReplicaSet): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ReplicaSet

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    401: Unauthorized

    patch partially update the specified ReplicaSet

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ReplicaSet

    • namespace (in path): string, required

    • body: Patch, required

    • dryRun (in query): string

    • fieldManager (in query): string

      fieldManager

    • fieldValidation (in query): string

    • force (in query): boolean

      force

    • pretty (in query): string

    Response

    200 (): OK

    201 (ReplicaSet): Created

    401: Unauthorized

    patch partially update status of the specified ReplicaSet

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ReplicaSet

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (ReplicaSet): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ReplicaSet

    • namespace (in path): string, required

      namespace

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (Status): Accepted

    401: Unauthorized

    delete collection of ReplicaSet

    HTTP Request

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

    Parameters

    • namespace (in path): string, required

      namespace

    • body:

    • continue (in query): string

      continue

    • dryRun (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • gracePeriodSeconds (in query): integer

    • labelSelector (in query): string

      labelSelector

    • limit (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    Response

    200 (): OK

    Last modified December 08, 2021 at 9:34 AM PST: Reference docs for kubernetes 1.23 (02445930e5)