PersistentVolume

PersistentVolume (PV) є ресурсом зберігання, який надається адміністратором. Він аналогічний вузлу. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes

apiVersion: v1

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

PersistentVolume

PersistentVolume (PV) є ресурсом зберігання, який надається адміністратором. Він аналогічний вузлу. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes


ПолеОпис
apiVersion
string
APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
ObjectMeta
Стан стандартних метаданих обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec
PersistentVolumeSpec
spec визначає специфікацію постійного тому, що належить кластеру. Надається адміністратором. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
status
PersistentVolumeStatus
status представляє поточну інформацію/стан постійного тому. Заповнюється системою. Тільки для читання. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes

PersistentVolumeSpec

PersistentVolumeSpec є специфікацією постійного тому.


ПолеОпис
accessModes
string array
accessModes містить всі способи, якими том може бути змонтований. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
awsElasticBlockStore
AWSElasticBlockStoreVolumeSource
awsElasticBlockStore представляє ресурс диска AWS, який підключається до хост-машини kubelet і потім надається поду. Застаріло: AWSElasticBlockStore застарів. Всі операції для типу awsElasticBlockStore перенаправляються до драйвера CSI ebs.csi.aws.com. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azureDisk
AzureDiskVolumeSource
azureDisk представляє монтування диска Azure Data на хості та привʼязку до поду. Застаріло: AzureDisk застарів. Всі операції для типу azureDisk перенаправляються до драйвера CSI disk.csi.azure.com.
azureFile
AzureFilePersistentVolumeSource
azureFile представляє монтування служби Azure File на хості та привʼязку до поду. Застаріло: AzureFile застарів. Всі операції для типу azureFile перенаправляються до драйвера CSI file.csi.azure.com.
capacity
object
capacity є описом ресурсів та ємності постійного тому. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
cephfs
CephFSPersistentVolumeSource
cephFS представляє монтування Ceph FS на хості, яке ділить життєвий цикл поду. Застаріло: CephFS застарів, і тип cephfs більше не підтримується.
cinder
CinderPersistentVolumeSource
cinder представляє том Cinder, підключений і змонтований на хості kubelet. Застаріло: Cinder застарів. Всі операції для типу cinder перенаправляються до драйвера CSI cinder.csi.openstack.org. Детальніше: https://examples.k8s.io/mysql-cinder-pd/README.md
claimRef
ObjectReference
claimRef є частиною двостороннього звʼязку між PersistentVolume та PersistentVolumeClaim. Очікується, що буде ненульовим, коли звʼязок встановлено. claim.VolumeName є авторитетним звʼязком між PV та PVC. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
csi
CSIPersistentVolumeSource
csi представляє сховище, яке обробляється зовнішнім драйвером CSI.
fc
FCVolumeSource
fc представляє ресурс Fibre Channel, який підключається до хост-машини kubelet і потім надається поду.
flexVolume
FlexPersistentVolumeSource
flexVolume представляє загальний ресурс тому, який надається/підключається за допомогою втулка на основі exec. Застаріло: FlexVolume застарів. Розгляньте можливість використання CSIDriver замість цього.
flocker
FlockerVolumeSource
flocker представляє том Flocker, підключений до хост-машини kubelet і наданий поду для використання. Це залежить від того, що служба керування Flocker працює. Застаріло: Flocker застарів, і тип flocker більше не підтримується.
gcePersistentDisk
GCEPersistentDiskVolumeSource
gcePersistentDisk представляє ресурс диска GCE, який підключається до хост-машини kubelet і потім надається поду. Надається адміністратором. Застаріло: GCEPersistentDisk застарів. Всі операції для типу gcePersistentDisk перенаправляються до драйвера CSI pd.csi.storage.gke.io. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
glusterfs
GlusterfsPersistentVolumeSource
glusterfs представляє том Glusterfs, який підключається до хост-машини і надається поду. Надається адміністратором. Застаріло: Glusterfs застарів, і тип glusterfs більше не підтримується. Детальніше: https://examples.k8s.io/volumes/glusterfs/README.md
hostPath
HostPathVolumeSource
hostPath представляє теку на хості. Надається розробником або тестувальником. Це корисно лише для розробки та тестування на одновузловій системі! Зберігання на хості не підтримується і НЕ ПРАЦЮВАТИМЕ в багатовузловому кластері. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
iscsi
ISCSIPersistentVolumeSource
iscsi представляє ресурс диска ISCSI, який підключається до хост-машини kubelet і потім надається поду. Надається адміністратором.
local
LocalVolumeSource
local представляє безпосередньо підключене сховище зі спорідненістю до вузла
mountOptions
string array
mountOptions є списком параметрів монтування, наприклад ["ro", "soft"]. Не перевіряється — монтування просто не вдасться, якщо один з параметрів недійсний. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
nfs
NFSVolumeSource
nfs представляє монтування NFS на хості. Надається адміністратором. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#nfs
nodeAffinity
VolumeNodeAffinity
nodeAffinity визначає обмеження, які обмежують, з яких вузлів цей том може бути доступний. Це поле впливає на планування подів, які використовують цей том. Це поле можна змінювати, якщо увімкнено функціональну можливість MutablePVNodeAffinity.
persistentVolumeReclaimPolicy
string
persistentVolumeReclaimPolicy визначає, що відбувається з постійним томом після його звільнення від заявки. Дійсні варіанти: Retain (стандартно для створених вручну PersistentVolumes), Delete (стандартно для динамічно створених PersistentVolumes) та Recycle (застарілий). Recycle повинен підтримуватися втулком томів, що лежить в основі цього PersistentVolume. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

Можливі значення enum:
  • "Delete" означає, що том буде видалено з Kubernetes після звільнення від його заявки. Втулок томів повинен підтримувати видалення.
  • "Recycle" означає, що том буде перероблено назад у пул невикористаних постійних томів після звільнення від його заявки. Втулок томів повинен підтримувати Recycling.
  • "Retain" означає, що том залишиться у своєму поточному стані (Released) для ручного відновлення адміністратором. Стандартна політика — Retain.
