30.16. PersistentVolume [v1]
- 描述
- PersistentVolume (PV)是管理员调配的存储资源。它与一个节点类似。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes
- 类型
-
对象
30.16.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 是持久性卷的当前状态。 |
30.16.1.1. .spec 复制链接链接已复制到粘贴板!
- 描述
- PersistentVolumeSpec 是持久性卷的规格。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| accessModes 包含可挂载卷的所有方法。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
|
| 代表 AWS 中的持久磁盘资源。 在挂载到容器前,AWS EBS 磁盘必须存在。这个磁盘还必须与 kubelet 位于同一个 AWS 区域中。AWS EBS 磁盘只能挂载为读/写一次。AWS EBS 卷支持所有权管理和 SELinux 重新标记。 |
|
| azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。 |
|
| azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。 |
| 持久性卷资源和容量的描述。更多信息: 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 PD 支持所有权管理和 SELinux 重新标记。 |
|
| 代表持续 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。 |
|
| 表示映射到 pod 的主机路径。主机路径卷不支持所有权管理或 SELinux 重新标记。 |
|
| ISCSIPersistentVolumeSource 代表 ISCSI 磁盘。ISCSI 卷只能挂载为读写一次。ISCSI 卷支持所有权管理和 SELinux 重新标记。 |
|
| local 代表带有节点关联性(Beta 功能)的直接附加存储 |
|
| 挂载选项列表,如 ["ro", "soft"]。not verify - 如果一个无效,挂载将失败。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
|
| 代表持续 pod 生命周期的 NFS 挂载。NFS 卷不支持所有权管理或 SELinux 重新标记。 |
|
| VolumeNodeAffinity 定义约束来限制可以从哪些节点访问这个卷。 |
|
| 从其声明中释放持久性卷时会发生什么。有效选项为 Retain (手动创建 PersistentVolume 的默认值)、Delete (动态置备的 PersistentVolume 的默认)和 Recycle (已弃用)。这个 PersistentVolume 的卷插件必须支持 Recycle。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming |
|
| 代表 Photon Controller 持久磁盘资源。 |
|
| PortworxVolumeSource 代表 Portworx 卷资源。 |
|
| 代表持续 pod 生命周期的 Quobyte 挂载。quobyte 卷不支持所有权管理或 SELinux 重新标记。 |
|
| 代表持续 pod 生命周期的 Rados 块设备挂载。RBD 卷支持所有权管理和 SELinux 重新标记。 |
|
| ScaleIOPersistentVolumeSource 代表持久性扩展IO 卷 |
|
| 此持久性卷所属的 StorageClass 的名称。空值意味着这个卷不属于任何 StorageClass。 |
|
| 代表 StorageOS 持久性卷资源。 |
|
| volumeMode 定义卷是否要与格式化的文件系统一起使用,或者保持在原始块状态。如果没有包含在 spec 中,则 Filesystem 的值会被表示。 |
|
| 代表 vSphere 卷资源。 |
30.16.1.2. .spec.awsElasticBlockStore 复制链接链接已复制到粘贴板!
- 描述
代表 AWS 中的持久磁盘资源。
在挂载到容器前,AWS EBS 磁盘必须存在。这个磁盘还必须与 kubelet 位于同一个 AWS 区域中。AWS EBS 磁盘只能挂载为读/写一次。AWS EBS 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
volumeID
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| 要挂载的卷中的分区。如果省略,则默认由卷名称挂载。示例:对于卷 /dev/sda1,您可以将分区指定为 "1"。同样,/dev/sda 的卷快照是"0" (或者您可以将属性留空)。 |
|
| 指定 "true" 来强制并将 VolumeMounts 中的 ReadOnly 属性设置为 "true"。如果省略,则默认为 "false"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| AWS (Amazon EBS 卷)中持久磁盘资源的唯一 ID。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
30.16.1.3. .spec.azureDisk 复制链接链接已复制到粘贴板!
- 描述
- azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。
- 类型
-
对象
- 必填
-
diskName
-
diskURI
-
属性 | 类型 | 描述 |
---|---|---|
|
| 主机缓存模式:无、只读、读写。 |
|
| blob 存储中的数据磁盘的名称 |
|
| blob 存储中的数据磁盘的 URI |
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| 预期值 Shared: 每个存储帐户 Dedicated 多个 blob 磁盘:每个存储帐户 Managed: azure managed data disk (仅限受管可用性集中)。默认为 shared |
|
| 默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。 |
30.16.1.4. .spec.azureFile 复制链接链接已复制到粘贴板!
- 描述
- azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。
- 类型
-
对象
- 必填
-
secretName
-
shareName
-
属性 | 类型 | 描述 |
---|---|---|
|
| 默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。 |
|
| 包含 Azure 存储帐户名称和密钥的 secret 名称 |
|
| 包含 Azure Storage Account Name 和 Key default 的 secret 的命名空间与 Pod 相同 |
|
| 共享名称 |
30.16.1.5. .spec.cephfs 复制链接链接已复制到粘贴板!
- 描述
- 代表 Ceph 文件系统挂载,最后一个 pod Cephfs 卷的生命周期不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
monitor
-
属性 | 类型 | 描述 |
---|---|---|
|
| 必需: monitor 是 Ceph 监视器更多信息的集合: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| 可选:用作挂载的 root,而不是完整的 Ceph 树,默认为 / |
|
| 可选:默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| 可选: SecretFile 是用户密钥环的路径,默认为 /etc/ceph/user.secret more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| 可选: User 是 rados 用户名,默认为 admin more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
30.16.1.6. .spec.cephfs.secretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.7. .spec.cinder 复制链接链接已复制到粘贴板!
- 描述
- 代表 Openstack 中的 cinder 卷资源。在挂载到容器前,Cinder 卷必须存在。卷还必须与 kubelet 位于同一个区域。Cinder 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
volumeID
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| 可选:默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| 用于识别 cinder 中卷的卷 ID。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md |
30.16.1.8. .spec.cinder.secretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.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 |
30.16.1.10. .spec.csi 复制链接链接已复制到粘贴板!
- 描述
- 代表由外部 CSI 卷驱动程序管理的存储(Beta 功能)
- 类型
-
对象
- 必填
-
driver
-
volumeHandle
-
属性 | 类型 | 描述 |
---|---|---|
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| driver 是此卷要使用的驱动程序名称。必需。 |
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs". |
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| 可选:传递给 ControllerPublishVolumeRequest 的值。默认为 false (读/写)。 |
|
| 要发布的卷的属性。 |
|
| volumeHandle 是 CSI 卷插件的 CreateVolume 返回的唯一卷名称,以引用所有后续调用上的卷。必需。 |
30.16.1.11. .spec.csi.controllerExpandSecretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.12. .spec.csi.controllerPublishSecretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.13. .spec.csi.nodePublishSecretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.14. .spec.csi.nodeStageSecretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.15. .spec.fc 复制链接链接已复制到粘贴板!
- 描述
- 代表光纤通道卷。Fibre Channel 卷只能挂载为读/写一次。Fibre Channel 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| 可选: FC 目标 lun 号 |
|
| 可选:默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。 |
|
| 可选: FC 目标全球名称(WWN) |
|
| 可选: FC 卷全局识别符(wwids) Either wwids 或 targetWWN 和 lun 的组合都必须被设置,但不能同时设置。 |
30.16.1.16. .spec.flexVolume 复制链接链接已复制到粘贴板!
- 描述
- FlexPersistentVolumeSource 代表一个通用持久性卷资源,它使用基于 exec 的插件置备/附加。
- 类型
-
对象
- 必填
-
driver
-
属性 | 类型 | 描述 |
---|---|---|
|
| driver 是此卷要使用的驱动程序名称。 |
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认文件系统依赖于 FlexVolume 脚本。 |
|
| 可选:额外的命令选项(若有)。 |
|
| 可选:默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。 |
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
30.16.1.17. .spec.flexVolume.secretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.18. .spec.flocker 复制链接链接已复制到粘贴板!
- 描述
- 代表 Flocker 代理挂载的 Flocker 卷。应该只设置一个 datasetName 和 datasetUUID。flocker 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
在 Flocker 的 dataset 上作为 metadata |
|
| dataset 的 UUID。这是 Flocker 数据集的唯一标识符 |
30.16.1.19. .spec.gcePersistentDisk 复制链接链接已复制到粘贴板!
- 描述
代表 Google Compute Engine 中的 Persistent Disk 资源。
在挂载到容器前,GCE PD 必须存在。这个磁盘还必须与 kubelet 位于同一个 GCE 项目和区中。GCE PD 只能以读写一次或只以只读模式挂载。GCE PD 支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
pdName
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| 要挂载的卷中的分区。如果省略,则默认由卷名称挂载。示例:对于卷 /dev/sda1,您可以将分区指定为 "1"。同样,/dev/sda 的卷快照是"0" (或者您可以将属性留空)。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| GCE 中 PD 资源的唯一名称。用于识别 GCE 中的磁盘。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| 此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
30.16.1.20. .spec.glusterfs 复制链接链接已复制到粘贴板!
- 描述
- 代表持续 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
端点
-
path
-
属性 | 类型 | 描述 |
---|---|---|
|
| endpointName 是详细说明 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 |
30.16.1.21. .spec.hostPath 复制链接链接已复制到粘贴板!
- 描述
- 表示映射到 pod 的主机路径。主机路径卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
path
-
属性 | 类型 | 描述 |
---|---|---|
|
| 主机上目录的路径。如果路径是符号链接,它将遵循到实际路径的链接。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
| HostPath Volume Defaults 为 "" more information: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
30.16.1.22. .spec.iscsi 复制链接链接已复制到粘贴板!
- 描述
- ISCSIPersistentVolumeSource 代表 ISCSI 磁盘。ISCSI 卷只能挂载为读写一次。ISCSI 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
targetPortal
-
iqn
-
lun
-
属性 | 类型 | 描述 |
---|---|---|
|
| 是否支持 iSCSI 发现 CHAP 身份验证 |
|
| 是否支持 iSCSI 会话 CHAP 身份验证 |
|
| 要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
| 自定义 iSCSI 启动器名称。如果同时使用 iscsiInterface 指定 initiatorName,则会为连接创建新的 iSCSI 接口 <target portal>:<volume name>。 |
|
| 目标 iSCSI 限定名称。 |
|
| 使用 iSCSI 传输的 iSCSI 接口名称。默认为 'default'(tcp)。 |
|
| iSCSI 目标 Lun 号。 |
|
| iSCSI 目标门户列表.如果端口不是默认端口(通常为 TCP 端口 860 和 3260),则门户是 IP 或 ip_addr:port。 |
|
| 此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。默认为false。 |
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| iSCSI 目标门户.如果端口不是默认端口(通常为 TCP 端口 860 和 3260),则门户是 IP 或 ip_addr:port。 |
30.16.1.23. .spec.iscsi.secretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.24. .spec.local 复制链接链接已复制到粘贴板!
- 描述
- local 代表带有节点关联性(Beta 功能)的直接附加存储
- 类型
-
对象
- 必填
-
path
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的文件系统类型。只有在路径是块设备时才适用。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则默认值为 auto-select a fileystem。 |
|
| 节点上卷的完整路径。它可以是目录或块设备(磁盘、分区、…)。 |
30.16.1.25. .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 |
30.16.1.26. .spec.nodeAffinity 复制链接链接已复制到粘贴板!
- 描述
- VolumeNodeAffinity 定义约束来限制可以从哪些节点访问这个卷。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 节点选择器代表在一组节点上一个或多个标签查询的结果的取消;即,它代表节点选择器术语代表选择器术语的 OR。 |
30.16.1.27. .spec.nodeAffinity.required 复制链接链接已复制到粘贴板!
- 描述
- 节点选择器代表在一组节点上一个或多个标签查询的结果的取消;即,它代表节点选择器术语代表选择器术语的 OR。
- 类型
-
对象
- 必填
-
nodeSelectorTerms
-
属性 | 类型 | 描述 |
---|---|---|
|
| 必需。节点选择器术语列表。术语为 ORed。 |
|
| 空或空节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。 |
- 描述
- 必需。节点选择器术语列表。术语为 ORed。
- 类型
-
数组
- 描述
- 空或空节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 按节点标签划分的节点选择器要求列表。 |
|
| 节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。 |
|
| 按节点字段的节点选择器要求列表。 |
|
| 节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。 |
- 描述
- 按节点标签划分的节点选择器要求列表。
- 类型
-
数组
- 描述
- 节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
- 类型
-
对象
- 必填
-
key
-
operator
-
属性 | 类型 | 描述 |
---|---|---|
|
| 选择器应用到的标签键。 |
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt。 |
|
| 字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果运算符是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。 |
- 描述
- 按节点字段的节点选择器要求列表。
- 类型
-
数组
- 描述
- 节点选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
- 类型
-
对象
- 必填
-
key
-
operator
-
属性 | 类型 | 描述 |
---|---|---|
|
| 选择器应用到的标签键。 |
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt。 |
|
| 字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果运算符是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。 |
30.16.1.34. .spec.photonPersistentDisk 复制链接链接已复制到粘贴板!
- 描述
- 代表 Photon Controller 持久磁盘资源。
- 类型
-
对象
- 必填
-
pdID
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| 标识 Photon Controller 持久磁盘的 ID |
30.16.1.35. .spec.portworxVolume 复制链接链接已复制到粘贴板!
- 描述
- PortworxVolumeSource 代表 Portworx 卷资源。
- 类型
-
对象
- 必填
-
volumeID
-
属性 | 类型 | 描述 |
---|---|---|
|
| fstype 代表要挂载 Must 的文件系统类型,是主机操作系统支持的文件系统类型。EX. "ext4", "xfs"。如果未指定,则隐式推断为"ext4"。 |
|
| 默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。 |
|
| VolumeId 唯一标识 Portworx 卷 |
30.16.1.36. .spec.quobyte 复制链接链接已复制到粘贴板!
- 描述
- 代表持续 pod 生命周期的 Quobyte 挂载。quobyte 卷不支持所有权管理或 SELinux 重新标记。
- 类型
-
对象
- 必填
-
registry
-
卷
-
属性 | 类型 | 描述 |
---|---|---|
|
| 将卷访问映射到 Default 的组 |
|
| 此处的只读将强制使用只读权限挂载 Quobyte 卷。默认为false。 |
|
| registry 代表单个或多个 Quobyte Registry 服务,指定为 host:port 对(多个条目用逗号分开),它充当卷的中央 registry |
|
| 在带有动态置备的 Quobyte 卷的后端中拥有给定 Quobyte 卷的租户,值由插件设置 |
|
| 将卷访问权限映射到 Defaults 到 serivceaccount 用户 |
|
| 卷是一个字符串,它按名称引用已创建 Quobyte 卷。 |
30.16.1.37. .spec.rbd 复制链接链接已复制到粘贴板!
- 描述
- 代表持续 pod 生命周期的 Rados 块设备挂载。RBD 卷支持所有权管理和 SELinux 重新标记。
- 类型
-
对象
- 必填
-
monitor
-
镜像
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
| 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 |
|
| Ceph 监视器的集合。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| 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 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| rados 用户名。默认为 admin。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
30.16.1.38. .spec.rbd.secretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.39. .spec.scaleIO 复制链接链接已复制到粘贴板!
- 描述
- ScaleIOPersistentVolumeSource 代表持久性扩展IO 卷
- 类型
-
对象
- 必填
-
gateway
-
system
-
secretRef
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认为 "xfs" |
|
| ScaleIO API 网关的主机地址。 |
|
| 配置存储的 ScaleIO 保护域的名称。 |
|
| 默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。 |
|
| secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret |
|
| 启用/禁用与网关的 SSL 通信的标志,默认为 false |
|
| 指明卷的存储是否应是 ThickProvisioned 或 ThinProvisioned。默认为 ThinProvisioned。 |
|
| 与保护域关联的 ScaleIO 存储池。 |
|
| 存储系统的名称,如 ScaleIO 中配置的。 |
|
| 已在与这个卷源关联的 ScaleIO 系统中创建的卷名称。 |
30.16.1.40. .spec.scaleIO.secretRef 复制链接链接已复制到粘贴板!
- 描述
- secretReference 代表 Secret 参考。它有足够的信息来检索任何命名空间中的 secret
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 名称在命名空间中唯一用于引用 secret 资源。 |
|
| namespace 定义 secret 名称必须是唯一的的空间。 |
30.16.1.41. .spec.storageos 复制链接链接已复制到粘贴板!
- 描述
- 代表 StorageOS 持久性卷资源。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| 默认为 false (读/写)。此处的 ReadOnly 将强制 VolumeMount 中的 ReadOnly 设置。 |
|
| ObjectReference 包含足够信息供您检查或修改引用的对象。 |
|
| volumeName 是 StorageOS 卷的人类可读名称。卷名称只在命名空间中唯一。 |
|
| VolumeNamespace 指定 StorageOS 中的卷范围。如果没有指定命名空间,则使用 Pod 的命名空间。这允许 Kubernetes 名称范围在 StorageOS 中进行镜像,以便更好地集成。将 VolumeName 设置为任何名称来覆盖默认行为。如果没有在 StorageOS 中使用命名空间,则设置为 "default"。将创建没有在 StorageOS 中预先存在的命名空间。 |
30.16.1.42. .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 |
30.16.1.43. .spec.vsphereVolume 复制链接链接已复制到粘贴板!
- 描述
- 代表 vSphere 卷资源。
- 类型
-
对象
- 必填
-
volumePath
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。 |
|
| 与 StoragePolicyName 关联的基于存储策略的管理(SPBM)配置集 ID。 |
|
| 基于存储策略的管理(SPBM)配置集名称。 |
|
| 标识 vSphere 卷 vmdk 的路径 |
30.16.1.44. .status 复制链接链接已复制到粘贴板!
- 描述
- PersistentVolumeStatus 是持久性卷的当前状态。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 人类可读的消息,指示卷处于此状态的原因。 |
|
| phase 表示卷是否可用、绑定到声明或由声明释放。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase |
|
| reason 是一个简短的 CamelCase 字符串,用于描述任何故障,用于在 CLI 中解析和 tidy 显示。 |
30.16.2. API 端点 复制链接链接已复制到粘贴板!
可用的 API 端点如下:
/api/v1/persistentvolumes
-
DELETE
:删除 PersistentVolume 的集合 -
GET
: 列出或监视类型为 PersistentVolume 的对象 -
POST
:创建一个 PersistentVolume
-
/api/v1/watch/persistentvolumes
-
GET
: 观察单个对 PersistentVolume 列表的更改。已弃用:将 'watch' 参数与列表操作一起使用。
-
/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 的状态
-
30.16.2.1. /api/v1/persistentvolumes 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 PersistentVolume 集合
参数 | 类型 | 描述 |
---|---|---|
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| 弃用:请使用 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。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 列出或监视 PersistentVolume 类型的对象
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 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。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
401 - 未授权 | 空 |
- HTTP 方法
-
POST
- 描述
- 创建 PersistentVolume
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - 未授权 | 空 |
30.16.2.2. /api/v1/watch/persistentvolumes 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 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。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察单个对 PersistentVolume 列表的更改。已弃用:改为使用 'watch' 参数和列表操作。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
30.16.2.3. /api/v1/persistentvolumes/{name} 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| PersistentVolume 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 PersistentVolume
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。 |
|
| 是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
202 - Accepted | |
401 - 未授权 | 空 |
- HTTP 方法
-
GET
- 描述
- 读取指定的 PersistentVolume
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
401 - 未授权 | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定的 PersistentVolume
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段,但对于非应用补丁类型(JsonPatch、MergePatch、OptMergePatch)是可选的。 |
|
| 强制将"强制"应用请求。这意味着用户会重新清空由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - 未授权 | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定的 PersistentVolume
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - 未授权 | 空 |
30.16.2.4. /api/v1/watch/persistentvolumes/{name} 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| PersistentVolume 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 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。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察对类型为 PersistentVolume 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
30.16.2.5. /api/v1/persistentvolumes/{name}/status 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| PersistentVolume 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
GET
- 描述
- 指定 PersistentVolume 的读取状态
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
401 - 未授权 | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定 PersistentVolume 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段,但对于非应用补丁类型(JsonPatch、MergePatch、OptMergePatch)是可选的。 |
|
| 强制将"强制"应用请求。这意味着用户会重新清空由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - 未授权 | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定 PersistentVolume 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK | |
201 - Created | |
401 - 未授权 | 空 |