22 KiB

Raw Blame History

PersistentVolume v1

Group	Version	Kind
Core	v1	PersistentVolume

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes

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	Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec PersistentVolumeSpec	Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes
status PersistentVolumeStatus	Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes

PersistentVolumeSpec v1

Field	Description
accessModes string array	AccessModes contains all ways the volume can be mounted. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes
awsElasticBlockStore AWSElasticBlockStoreVolumeSource	AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
azureDisk AzureDiskVolumeSource	AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFile AzureFileVolumeSource	AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
capacity object	A description of the persistent volume's resources and capacity. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity
cephfs CephFSVolumeSource	CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cinder CinderVolumeSource	Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
claimRef ObjectReference	ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#binding
fc FCVolumeSource	FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume FlexVolumeSource	FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
flocker FlockerVolumeSource	Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
gcePersistentDisk GCEPersistentDiskVolumeSource	GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
glusterfs GlusterfsVolumeSource	Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
hostPath HostPathVolumeSource	HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
iscsi ISCSIVolumeSource	ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
nfs NFSVolumeSource	NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#nfs
persistentVolumeReclaimPolicy string	What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#recycling-policy
photonPersistentDisk PhotonPersistentDiskVolumeSource	PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
quobyte QuobyteVolumeSource	Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd RBDVolumeSource	RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
vsphereVolume VsphereVirtualDiskVolumeSource	VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

PersistentVolumeStatus v1

Field	Description
message string	A human-readable message indicating details about why the volume is in this state.
phase string	Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#phase
reason string	Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

PersistentVolumeList 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 PersistentVolume array	List of persistent volumes. More info: http://kubernetes.io/docs/user-guide/persistent-volumes
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 PersistentVolume

HTTP Request

POST /api/v1/persistentvolumes

Query Parameters

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

Body Parameters

Parameter	Description
body PersistentVolume

Response

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

HTTP Request

PUT /api/v1/persistentvolumes/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolume

Query Parameters

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

Body Parameters

Parameter	Description
body PersistentVolume

Response

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

HTTP Request

PATCH /api/v1/persistentvolumes/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolume

Query Parameters

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

Body Parameters

Parameter	Description
body Patch

Response

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

HTTP Request

DELETE /api/v1/persistentvolumes/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolume

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 PersistentVolume

HTTP Request

DELETE /api/v1/persistentvolumes

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 PersistentVolume

HTTP Request

GET /api/v1/persistentvolumes/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolume

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 PersistentVolume	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 PersistentVolume

HTTP Request

GET /api/v1/persistentvolumes

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 PersistentVolumeList	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 PersistentVolume

HTTP Request

GET /api/v1/watch/persistentvolumes/{name}

Path Parameters

Parameter	Description
name	name of the PersistentVolume

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 PersistentVolume

HTTP Request

GET /api/v1/watch/persistentvolumes

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 PersistentVolume

HTTP Request

PATCH /api/v1/persistentvolumes/{name}/status

Path Parameters

Parameter	Description
name	name of the PersistentVolume

Query Parameters

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

Body Parameters

Parameter	Description
body Patch

Response

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

HTTP Request

GET /api/v1/persistentvolumes/{name}/status

Path Parameters

Parameter	Description
name	name of the PersistentVolume

Query Parameters

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

Response

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

HTTP Request

PUT /api/v1/persistentvolumes/{name}/status

Path Parameters

Parameter	Description
name	name of the PersistentVolume

Query Parameters

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

Body Parameters

Parameter	Description
body PersistentVolume

Response

Code	Description
200 PersistentVolume	OK

22 KiB Raw Blame History

PersistentVolume v1

PersistentVolumeSpec v1

PersistentVolumeStatus v1

PersistentVolumeList v1

Write Operations

Create

HTTP Request

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

Query Parameters

Response

Read Operations

Read

HTTP Request

Path Parameters

Query Parameters

Response

List

HTTP Request

Query Parameters

Response

Watch

HTTP Request

Path Parameters

Query Parameters

Response

Watch List

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

Body Parameters

Response

22 KiB

Raw Blame History