photonPersistentDisk
PhotonPersistentDiskVolumeSource
photonPersistentDisk представляє постійний диск PhotonController, підключений і змонтований на хості kubelets. Застаріло: PhotonPersistentDisk застарів, і внутрішній тип photonPersistentDisk більше не підтримується.
portworxVolume
PortworxVolumeSource
portworxVolume представляє том portworx, підключений і змонтований на хості kubelets. Застаріло: PortworxVolume застарів. Усі операції для внутрішнього типу portworxVolume перенаправляються до драйвера CSI pxd.portworx.com.
quobyte
QuobyteVolumeSource
quobyte представляє монтування Quobyte на хості, яке триває протягом життєвого циклу пода. Застаріло: Quobyte застарів, і внутрішній тип quobyte більше не підтримується.
rbd
RBDPersistentVolumeSource
rbd представляє монтування Rados Block Device на хості, яке триває протягом життєвого циклу пода. Застаріло: RBD застарів, і внутрішній тип rbd більше не підтримується. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md
scaleIO
ScaleIOPersistentVolumeSource
scaleIO представляє постійний том ScaleIO, підключений і змонтований на вузлах Kubernetes. Застаріло: ScaleIO застарів, і внутрішній тип scaleIO більше не підтримується.
storageClassName
string
storageClassName — це назва StorageClass, до якої належить цей постійний том. Порожнє значення означає, що цей том не належить до жодного StorageClass.
storageos
StorageOSPersistentVolumeSource
storageOS представляє том StorageOS, підключений до хост-машини kubelet і змонтований у поді. Застаріло: StorageOS застарів, і внутрішній тип storageos більше не підтримується. Більше інформації: https://examples.k8s.io/volumes/storageos/README.md
volumeAttributesClassName
string
volumeAttributesClassName — це назва VolumeAttributesClass, до якої належить цей постійний том. Порожнє значення не дозволяється. Якщо це поле не встановлено, це означає, що цей том не належить до жодного VolumeAttributesClass. Це поле є змінним і може бути змінене драйвером CSI після успішного оновлення тому до нового класу. Для незвʼязаного PersistentVolume, volumeAttributesClassName буде співставлено з незвʼязаними PersistentVolumeClaims під час процесу звʼязування.
volumeMode
string
volumeMode визначає, чи призначено том для використання з форматованою файловою системою, чи залишити його у стані сирого блоку. Значення Filesystem передбачається, якщо не включено в spec.

Можливі значення enum:
  • "Block" означає, що том не буде форматуватися файловою системою і залишиться сирим блочним пристроєм.
  • "Filesystem" означає, що том буде або вже форматований файловою системою.
vsphereVolume
VsphereVirtualDiskVolumeSource
vsphereVolume представляє vSphere том, підключений і змонтований на хості kubelet. Застаріло: VsphereVolume застарів. Всі операції для внутрішнього типу vsphereVolume перенаправляються до CSI драйвера csi.vsphere.vmware.com.

PersistentVolumeStatus

PersistentVolumeStatus є поточним станом постійного тому.


ПолеОпис
lastPhaseTransitionTime
Time
lastPhaseTransitionTime — це час, коли фаза перейшла з однієї в іншу, і автоматично скидається на поточний час щоразу, коли фаза тому змінюється.
message
string
message є зрозумілим для людини повідомленням, яке вказує деталі про те, чому том знаходиться в цьому стані.
phase
string
phase вказує, чи том доступний, привʼязаний до запиту, або звільнений з запиту. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase

Можливі значення enum:
  • "Available" використовується для PersistentVolumes, які ще не привʼязані. Доступні томи утримуються звʼязувачем і зіставляються з PersistentVolumeClaims
  • "Bound" використовується для PersistentVolumes, які привʼязані
  • "Failed" використовується для PersistentVolumes, які не вдалося правильно переробити або видалити після звільнення з запиту
  • "Pending" використовується для PersistentVolumes, які недоступні
  • "Released" використовується для PersistentVolumes, де привʼязаний PersistentVolumeClaim був видалений. Звільнені томи повинні бути перероблені перед тим, як знову стати доступними. Ця фаза використовується звʼязувачем PersistentVolumeClaim для сигналізації іншому процесу про необхідність повторного захоплення ресурсу
reason
string
reason є коротким рядком у CamelCase, який описує будь-яку помилку і призначений для машинного аналізу та акуратного відображення в CLI.

PersistentVolumeList

PersistentVolumeList є списком елементів PersistentVolume.


ПолеОпис
apiVersion
string
APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
items *
Масив PersistentVolume
items є списком постійних томів. Детальніше: https://kubernetes.io/docs/concepts/storage/persistent-volumes
kind
string
Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
ListMeta
Стандартні метадані списку. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

AWSElasticBlockStoreVolumeSource

Представляє ресурс Persistent Disk в AWS.

Диск AWS EBS повинен існувати перед монтуванням до контейнера. Диск також повинен знаходитися в тій же зоні AWS, що й kubelet. Диск AWS EBS можна монтувати лише як читання/запис один раз. Томи AWS EBS підтримують управління власністю та переназначення SELinux.


ПолеОпис
fsType
string
fsType є типом файлової системи тому, який ви хочете змонтувати. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partition
integer
partition є розділом у томі, який ви хочете змонтувати. Якщо не вказано, зазвичай монтується за іменем тому. Приклади: для тому /dev/sda1 вкажіть розділ як "1". Аналогічно, розділ тому для /dev/sda - "0" (або можна залишити властивість порожньою).
readOnly
boolean
readOnly значення true змусить встановити параметр readOnly у VolumeMounts. Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID *
string
volumeID є унікальним ідентифікатором ресурсу постійного диска в AWS (том Amazon EBS). Детальніше: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

AzureDiskVolumeSource

