14.10. PersistentVolume [v1]
- 描述
- PersistentVolume (PV)是管理员置备的存储资源。它类似于节点。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes
- 类型
-
对象
14.10.1. 规格
属性 | 类型 | 描述 |
---|---|---|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| PersistentVolumeSpec 是持久性卷的规格。 |
|
| PersistentVolumeStatus 是持久性卷的当前状态。 |
14.10.1.1. .spec
- 描述
- PersistentVolumeSpec 是持久性卷的规格。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| accessModes 包含可挂载卷的所有方法。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
|
| 代表 AWS 中的 Persistent Disk 资源。 挂载到容器前必须存在 AWS EBS 磁盘。磁盘还必须与 kubelet 位于同一个 AWS 区域。AWS EBS 磁盘只能以读写模式挂载。AWS EBS 卷支持所有权管理和 SELinux 重新标记。 |
|
| azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。 |
|
| azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。 |
| capacity 是持久性卷资源和容量的描述。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | |
|
| 代表 Ceph 文件系统挂载,最后一个 pod Cephfs 卷的生命周期不支持所有权管理或 SELinux 重新标记。 |
|
| 代表 Openstack 中的 cinder 卷资源。挂载到容器之前必须存在 Cinder 卷。卷还必须与 kubelet 位于同一区域。Cinder 卷支持所有权管理和 SELinux 重新标记。 |
|
| ObjectReference 包含足够信息供您检查或修改引用的对象。 |
|
| 代表由外部 CSI 卷驱动程序(Beta 功能)管理的存储 |
|
| 代表光纤通道卷。Fibre Channel 卷只能以读写模式挂载。Fibre Channel 卷支持所有权管理和 SELinux 重新标记。 |
|
| FlexPersistentVolumeSource 代表使用基于 exec 的插件置备/附加的通用持久性卷资源。 |
|
| 代表由 Flocker 代理挂载的 Flocker 卷。应该只设置其中一个 datasetName 和 datasetUUID。flocker 卷不支持所有权管理或 SELinux 重新标记。 |
|
| 代表 Google Compute Engine 中的 Persistent Disk 资源。 在挂载到容器前,GCE PD 必须已经存在。磁盘还必须与 kubelet 位于同一个 GCE 项目和区。GCE PD 只能以读写一次挂载,或者多次只读。GCE PDs 支持所有权管理和 SELinux 重新标记。 |
|
| 代表 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。 |
|
| 代表映射到 pod 的主机路径。主机路径卷不支持所有权管理或 SELinux 重新标记。 |
|
| ISCSIPersistentVolumeSource 代表 ISCSI 磁盘。ISCSI 卷只能以读写模式挂载。ISCSI 卷支持所有权管理和 SELinux 重新标记。 |
|
| local 代表与节点关联性直接附加的存储(Beta 功能) |
|
| mountOptions 是挂载选项列表,如 ["ro", "soft"]。未验证 - 如果挂载无效,则挂载将失败。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
|
| 代表 pod 的生命周期最后一个 NFS 挂载。NFS 卷不支持所有权管理或 SELinux 重新标记。 |
|
| VolumeNodeAffinity 定义限制此卷可从中访问哪些节点。 |
|
| persistentVolumeReclaimPolicy 定义从声明中释放持久性卷时会发生什么。有效选项为 Retain (为手动创建的 PersistentVolume 的默认设置)、Delete (动态置备的 PersistentVolume 的默认)和 Recycle (已弃用)。Recycle 必须被此 PersistentVolume 底层的卷插件支持。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
可能枚举值: - |
|
| 代表 Photon Controller 持久磁盘资源。 |
|
| PortworxVolumeSource 代表一个 Portworx volume 资源。 |
|
| 代表 pod 的生命周期持续的 Quobyte 挂载。quobyte 卷不支持所有权管理或 SELinux 重新标记。 |
|
| 代表 Rados 块设备挂载,该挂载最后是 pod 的生命周期。RBD 卷支持所有权管理和 SELinux 重新标记。 |
|
| ScaleIOPersistentVolumeSource 代表一个持久的 ScaleIO 卷 |
|
| storageClassName 是这个持久性卷所属的 StorageClass 的名称。空值意味着这个卷不属于任何 StorageClass。 |
|
| 代表 StorageOS 持久性卷资源。 |
|
| volumeMode 定义卷是否要与格式化的文件系统一起使用,或者保持在原始块状态。当没有包括在 spec 中时,文件系统的值会被简化。
可能枚举值: - |
|
| 代表 vSphere 卷资源。 |
14.10.1.2. .spec.awsElasticBlockStore
- 描述
代表 AWS 中的 Persistent Disk 资源。
挂载到容器前必须存在 AWS EBS 磁盘。磁盘还必须与 kubelet 位于同一个 AWS 区域。AWS EBS 磁盘只能以读写模式挂载。AWS EBS 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
volumeID
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| partition 是您要挂载的卷中的分区。如果省略,则默认为按卷名称挂载。示例:对于卷 /dev/sda1,您可以将分区指定为 "1"。同样,/dev/sda 的卷分区是 "0" (或者您可以将属性留空)。 |
|
| readonly 值 true 将强制 VolumeMounts 中的 readOnly 设置。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| VolumeId 是 AWS (Amazon EBS 卷)中的持久磁盘资源的唯一 ID。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
14.10.1.3. .spec.azureDisk
- 描述
- azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。
- 类型
-
对象
- 必填
-
diskName
-
diskURI
-
属性 | 类型 | 描述 |
---|---|---|
|
| cachingMode 是主机缓存模式: None、Read Only、Read Write。
可能枚举值: - |
|
| diskname 是 blob 存储中的数据磁盘的名称 |
|
| diskURI 是 blob 存储中数据磁盘的 URI |
|
| fstype 是要挂载的 Filesystem 类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| kind expected 值是 Shared: multiple blob disk per storage account Managed: azure disk per storage account Managed: azure managed data disk (only in managed availability set))。默认为 shared
possible enum 值: - |
|
| 只读默认值为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
14.10.1.4. .spec.azureFile
- 描述
- azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。
- 类型
-
对象
- 必填
-
secretName
-
shareName
-
属性 | 类型 | 描述 |
---|---|---|
|
| 只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretName 是包含 Azure Storage Account Name 和 Key 的 secret 名称 |
|
| secretNamespace 是包含 Azure Storage Account Name 和 Key default 的 secret 的命名空间与 Pod 相同 |
|
| sharename 是 azure Share Name |
14.10.1.5. .spec.cephfs
- 描述
- 代表 Ceph 文件系统挂载,最后一个 pod Cephfs 卷的生命周期不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
monitor
-
属性 | 类型 | 描述 |
---|---|---|
|
| Monitors is Required: Monitor is a collection of Ceph monitors more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| 路径为可选: 作为挂载的 root 使用,而不是完整的 Ceph 树,默认为 / |
|
| readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretfile 是可选:SecretFile 是 User 的密钥环的路径,默认为 /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| 用户是可选的: User 是 rados 用户名,默认为 admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
14.10.1.6. .spec.cephfs.secretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.7. .spec.cinder
- 描述
- 代表 Openstack 中的 cinder 卷资源。挂载到容器之前必须存在 Cinder 卷。卷还必须与 kubelet 位于同一区域。Cinder 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
volumeID
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的 fstype Filesystem 类型。必须是主机操作系统支持的文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| 用于识别 cinder 中的卷的卷 ID。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md |
14.10.1.8. .spec.cinder.secretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.9. .spec.claimRef
- 描述
- ObjectReference 包含足够信息供您检查或修改引用的对象。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 引用的 API 版本。 |
|
| 如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。 |
|
| 引用的类型。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 引用的命名空间。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| 指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 引用的 UID。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.10.1.10. .spec.csi
- 描述
- 代表由外部 CSI 卷驱动程序(Beta 功能)管理的存储
- 类型
-
对象
- 必填
-
driver
-
volumeHandle
-
属性 | 类型 | 描述 |
---|---|---|
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| driver 是要用于此卷的驱动程序名称。必需。 |
|
| 要挂载的 fstype。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs". |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| 传递给 ControllerPublishVolumeRequest 的 readonly 值。默认为 false (读/写)。 |
|
| 要发布的卷的 volumeAttributes。 |
|
| volumeHandle 是 CSI 卷插件的 CreateVolume 返回的唯一卷名称,以在所有后续调用中引用卷。必需。 |
14.10.1.11. .spec.csi.controllerExpandSecretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.12. .spec.csi.controllerPublishSecretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.13. .spec.csi.nodeExpandSecretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.14. .spec.csi.nodePublishSecretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.15. .spec.csi.nodeStageSecretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.16. .spec.fc
- 描述
- 代表光纤通道卷。Fibre Channel 卷只能以读写模式挂载。Fibre Channel 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| LUN 是可选的: FC 目标 lun 号 |
|
| readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| targetWWN 可选: FC 目标全球名称(WWN) |
|
| wwids 可选:FC 卷全局广泛的标识符(wwids) Either wwids 或 targetWWNs 和 lun 的组合必须同时设置,但不能同时设置。 |
14.10.1.17. .spec.flexVolume
- 描述
- FlexPersistentVolumeSource 代表使用基于 exec 的插件置备/附加的通用持久性卷资源。
- 类型
-
对象
- 必填
-
driver
-
属性 | 类型 | 描述 |
---|---|---|
|
| driver 是要用于此卷的驱动程序名称。 |
|
| fstype 是要挂载的 Filesystem 类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认文件系统取决于 FlexVolume 脚本。 |
|
| 选项是可选的:此字段包含额外的命令选项(若有)。 |
|
| readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
14.10.1.18. .spec.flexVolume.secretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.19. .spec.flocker
- 描述
- 代表由 Flocker 代理挂载的 Flocker 卷。应该只设置其中一个 datasetName 和 datasetUUID。flocker 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| datasetName 是存储在 Flocker 的 dataset 的 dataset 的 dataset 的 Name。 |
|
| datasetUUID 是 dataset 的 UUID。这是 Flocker 数据集的唯一标识符 |
14.10.1.20. .spec.gcePersistentDisk
- 描述
代表 Google Compute Engine 中的 Persistent Disk 资源。
在挂载到容器前,GCE PD 必须已经存在。磁盘还必须与 kubelet 位于同一个 GCE 项目和区。GCE PD 只能以读写一次挂载,或者多次只读。GCE PDs 支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
pdName
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| partition 是您要挂载的卷中的分区。如果省略,则默认为按卷名称挂载。示例:对于卷 /dev/sda1,您可以将分区指定为 "1"。同样,/dev/sda 的卷分区是 "0" (或者您可以将属性留空)。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| pdName 是 GCE 中的 PD 资源的唯一名称。用于识别 GCE 中的磁盘。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| 此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
14.10.1.21. .spec.glusterfs
- 描述
- 代表 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
端点
-
path
-
属性 | 类型 | 描述 |
---|---|---|
|
| Endpoints 是详细信息 Glusterfs 拓扑的端点名称。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| endpointsNamespace 是包含 Glusterfs 端点的命名空间。如果此字段为空,则 EndpointNamespace 默认为与绑定 PVC 相同的命名空间。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| path 是 Glusterfs 卷路径。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| 此处的只读将强制使用只读权限挂载 Glusterfs 卷。默认为false。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
14.10.1.22. .spec.hostPath
- 描述
- 代表映射到 pod 的主机路径。主机路径卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
path
-
属性 | 类型 | 描述 |
---|---|---|
|
| 主机上目录的路径。如果路径是符号链接,它将遵循到实际路径的链接。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
| HostPath Volume Defaults 为 "" more info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
可能枚举值:- |
14.10.1.23. .spec.iscsi
- 描述
- ISCSIPersistentVolumeSource 代表 ISCSI 磁盘。ISCSI 卷只能以读写模式挂载。ISCSI 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
targetPortal
-
IQN
-
LUN
-
属性 | 类型 | 描述 |
---|---|---|
|
| chapAuthDiscovery 定义是否支持 iSCSI Discovery CHAP 身份验证 |
|
| chapAuthSession 定义是否支持 iSCSI Session CHAP 身份验证 |
|
| fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
| initiatorname 是自定义 iSCSI 启动器名称。如果同时使用 iscsiInterface 指定 initiatorName,则会为连接创建新的 iSCSI 接口 <target portal>:<volume name>。 |
|
| IQN 是 iSCSI 限定名称的目标。 |
|
| iscsiInterface 是使用 iSCSI 传输的接口名称。默认为 'default'(tcp)。 |
|
| LUN 是 iSCSI 目标 Lun 编号。 |
|
| 门户是 iSCSI 目标门户列表。如果端口不是默认值(通常是 TCP 端口 860 和 3260),则门户可以是 IP 或 ip_addr:port。 |
|
| 此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。 |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| targetPortal 是 iSCSI 目标门户。如果端口不是默认值(通常是 TCP 端口 860 和 3260),则门户可以是 IP 或 ip_addr:port。 |
14.10.1.24. .spec.iscsi.secretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.25. .spec.local
- 描述
- local 代表与节点关联性直接附加的存储(Beta 功能)
- 类型
-
对象
- 必填
-
path
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是要挂载的文件系统类型。只有在路径是块设备时,它才会应用。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则默认值为自动选择文件系统。 |
|
| 到节点上卷的完整路径的路径。它可以是目录或块设备(disk, partition, …)。 |
14.10.1.26. .spec.nfs
- 描述
- 代表 pod 的生命周期最后一个 NFS 挂载。NFS 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
server
-
path
-
属性 | 类型 | 描述 |
---|---|---|
|
| NFS 服务器导出的路径。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| 此处的只读将强制使用只读权限挂载 NFS 导出。默认为false。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| server 是 NFS 服务器的主机名或 IP 地址。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
14.10.1.27. .spec.nodeAffinity
- 描述
- VolumeNodeAffinity 定义限制此卷可从中访问哪些节点。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 节点选择器表示一个或多个对一组节点的标签查询结果的联合;即,它代表节点选择器术语代表的选择器的 OR。 |
14.10.1.28. .spec.nodeAffinity.required
- 描述
- 节点选择器表示一个或多个对一组节点的标签查询结果的联合;即,它代表节点选择器术语代表的选择器的 OR。
- 类型
-
对象
- 必填
-
nodeSelectorTerms
-
属性 | 类型 | 描述 |
---|---|---|
|
| 必需。节点选择器术语列表。条款是 ORed。 |
|
| null 或 empty 节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。 |
14.10.1.29. .spec.nodeAffinity.required.nodeSelectorTerms
- 描述
- 必需。节点选择器术语列表。条款是 ORed。
- 类型
-
array
14.10.1.30. .spec.nodeAffinity.required.nodeSelectorTerms[]
- 描述
- null 或 empty 节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 节点标签(label)的节点选择器要求列表。 |
|
| 节点选择器要求是一个选择器,其中包含值、键和与键和值关联的操作器。 |
|
| 节点字段的节点选择器要求列表。 |
|
| 节点选择器要求是一个选择器,其中包含值、键和与键和值关联的操作器。 |
14.10.1.31. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions
- 描述
- 节点标签(label)的节点选择器要求列表。
- 类型
-
array
14.10.1.32. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions[]
- 描述
- 节点选择器要求是一个选择器,其中包含值、键和与键和值关联的操作器。
- 类型
-
对象
- 必填
-
key
-
operator
-
属性 | 类型 | 描述 |
---|---|---|
|
| 选择器应用到的标签键。 |
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt, 和 Lt.
possible enum 值:- |
|
| 字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果 Operator 是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。 |
14.10.1.33. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields
- 描述
- 节点字段的节点选择器要求列表。
- 类型
-
array
14.10.1.34. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields[]
- 描述
- 节点选择器要求是一个选择器,其中包含值、键和与键和值关联的操作器。
- 类型
-
对象
- 必填
-
key
-
operator
-
属性 | 类型 | 描述 |
---|---|---|
|
| 选择器应用到的标签键。 |
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt, 和 Lt.
possible enum 值:- |
|
| 字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果 Operator 是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。 |
14.10.1.35. .spec.photonPersistentDisk
- 描述
- 代表 Photon Controller 持久磁盘资源。
- 类型
-
对象
- 必填
-
pdID
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| pdID 是标识 Photon Controller 持久磁盘的 ID |
14.10.1.36. .spec.portworxVolume
- 描述
- PortworxVolumeSource 代表一个 Portworx volume 资源。
- 类型
-
对象
- 必填
-
volumeID
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 代表要挂载的文件系统类型,必须是主机操作系统支持的文件系统类型。EX. "ext4", "xfs"。如果未指定,则隐式推断为"ext4"。 |
|
| 只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| VolumeId 唯一标识一个 Portworx 卷 |
14.10.1.37. .spec.quobyte
- 描述
- 代表 pod 的生命周期持续的 Quobyte 挂载。quobyte 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
registry
-
卷
-
属性 | 类型 | 描述 |
---|---|---|
|
| 将卷访问映射到 Default 的组没有组 |
|
| 此处的只读将强制使用只读权限挂载 Quobyte 卷。默认为false。 |
|
| registry 代表一个或多个 Quobyte Registry 服务,作为字符串指定为 host:port 对(多个条目用逗号分隔),后者充当卷的中央 registry |
|
| 在带有动态置备 Quobyte 卷的后端中拥有给定 Quobyte 卷的租户,值由插件设置 |
|
| 用户将卷访问权限映射到默认值到 serivceaccount 用户 |
|
| 卷是一个字符串,它根据名称引用已创建的 Quobyte 卷。 |
14.10.1.38. .spec.rbd
- 描述
- 代表 Rados 块设备挂载,该挂载最后是 pod 的生命周期。RBD 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
monitor
-
image
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
| image 是 rados 镜像名称。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| keyring 是 RBDUser 的密钥环的路径。默认为 /etc/ceph/keyring。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| monitor 是 Ceph 监视器的集合。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| pool 是 rados 池名称。默认为 rbd。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| 此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| user 是 rados 用户名。默认为 admin。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
14.10.1.39. .spec.rbd.secretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.40. .spec.scaleIO
- 描述
- ScaleIOPersistentVolumeSource 代表一个持久的 ScaleIO 卷
- 类型
-
对象
- 必填
-
gateway
-
system
-
secretRef
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认为 "xfs" |
|
| gateway 是 ScaleIO API 网关的主机地址。 |
|
| protectionDomain 是配置的存储的 ScaleIO 保护域的名称。 |
|
| 只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret |
|
| sslEnabled 是启用/禁用与网关的 SSL 通信的标记,默认为 false |
|
| storageMode 指示卷的存储应该是 ThickProvisioned 或 ThinProvisioned。默认为 ThinProvisioned。 |
|
| storagePool 是与保护域关联的 ScaleIO 存储池。 |
|
| system 是存储系统的名称,如 ScaleIO 中配置。 |
|
| volumeName 是在与这个卷源关联的 ScaleIO 系统中创建的卷的名称。 |
14.10.1.41. .spec.scaleIO.secretRef
- 描述
- secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间内是唯一的,以引用 secret 资源。 |
|
| namespace 定义 secret 名称必须唯一的空间。 |
14.10.1.42. .spec.storageos
- 描述
- 代表 StorageOS 持久性卷资源。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| 只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。 |
|
| ObjectReference 包含足够信息供您检查或修改引用的对象。 |
|
| volumeName 是 StorageOS 卷的人类可读名称。卷名称只在命名空间中是唯一的。 |
|
| volumeNamespace 指定 StorageOS 中卷的范围。如果没有指定命名空间,则使用 Pod 的命名空间。这允许在 StorageOS 中镜像 Kubernetes 名称范围,以便在更紧密的集成。将 VolumeName 设置为任何名称来覆盖默认的行为。如果没有在 StorageOS 中使用命名空间,则设置为 "default"。将创建在 StorageOS 中没有预先存在的命名空间。 |
14.10.1.43. .spec.storageos.secretRef
- 描述
- ObjectReference 包含足够信息供您检查或修改引用的对象。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 引用的 API 版本。 |
|
| 如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。 |
|
| 引用的类型。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 引用的命名空间。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| 指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 引用的 UID。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.10.1.44. .spec.vsphereVolume
- 描述
- 代表 vSphere 卷资源。
- 类型
-
对象
- 必填
-
volumePath
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| StoragePolicyID 是与 StoragePolicyName 关联的存储 Policy Based Management (SPBM)配置集 ID。 |
|
| StoragePolicyName 是存储基于策略的管理(SPBM)配置集名称。 |
|
| volumePath 是标识 vSphere 卷 vmdk 的路径 |
14.10.1.45. .status
- 描述
- PersistentVolumeStatus 是持久性卷的当前状态。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| Message 是人类可读的消息,指示卷处于此状态的详细信息。 |
|
| phase 表示卷是否可用、绑定到声明或被声明释放。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
可能枚举的值: - |
|
| reason 是一个简单的 CamelCase 字符串,用于描述任何失败,用于 CLI 中的机器解析和截断显示。 |
14.10.2. API 端点
可用的 API 端点如下:
/api/v1/persistentvolumes
-
DELETE
:删除 PersistentVolume 的集合 -
GET
: 列出或监视类型为 PersistentVolume 的对象 -
POST
:创建 PersistentVolume
-
/api/v1/watch/persistentvolumes
-
GET
: 观察单个对 PersistentVolume 列表的更改。已弃用:改为使用 'watch' 参数和 list 操作。
-
/api/v1/persistentvolumes/{name}
-
DELETE
:删除 PersistentVolume -
GET
:读取指定的 PersistentVolume -
PATCH
:部分更新指定的 PersistentVolume -
PUT
:替换指定的 PersistentVolume
-
/api/v1/watch/persistentvolumes/{name}
-
GET
: 观察对类型为 PersistentVolume 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
-
/api/v1/persistentvolumes/{name}/status
-
GET
: 指定 PersistentVolume 的读取状态 -
PATCH
:部分更新指定 PersistentVolume 的状态 -
PUT
:替换指定 PersistentVolume 的状态
-
14.10.2.1. /api/v1/persistentvolumes
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出会输出。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 PersistentVolume 的集合
参数 | 类型 | 描述 |
---|---|---|
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。 当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。 |
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值为 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 一个选择器,用于按标签限制返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| deprecated :请使用 PropagationPolicy,此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false,则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置这两个字段。 |
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为:'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项;'Foreground' - 一个级联策略,会删除前台所有依赖的级联策略。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。 |
|
| list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 列出或监视类型为 PersistentVolume 的对象
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。 当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。 |
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
| 一个选择器,用于按标签限制返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。 |
|
| list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。 |
|
| 观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
401 - Unauthorized | 空 |
- HTTP 方法
-
POST
- 描述
- 创建 PersistentVolume
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
| fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空 |
14.10.2.2. /api/v1/watch/persistentvolumes
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。 当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。 |
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
| 一个选择器,用于按标签限制返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| 如果 'true',则输出会输出。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。 |
|
| list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。 |
|
| 观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察单个对 PersistentVolume 列表的更改。已弃用:改为使用 'watch' 参数和 list 操作。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
14.10.2.3. /api/v1/persistentvolumes/{name}
参数 | 类型 | 描述 |
---|---|---|
|
| PersistentVolume 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出会输出。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 PersistentVolume
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值为 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| deprecated :请使用 PropagationPolicy,此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false,则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置这两个字段。 |
|
| 是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为:'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项;'Foreground' - 一个级联策略,会删除前台所有依赖的级联策略。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
202 - Accepted | |
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 读取指定的 PersistentVolume
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定的 PersistentVolume
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch),但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
| fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。 |
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定的 PersistentVolume
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
| fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空 |
14.10.2.4. /api/v1/watch/persistentvolumes/{name}
参数 | 类型 | 描述 |
---|---|---|
|
| PersistentVolume 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,则必须重启其列表,而无需 continue 字段。否则,客户端可能会发送另一个带有 410 错误的令牌的列表请求,服务器将使用从下一个密钥开始的列表进行响应,但从最新的快照开始,从上一个列表结果(创建、修改或删除)后,创建、修改或删除第一个列表请求将包含在响应中,只要它们的键位于"下一密钥"后。 当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。 |
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
| 一个选择器,用于按标签限制返回的对象列表。默认为任何内容。 |
|
| limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。 服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。 |
|
| 如果 'true',则输出会输出。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' (用于向后兼容的原因)和 false,则默认为 true。 |
|
| list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。 |
|
| 观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察对类型为 PersistentVolume 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
14.10.2.5. /api/v1/persistentvolumes/{name}/status
参数 | 类型 | 描述 |
---|---|---|
|
| PersistentVolume 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出会输出。 |
- HTTP 方法
-
GET
- 描述
- 指定 PersistentVolume 的读取状态
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 指定 PersistentVolume 的部分更新状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch),但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。 |
|
| fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。 |
|
| 强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定 PersistentVolume 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
| fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为: - Ignore :这将忽略从对象静默丢弃的所有未知字段,并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为:这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误,请求仍会成功,且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值:如果从对象中删除任何未知字段,或者存在任何重复字段,则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空 |