22 KiB

Raw Blame History

StatefulSet v1beta1

Group	Version	Kind
Apps	v1beta1	StatefulSet

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

Network: A single stable DNS and hostname.
Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

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
spec StatefulSetSpec	Spec defines the desired identities of pods in this set.
status StatefulSetStatus	Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

StatefulSetSpec v1beta1

Field	Description
replicas integer	Replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
selector LabelSelector	Selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
serviceName string	ServiceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template PodTemplateSpec	Template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates PersistentVolumeClaim array	VolumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

StatefulSetStatus v1beta1

Field	Description
observedGeneration integer	most recent generation observed by this autoscaler.
replicas integer	Replicas is the number of actual replicas.

StatefulSetList v1beta1

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 StatefulSet array
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

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 StatefulSet

HTTP Request

POST /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

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 StatefulSet

Response

Code	Description
200 StatefulSet	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 StatefulSet

HTTP Request

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter	Description
name	name of the StatefulSet
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 StatefulSet

Response

Code	Description
200 StatefulSet	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 StatefulSet

HTTP Request

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter	Description
name	name of the StatefulSet
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 StatefulSet	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 StatefulSet

HTTP Request

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter	Description
name	name of the StatefulSet
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 StatefulSet

HTTP Request

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

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 StatefulSet

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter	Description
name	name of the StatefulSet
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 StatefulSet	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 StatefulSet

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

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 StatefulSetList	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 StatefulSet

HTTP Request

GET /apis/apps/v1beta1/statefulsets

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 StatefulSetList	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 StatefulSet

HTTP Request

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}

Path Parameters

Parameter	Description
name	name of the StatefulSet
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

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 StatefulSet

HTTP Request

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets

Path Parameters

Parameter	Description
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 StatefulSet

HTTP Request

GET /apis/apps/v1beta1/watch/statefulsets

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

Status Operations

See supported operations below...

Patch Status

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 status of the specified StatefulSet

HTTP Request

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

Path Parameters

Parameter	Description
name	name of the StatefulSet
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 StatefulSet	OK

Read Status

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 status of the specified StatefulSet

HTTP Request

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

Path Parameters

Parameter	Description
name	name of the StatefulSet
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.

Response

Code	Description
200 StatefulSet	OK

Replace Status

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 status of the specified StatefulSet

HTTP Request

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

Path Parameters

Parameter	Description
name	name of the StatefulSet
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 StatefulSet

Response

Code	Description
200 StatefulSet	OK

22 KiB Raw Blame History

StatefulSet v1beta1

StatefulSetSpec v1beta1

StatefulSetStatus v1beta1

StatefulSetList v1beta1

Write Operations

Create

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Replace

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Patch

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Delete

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Delete Collection

HTTP Request

Path Parameters

Query Parameters

Response

Read Operations

Read

HTTP Request

Path Parameters

Query Parameters

Response

List

HTTP Request

Path Parameters

Query Parameters

Response

List All Namespaces

HTTP Request

Query Parameters

Response

Watch

HTTP Request

Path Parameters

Query Parameters

Response

Watch List

HTTP Request

Path Parameters

Query Parameters

Response

Watch List All Namespaces

HTTP Request

Query Parameters

Response

Status Operations

Patch Status

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Read Status

HTTP Request

Path Parameters

Query Parameters

Response

Replace Status

HTTP Request

Path Parameters

Query Parameters

22 KiB

Raw Blame History