AzureDisk представляє монтування диска даних Azure на хості та привʼязку до поду.


ПолеОпис
cachingMode
string
cachingMode є режимом кешування хоста: None, Read Only, Read Write.

Можливі значення enum:
  • "None"
  • "ReadOnly"
  • "ReadWrite"
diskName *
string
diskName є імʼям диска даних у сховищі блобів
diskURI *
string
diskURI є URI диска даних у сховищі блобів
fsType
string
fsType є типом файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Якщо не вказано, за замовчуванням використовується "ext4".
kind
string
Очікуваними значеннями kind є
  • Shared: кілька блоб-дисків на обліковий запис зберігання
  • Dedicated: один блоб-диск на обліковий запис зберігання
  • Managed: керований Azure диск даних (тільки в керованому наборі доступності). За замовчуванням використовується shared
Можливі значення enum:
  • "Dedicated"
  • "Managed"
  • "Shared"
readOnly
boolean
readOnly Стандартне значення — false (читання/запис). Якщо встановлено true, це змусить встановити параметр readOnly у VolumeMounts.

AzureFilePersistentVolumeSource

AzureFile представляє монтування Azure File Service на хості та привʼязку до поду.


ПолеОпис
readOnly
boolean
readOnly Стандартне значення — false (читання/запис). Якщо встановлено true, це змусить встановити параметр readOnly у VolumeMounts.
secretName *
string
secretName є імʼям секрету, який містить імʼя облікового запису Azure Storage та ключ
secretNamespace
string
secretNamespace є простором імен секрету, який містить імʼя облікового запису Azure Storage та ключ. Зазвичай використовується той самий простір імен, що й для Pod
shareName *
string
shareName є імʼям спільного ресурсу Azure

CSIPersistentVolumeSource

CSIPersistentVolumeSource представляє сховище, яке керується зовнішнім драйвером CSI.


ПолеОпис
controllerExpandSecretRef
SecretReference
controllerExpandSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI ControllerExpandVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети.
controllerPublishSecretRef
SecretReference
controllerPublishSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI ControllerPublishVolume та ControllerUnpublishVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети.
driver *
string
driver є імʼям драйвера, який використовується для цього тома. Обовʼязково.
fsType
string
fsType для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Напр. "ext4", "xfs", "ntfs".
nodeExpandSecretRef
SecretReference
nodeExpandSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI NodeExpandVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети.
nodePublishSecretRef
SecretReference
nodePublishSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI NodePublishVolume та NodeUnpublishVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети.
nodeStageSecretRef
SecretReference
nodeStageSecretRef є посиланням на обʼєкт секрету, який містить конфіденційну інформацію для передачі драйверу CSI для завершення виклику CSI NodeStageVolume та NodeUnstageVolume. Це поле є опціональним і може бути порожнім, якщо секрет не потрібен. Якщо обʼєкт секрету містить більше одного секрету, передаються всі секрети.
readOnly
boolean
readOnly значення для передачі в ControllerPublishVolumeRequest. За замовчуванням false (читання/запис).
volumeAttributes
object
volumeAttributes тома для публікації.
volumeHandle *
string
volumeHandle є унікальним імʼям тома, яке повертається втулком CSI під час виклику CreateVolume для посилання на том у всіх наступних викликах. Обовʼязково.

CephFSPersistentVolumeSource

Представляє монтування файлової системи Ceph, яке триває протягом життя поду. Томи Cephfs не підтримують управління власністю або переназначення SELinux.


ПолеОпис
monitors *
string array
monitors є обовʼязковим: Monitors є колекцією моніторів Ceph. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
path
string
path є опціональним: Використовується як змонтований корінь, а не повне дерево Ceph, стандартно /
readOnly
boolean
readOnly є опціональним: Зазвичай false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretFile
string
secretFile є опціональним: SecretFile є шляхом до вʼязки ключів користувача, зазвичай /etc/ceph/user.secret. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretRef
SecretReference
secretRef є опціональним: SecretRef є посиланням на обʼєкт секрету для автентифікації користувача, зазвичай порожнє. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
user
string
user є опціональним: User є імʼям користувача rados, за звичай — admin. Більше інформації: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

CinderPersistentVolumeSource

Представляє ресурс тома Cinder в Openstack. Том Cinder повинен існувати перед монтуванням до контейнера. Том також повинен бути в тому ж регіоні, що й kubelet. Томи Cinder підтримують управління власністю та переназначення SELinux.


ПолеОпис
fsType
string
fsType є типом файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md
readOnly
boolean
readOnly є опціональним: Зазвичай false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts. Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md
secretRef
SecretReference
secretRef є опціональним: вказує на обʼєкт секрету, що містить параметри для підключення до OpenStack.
volumeID *
string
volumeID використовується для ідентифікації тому в Cinder. Більше інформації: https://examples.k8s.io/mysql-cinder-pd/README.md

FCVolumeSource

Представляє ресурс тома Fibre Channel. Томи Fibre Channel можна монтувати лише для читання/запису один раз. Томи Fibre Channel підтримують управління власністю та переназначення SELinux.


ПолеОпис
fsType
string
fsType є типом файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4".
lun
integer
lun є опціональним: номер цільового lun для FC
readOnly
boolean
readOnly є опціональним: зазвичай false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts.
targetWWNs
string array
targetWWNs є опціональним: FC вказує всесвітні імена (worldwide names, WWN).
wwids
string array
wwids є опціональним: всесвітні ідентифікатори томів FC (wwids). Потрібно встановити або wwids, або комбінацію targetWWNs і lun, але не обидва одночасно.

FlexPersistentVolumeSource

FlexPersistentVolumeSource представляє загальний ресурс постійного тому, який надається/підключається за допомогою втулка на основі виконуваного файлу.


ПолеОпис
driver *
string
driver є імʼям драйвера, який використовується для цього тому.
fsType
string
fsType є типом файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Зазвичай файлову систему визначає скрипт FlexVolume.
options
object
options є опціональним: це поле містить додаткові параметри команд, якщо вони є.
readOnly
boolean
readOnly є опціональним: зазвичай false (читання/запис). ReadOnly тут примусово встановить параметр ReadOnly у VolumeMounts.
secretRef
SecretReference
secretRef є опціональним: SecretRef є посиланням на обʼєкт секрету, що містить конфіденційну інформацію для передачі скриптам втулка. Це поле може бути порожнім, якщо обʼєкт секрету не вказано. Якщо обʼєкт секрету містить більше одного секрету, всі секрети передаються скриптам плагіна.

FlockerVolumeSource

Представляє том Flocker, змонтований агентом Flocker. Потрібно встановити лише одне з полів datasetName або datasetUUID. Томи Flocker не підтримують управління власністю або переназначення SELinux.


ПолеОпис
datasetName
string
datasetName є імʼям набору даних, збереженого як метадані -> імʼя набору даних для Flocker слід вважати за застаріле
datasetUUID
string
datasetUUID є UUID набору даних. Це унікальний ідентифікатор набору даних Flocker

GCEPersistentDiskVolumeSource

Представляє ресурс Persistent Disk у Google Compute Engine.

Том GCE PD повинен існувати перед монтуванням у контейнер. Диск також повинен знаходитися в тому ж проєкті та зоні GCE, що й kubelet. GCE PD можна монтувати лише як читання/запис один раз або як тільки для читання багато разів. GCE PD підтримує управління власністю та переназначення SELinux.


ПолеОпис
fsType
string
fsType є типом файлової системи для монтування. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, неявно вважається "ext4". Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partition
integer
partition є розділом у томі, який ви хочете змонтувати. Якщо не вказано, зазвичай монтується за іменем тому. Приклади: для тому /dev/sda1 вкажіть розділ як "1". Аналогічно, розділ тому для /dev/sda - "0" (або можна залишити властивість порожньою). Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
pdName *
string
pdName є унікальним імʼям ресурсу PD у GCE. Використовується для ідентифікації диска в GCE. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly
boolean
readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. Зазвичай — false. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

GlusterfsPersistentVolumeSource

Представляє монтування Glusterfs, яке триває протягом життя поду. Томи Glusterfs не підтримують управління власністю або переназначення SELinux.


ПолеОпис
endpoints *
string
endpoints є іменем точки доступу, яка описує топологію Glusterfs. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
endpointsNamespace
string
endpointsNamespace є простором імен, який містить точку доступу Glusterfs. Якщо це поле порожнє, EndpointNamespace зазвичай буде таким самим, як і простір імен привʼязаного PVC. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path *
string
path є шляхом до тому Glusterfs. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnly
boolean
readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. Зазвичай — false. Більше інформації: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

HostPathVolumeSource

Представляє шлях хоста, змонтований у под. Томи HostPath не підтримують управління власністю або переназначення SELinux.


ПолеОпис
path *
string
шлях до теки на хості. Якщо шлях є символічним посиланням, воно буде слідувати до реального шляху. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type
string
type для тома HostPath. Зазвичай порожнє. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

Можливі значення enum:
  • "" Для зворотної сумісності, залиште порожнім, якщо не встановлено
  • "BlockDevice" Блоковий пристрій повинен існувати за вказаним шляхом
  • "CharDevice" Символьний пристрій повинен існувати за вказаним шляхом
  • "Directory" Тека повинна існувати за вказаним шляхом
  • "DirectoryOrCreate" Якщо нічого не існує за вказаним шляхом, буде створена порожня тека з режимом файлу 0755, з тією ж групою та власником, що й Kubelet.
  • "File" Файл повинен існувати за вказаним шляхом
  • "FileOrCreate" Якщо нічого не існує за вказаним шляхом, буде створений порожній файл з режимом файлу 0644, з тією ж групою та власником, що й Kubelet.
  • "Socket" UNIX-сокет повинен існувати за вказаним шляхом

ISCSIPersistentVolumeSource

ISCSIPersistentVolumeSource представляє iSCSI диск. iSCSI томи можна монтувати лише як читання/запис один раз. iSCSI томи підтримують управління власністю та переназначення SELinux.


ПолеОпис
chapAuthDiscovery
boolean
chapAuthDiscovery визначає, чи підтримується автентифікація iSCSI Discovery CHAP
chapAuthSession
boolean
chapAuthSession визначає, чи підтримується автентифікація iSCSI Session CHAP
fsType
string
fsType визначає тип файлової системи тому, який ви хочете змонтувати. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, неявно вважається "ext4". Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName
string
initiatorName визначає користувацьке імʼя ініціатора iSCSI. Якщо initiatorName вказано разом з iscsiInterface, буде створено новий інтерфейс iSCSI <target portal>:\<volume name> для підключення.
iqn *
string
iqn визначає iSCSI Qualified Name цільового пристрою.
iscsiInterface
string
iscsiInterface визначає імʼя інтерфейсу, який використовує iSCSI транспорт. Зазвичай 'default' (tcp).
lun *
integer
lun визначає номер iSCSI Target Lun.
portals
string array
portals визначає список iSCSI Target Portal. Портал може бути або IP-адресою, або ip_addr:port, якщо порт відрізняється від стандартного (зазвичай TCP порти 860 та 3260).
readOnly
boolean
readOnly визначає, чи буде примусово встановлено режим лише для читання в VolumeMounts. Зазвичай — false.
secretRef
SecretReference
secretRef визначає CHAP Secret для автентифікації iSCSI цілі та ініціатора
targetPortal *
string
targetPortal визначає iSCSI Target Portal. Портал може бути або IP-адресою, або ip_addr:port, якщо порт відрізняється від стандартного (зазвичай TCP порти 860 та 3260).

LocalVolumeSource

Local представляє безпосередньо підключене сховище зі спорідненістю до вузла


ПолеОпис
fsType
string
fsType визначає тип файлової системи тому, який ви хочете змонтувати. Застосовується лише тоді, коли Path є блочним пристроєм. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Стандартно — автоматичний вибір файлової системи, якщо не вказано.
path *
string
path визначає повний шлях до тому на вузлі. Це може бути або тека, або блочний пристрій (диск, розділ тощо).

NFSVolumeSource

Представляє NFS монтування, яке триває протягом життя поду. NFS томи не підтримують управління власністю або переназначення SELinux.


ПолеОпис
path *
string
path визначає шлях, який експортується NFS сервером. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnly
boolean
readOnly визначає, чи буде примусово встановлено режим лише для читання при монтуванні NFS експорту. Стандартно — false. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#nfs
server *
string
server визначає імʼя хоста або IP-адресу NFS сервера. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#nfs

PhotonPersistentDiskVolumeSource

Представляє ресурс постійного диска Photon Controller.


ПолеОпис
fsType
string
fsType визначає тип файлової системи тому, який ви хочете змонтувати. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Стандартно — автоматичний вибір файлової системи, якщо не вказано.
pdID *
string
pdID визначає ідентифікатор постійного диска Photon Controller

PortworxVolumeSource

PortworxVolumeSource представляє ресурс тому Portworx.


ПолеОпис
fsType
string
fsType визначає тип файлової системи тому, який ви хочете змонтувати. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs". Стандартно — автоматичний вибір файлової системи, якщо не вказано.
readOnly
boolean
readOnly визначає, чи буде примусово встановлено режим лише для читання при монтуванні тому. Стандартно — false. Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#portworx
volumeID *
string
volumeID визначає унікальний ідентифікатор тому Portworx

QuobyteVolumeSource

Представляє Quobyte монтування, яке триває протягом життя поду. Quobyte томи не підтримують управління власністю або переназначення SELinux.


ПолеОпис
group
string
group для відображення доступу до тому. Стандартно — група не вказана.
readOnly
boolean
readOnly визначає, чи буде примусово встановлено режим лише для читання при монтуванні Quobyte тому. Стандартно — false.
registry *
string
registry представляє один або кілька сервісів Quobyte Registry, вказаних як рядок у форматі host:port (кілька записів розділяються комами), який виступає центральним реєстром для томів
tenant
string
tenant визначає власника даного Quobyte тому в бекенді. Використовується з динамічно створеними Quobyte томами, значення встановлюється плагіном
user
string
user для відображення доступу до тому. Стандартно — користувач облікового запису сервісу.
volume *
string
volume визначає рядок, який посилається на вже створений Quobyte том за назвою.

RBDPersistentVolumeSource

Представляє монтування Rados Block Device, яке триває протягом життя поду. RBD томи підтримують управління власністю та переназначення SELinux.


ПолеОпис
fsType
string
fsType визначає тип файлової системи тому, який ви хочете змонтувати. Порада: переконайтеся, що тип файлової системи підтримується операційною системою хоста. Приклади: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4". Більше інформації: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image *
string
image визначає назву rados image. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
keyring
string
keyring визначає шлях до key ring для RBDUser. Зазвичай /etc/ceph/keyring. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitors *
string array
monitors визначає колекцію Ceph моніторів. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool
string
pool визначає назву rados pool. Зазвичай використовується rbd. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
readOnly
boolean
readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts. За замовчуванням false. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
secretRef
SecretReference
secretRef визначає назву секрету для автентифікації RBDUser. Якщо вказано, перевизначає keyring. За замовчуванням nil. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
user
string
user визначає імʼя користувача rados. За замовчуванням admin. Більше інформації: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

ScaleIOPersistentVolumeSource

ScaleIOPersistentVolumeSource представляє постійний том ScaleIO


ПолеОпис
fsType
string
fsType визначає тип файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Зазвичай "xfs"
gateway *
string
gateway визначає адресу хоста ScaleIO API Gateway.
protectionDomain
string
protectionDomain визначає назву ScaleIO Protection Domain для налаштованого сховища.
readOnly
boolean
readOnly зазвичай — false (читання/запис). readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts.
secretRef *
SecretReference
secretRef визначає секрет для користувача ScaleIO та іншої конфіденційної інформації. Якщо не вказано, операція входу завершиться невдачею.
sslEnabled
boolean
sslEnabled визначає прапорець для увімкнення/вимкнення SSL-зʼєднання з Gateway, зазвичай — false.
storageMode
string
storageMode визначає, чи має сховище для тому бути ThickProvisioned або ThinProvisioned. Зазвичай — ThinProvisioned.
storagePool
string
storagePool визначає пул сховища ScaleIO, повʼязаний із доменом захисту.
system *
string
system визначає назву системи зберігання, як налаштовано в ScaleIO.
volumeName
string
volumeName визначає назву тому, який вже створено в системі ScaleIO і який повʼязаний із цим джерелом тому.

SecretReference

SecretReference представляє Secret Reference. Містить достатньо інформації для отримання секрету в будь-якому просторі імен.


ПолеОпис
name
string
name є унікальним у межах простору імен для посилання на ресурс секрету.
namespace
string
namespace визначає простір, у межах якого імʼя секрету має бути унікальним.

StorageOSPersistentVolumeSource

Представляє ресурс постійного тому StorageOS.


ПолеОпис
fsType
string
fsType визначає тип файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Зазвичай "ext4"
readOnly
boolean
readOnly зазвичай — false (читання/запис). readOnly тут примусово встановлює параметр ReadOnly у VolumeMounts.
secretRef
ObjectReference
secretRef визначає секрет для отримання облікових даних API StorageOS. Якщо не вказано, будуть використані стандартнізначення.
volumeName
string
volumeName є зрозумілим для людини імʼям тому StorageOS. Імена томів унікальні лише в межах простору імен.
volumeNamespace
string
volumeNamespace визначає область дії тому в межах StorageOS. Якщо простір імен не вказано, буде використано простір імен Pod. Це дозволяє відобразити область дії імен Kubernetes у StorageOS для більш тісної інтеграції. Встановіть VolumeName на будь-яке імʼя, щоб перевизначити стандартну поведінку. Встановіть "default", якщо ви не використовуєте простори імен у StorageOS. Простори імен, які не існують у StorageOS, будуть створені.

VolumeNodeAffinity

VolumeNodeAffinity визначає обмеження, які обмежують, з яких вузлів можна отримати доступ до цього тому.


ПолеОпис
required
NodeSelector
required визначає жорсткі обмеження для вузлів, які повинні бути виконані.

VsphereVirtualDiskVolumeSource

Представляє ресурс тому vSphere.


ПолеОпис
fsType
string
fsType визначає тип файлової системи для монтування. Повинно бути типом файлової системи, підтримуваним операційною системою хоста. Наприклад: "ext4", "xfs", "ntfs". Якщо не вказано, зазвичай використовується "ext4".
storagePolicyID
string
storagePolicyID є ідентифікатором профілю управління політиками зберігання (SPBM), повʼязаного з StoragePolicyName.
storagePolicyName
string
storagePolicyName є імʼям профілю управління політиками зберігання (SPBM).
volumePath *
string
volumePath визначає шлях, який ідентифікує vSphere том vmdk.

Операції


post Create

HTTP Запит

POST /api/v1/persistentvolumes

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
dryRunstringКоли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
  • All: всі етапи dry run будуть виконані
fieldManagerstringfieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint.
fieldValidationstringfieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
  • Ignore: Ігнорує всі невідомі поля, які без попередження видаляються з обʼєкта, а також ігнорує всі дублікати полів, крім останнього, на які натрапляє декодер. Це стандартна поведінка до v1.23.
  • Warn: Надсилає попередження через стандартний заголовок відповіді для кожного невідомого поля, яке видаляється з обʼєкта, і для кожного дубльованого поля, яке зустрічається. Запит все ще буде успішним, якщо немає інших помилок, і буде зберігатися лише останнє з будь-яких дубльованих полів. Це стандартна поведінка у v1.23+
  • Strict: У цьому випадку запит завершиться з помилкою BadRequest, якщо з обʼєкта будуть вилучені невідомі поля або якщо будуть виявлені дублікати полів. Помилка, що повертається сервером, міститиме всі виявлені невідомі та дубльовані поля.

Параметри тіла запиту

НазваТипОпис
bodyPersistentVolume

Відповідь

СтатусОписВідповідь
200OKPersistentVolume
201CreatedPersistentVolume
202AcceptedPersistentVolume

patch Patch

HTTP Запит

PATCH /api/v1/persistentvolumes/{name}

Параметри шляху

НазваТипОпис
namestringНазва PersistentVolume

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
dryRunstringКоли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
  • All: всі етапи dry run будуть виконані
fieldManagerstringfieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле обовʼязкове для запитів apply (application/apply-patch), але необовʼязкове для типів патчів, що не застосовуються (JsonPatch, MergePatch, StrategicMergePatch).
fieldValidationstringfieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
  • Ignore: Ігнорує всі невідомі поля, які без попередження видаляються з обʼєкта, а також ігнорує всі дублікати полів, крім останнього, на які натрапляє декодер. Це стандартна поведінка до v1.23.
  • Warn: Надсилає попередження через стандартний заголовок відповіді для кожного невідомого поля, яке видаляється з обʼєкта, і для кожного дубльованого поля, яке зустрічається. Запит все ще буде успішним, якщо немає інших помилок, і буде зберігатися лише останнє з будь-яких дубльованих полів. Це стандартна поведінка у v1.23+
  • Strict: У цьому випадку запит завершиться з помилкою BadRequest, якщо з обʼєкта будуть вилучені невідомі поля або якщо будуть виявлені дублікати полів. Помилка, що повертається сервером, міститиме всі виявлені невідомі та дубльовані поля.
forcebooleanForce має на меті "примусово" застосовувати запити Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим користувачам. Прапорець Force повинен бути скасований для запитів, що не є патчами apply.

Параметри тіла запиту

НазваТипОпис
bodyPatch

Відповідь

СтатусОписВідповідь
200OKPersistentVolume
201CreatedPersistentVolume

put Replace

HTTP Запит

PUT /api/v1/persistentvolumes/{name}

Параметри шляху

НазваТипОпис
namestringНазва PersistentVolume

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
dryRunstringКоли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
  • All: всі етапи dry run будуть виконані
fieldManagerstringfieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint.
fieldValidationstringfieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
  • Ignore: Ігнорує всі невідомі поля, які без попередження видаляються з обʼєкта, а також ігнорує всі дублікати полів, крім останнього, на які натрапляє декодер. Це стандартна поведінка до v1.23.
  • Warn: Надсилає попередження через стандартний заголовок відповіді для кожного невідомого поля, яке видаляється з обʼєкта, і для кожного дубльованого поля, яке зустрічається. Запит все ще буде успішним, якщо немає інших помилок, і буде зберігатися лише останнє з будь-яких дубльованих полів. Це стандартна поведінка у v1.23+
  • Strict: У цьому випадку запит завершиться з помилкою BadRequest, якщо з обʼєкта будуть вилучені невідомі поля або якщо будуть виявлені дублікати полів. Помилка, що повертається сервером, міститиме всі виявлені невідомі та дубльовані поля.

Параметри тіла запиту

НазваТипОпис
bodyPersistentVolume

Відповідь

СтатусОписВідповідь
200OKPersistentVolume
201CreatedPersistentVolume

delete Delete

HTTP Запит

DELETE /api/v1/persistentvolumes/{name}

Параметри шляху

НазваТипОпис
namestringНазва PersistentVolume

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
dryRunstringКоли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
  • All: всі етапи dry run будуть виконані
gracePeriodSecondsintegerЧасу у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення.
ignoreStoreReadErrorWithClusterBreakingPotentialbooleanЯкщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання.
orphanDependentsbooleanЗастаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва.
propagationPolicystringЧи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій.

Параметри тіла запиту

НазваТипОпис
bodyDeleteOptions

Відповідь

СтатусОписВідповідь
200OKPersistentVolume
202AcceptedPersistentVolume

delete Delete Collection

HTTP Запит

DELETE /api/v1/persistentvolumes

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
continuestringОпція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін.
dryRunstringКоли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
  • All: всі етапи dry run будуть виконані
fieldSelectorstringСелектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти.
gracePeriodSecondsintegerЧасу у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення.
ignoreStoreReadErrorWithClusterBreakingPotentialbooleanЯкщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання.
labelSelectorstringСелектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти.
limitintegerlimit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку.
orphanDependentsbooleanЗастаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва.
propagationPolicystringЧи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій.
resourceVersionstringresourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено
resourceVersionMatchstringresourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено
sendInitialEventsbooleansendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
  • resourceVersionMatch = NotOlderThan інтерпретується як «дані, що є принаймні такими ж новими, як зазначена resourceVersion», і подія bookmark надсилається, коли стан синхронізується з resourceVersion, яка є принаймні такою ж актуальною, як та, що вказана в ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як «послідовне читання», і подія bookmark надсилається, коли стан синхронізується принаймні до моменту, коли почалася обробка запиту.
  • resourceVersionMatch, встановлений на будь-яке інше значення або не встановлений — повертається помилка Invalid. Стандартне значення true, якщо resourceVersion="" або resourceVersion="0" (з міркувань сумісності) і false в іншому випадку.
shardSelectorstringshardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів:
shardRange(object.metadata.uid, '0x0', '0x8000000000000000')
shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')
Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
  • object.metadata.uid
  • object.metadata.namespace
hexStart і hexEnd є рядковими літералами CEL у одинарних лапках з префіксом '0x', що визначають включну нижню і виключну верхню межі в 64-бітовому просторі хешів FNV-1a. Повний діапазон: [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади:
  • 2-шардове розділення:
    шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000')
    шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')
  • 4-шардове розділення:
    шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000')
    шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000')
    шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000')
    шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000')
Це альфа-поле і вимагає увімкнення функціональної можливості ShardedListAndWatch.
timeoutSecondsintegerЧас очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності.

Параметри тіла запиту

НазваТипОпис
bodyDeleteOptions

Відповідь

СтатусОписВідповідь
200OKStatus

get Read

HTTP Запит

GET /api/v1/persistentvolumes/{name}

Параметри шляху

НазваТипОпис
namestringНазва PersistentVolume

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).

Відповідь

СтатусОписВідповідь
200OKPersistentVolume

get List

HTTP Запит

GET /api/v1/persistentvolumes

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
allowWatchBookmarksbooleanallowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується.
continuestringОпція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін.
fieldSelectorstringСелектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти.
labelSelectorstringСелектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти.
limitintegerlimit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку.
resourceVersionstringresourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено
resourceVersionMatchstringresourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено
sendInitialEventsbooleansendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
  • resourceVersionMatch = NotOlderThan інтерпретується як «дані, що є принаймні такими ж новими, як зазначена resourceVersion», і подія bookmark надсилається, коли стан синхронізується з resourceVersion, яка є принаймні такою ж актуальною, як та, що вказана в ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як «послідовне читання», і подія bookmark надсилається, коли стан синхронізується принаймні до моменту, коли почалася обробка запиту.
  • resourceVersionMatch, встановлений на будь-яке інше значення або не встановлений — повертається помилка Invalid. Стандартне значення true, якщо resourceVersion="" або resourceVersion="0" (з міркувань сумісності) і false в іншому випадку.
shardSelectorstringshardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів:
shardRange(object.metadata.uid, '0x0', '0x8000000000000000')
shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')
Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
  • object.metadata.uid
  • object.metadata.namespace
hexStart і hexEnd є рядковими літералами CEL у одинарних лапках з префіксом '0x', що визначають включну нижню і виключну верхню межі в 64-бітовому просторі хешів FNV-1a. Повний діапазон: [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади:
  • 2-шардове розділення:
    шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000')
    шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')
  • 4-шардове розділення:
    шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000')
    шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000')
    шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000')
    шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000')
Це альфа-поле і вимагає увімкнення функціональної можливості ShardedListAndWatch.
timeoutSecondsintegerЧас очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності.
watchbooleanСпостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion.

Відповідь

СтатусОписВідповідь
200OKPersistentVolumeList

get Watch

HTTP Запит

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

Параметри шляху

НазваТипОпис
namestringНазва PersistentVolume

Параметри запиту

НазваТипОпис
allowWatchBookmarksbooleanallowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується.
continuestringОпція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін.
fieldSelectorstringСелектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти.
labelSelectorstringСелектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти.
limitintegerlimit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку.
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
resourceVersionstringresourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено
resourceVersionMatchstringresourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено
sendInitialEventsbooleansendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
  • resourceVersionMatch = NotOlderThan інтерпретується як «дані, що є принаймні такими ж новими, як зазначена resourceVersion», і подія bookmark надсилається, коли стан синхронізується з resourceVersion, яка є принаймні такою ж актуальною, як та, що вказана в ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як «послідовне читання», і подія bookmark надсилається, коли стан синхронізується принаймні до моменту, коли почалася обробка запиту.
  • resourceVersionMatch, встановлений на будь-яке інше значення або не встановлений — повертається помилка Invalid. Стандартне значення true, якщо resourceVersion="" або resourceVersion="0" (з міркувань сумісності) і false в іншому випадку.
shardSelectorstringshardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів:
shardRange(object.metadata.uid, '0x0', '0x8000000000000000')
shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')
Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
  • object.metadata.uid
  • object.metadata.namespace
hexStart і hexEnd є рядковими літералами CEL у одинарних лапках з префіксом '0x', що визначають включну нижню і виключну верхню межі в 64-бітовому просторі хешів FNV-1a. Повний діапазон: [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади:
  • 2-шардове розділення:
    шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000')
    шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')
  • 4-шардове розділення:
    шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000')
    шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000')
    шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000')
    шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000')
Це альфа-поле і вимагає увімкнення функціональної можливості ShardedListAndWatch.
timeoutSecondsintegerЧас очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності.
watchbooleanСпостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion.

Відповідь

СтатусОписВідповідь
200OKWatchEvent

get Watch List

HTTP Запит

GET /api/v1/watch/persistentvolumes

Параметри запиту

НазваТипОпис
allowWatchBookmarksbooleanallowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується.
continuestringОпція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін.
fieldSelectorstringСелектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти.
labelSelectorstringСелектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти.
limitintegerlimit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку.
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
resourceVersionstringresourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено
resourceVersionMatchstringresourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено
sendInitialEventsbooleansendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
  • resourceVersionMatch = NotOlderThan інтерпретується як «дані, що є принаймні такими ж новими, як зазначена resourceVersion», і подія bookmark надсилається, коли стан синхронізується з resourceVersion, яка є принаймні такою ж актуальною, як та, що вказана в ListOptions. Якщо resourceVersion не встановлено, це інтерпретується як «послідовне читання», і подія bookmark надсилається, коли стан синхронізується принаймні до моменту, коли почалася обробка запиту.
  • resourceVersionMatch, встановлений на будь-яке інше значення або не встановлений — повертається помилка Invalid. Стандартне значення true, якщо resourceVersion="" або resourceVersion="0" (з міркувань сумісності) і false в іншому випадку.
shardSelectorstringshardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів:
shardRange(object.metadata.uid, '0x0', '0x8000000000000000')
shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')
Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
  • object.metadata.uid
  • object.metadata.namespace
hexStart і hexEnd є рядковими літералами CEL у одинарних лапках з префіксом '0x', що визначають включну нижню і виключну верхню межі в 64-бітовому просторі хешів FNV-1a. Повний діапазон: [0x0, 0x10000000000000000), де виключна верхня межа дорівнює 2^64. Приклади:
  • 2-шардове розділення:
    шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000')
    шард 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')
  • 4-шардове розділення:
    шард 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000')
    шард 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000')
    шард 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000')
    шард 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000')
Це альфа-поле і вимагає увімкнення функціональної можливості ShardedListAndWatch.
timeoutSecondsintegerЧас очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності.
watchbooleanСпостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion.

Відповідь

СтатусОписВідповідь
200OKWatchEvent

patch Patch Status

HTTP Запит

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

Параметри шляху

НазваТипОпис
namestringНазва PersistentVolume

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
dryRunstringКоли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
  • All: всі етапи dry run будуть виконані
fieldManagerstringfieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле обовʼязкове для запитів apply (application/apply-patch), але необовʼязкове для типів патчів, що не застосовуються (JsonPatch, MergePatch, StrategicMergePatch).
fieldValidationstringfieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
  • Ignore: Ігнорує всі невідомі поля, які без попередження видаляються з обʼєкта, а також ігнорує всі дублікати полів, крім останнього, на які натрапляє декодер. Це стандартна поведінка до v1.23.
  • Warn: Надсилає попередження через стандартний заголовок відповіді для кожного невідомого поля, яке видаляється з обʼєкта, і для кожного дубльованого поля, яке зустрічається. Запит все ще буде успішним, якщо немає інших помилок, і буде зберігатися лише останнє з будь-яких дубльованих полів. Це стандартна поведінка у v1.23+
  • Strict: У цьому випадку запит завершиться з помилкою BadRequest, якщо з обʼєкта будуть вилучені невідомі поля або якщо будуть виявлені дублікати полів. Помилка, що повертається сервером, міститиме всі виявлені невідомі та дубльовані поля.
forcebooleanForce має на меті "примусово" застосовувати запити Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим користувачам. Прапорець Force повинен бути скасований для запитів, що не є патчами apply.

Параметри тіла запиту

НазваТипОпис
bodyPatch

Відповідь

СтатусОписВідповідь
200OKPersistentVolume
201CreatedPersistentVolume

get Read Status

HTTP Запит

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

Параметри шляху

НазваТипОпис
namestringНазва PersistentVolume

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).

Відповідь

СтатусОписВідповідь
200OKPersistentVolume

put Replace Status

HTTP Запит

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

Параметри шляху

НазваТипОпис
namestringНазва PersistentVolume

Параметри запиту

НазваТипОпис
prettystringЯкщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget).
dryRunstringКоли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
  • All: всі етапи dry run будуть виконані
fieldManagerstringfieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint.
fieldValidationstringfieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
  • Ignore: Ігнорує всі невідомі поля, які без попередження видаляються з обʼєкта, а також ігнорує всі дублікати полів, крім останнього, на які натрапляє декодер. Це стандартна поведінка до v1.23.
  • Warn: Надсилає попередження через стандартний заголовок відповіді для кожного невідомого поля, яке видаляється з обʼєкта, і для кожного дубльованого поля, яке зустрічається. Запит все ще буде успішним, якщо немає інших помилок, і буде зберігатися лише останнє з будь-яких дубльованих полів. Це стандартна поведінка у v1.23+
  • Strict: У цьому випадку запит завершиться з помилкою BadRequest, якщо з обʼєкта будуть вилучені невідомі поля або якщо будуть виявлені дублікати полів. Помилка, що повертається сервером, міститиме всі виявлені невідомі та дубльовані поля.

Параметри тіла запиту

НазваТипОпис
bodyPersistentVolume

Відповідь

СтатусОписВідповідь
200OKPersistentVolume
201CreatedPersistentVolume
Востаннє змінено June 10, 2026 at 8:00 PM PST: [uk] Ukrainian translation (all-in-one) (4e8fe0f729)