PersistentVolume

PersistentVolume (PV) 是由管理员配置的存储资源。

apiVersion: v1

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

PersistentVolume

PersistentVolume (PV) 是由管理员配置的存储资源。它类似于一个节点。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes


PersistentVolumeSpec

PersistentVolumeSpec 是持久卷的规范。


  • accessModes ([]string)

    原子性:合并时将被替换

    accessModes 包含卷可以被挂载的所有方式。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#access-modes

  • capacity (map[string]Quantity)

    capacity 是对持久卷资源和容量的描述。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#capacity

  • claimRef (ObjectReference)

    claimRef 是 PersistentVolume 和 PersistentVolumeClaim 之间双向绑定的组成部分。绑定时应为非空。claim.VolumeName 是 PV 和 PVC 之间权威的绑定信息。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#binding

  • mountOptions ([]string)

    原子性:合并时将被替换

    mountOptions 是挂载选项列表,例如 ["ro", "soft"]。未验证 - 如果存在无效选项,挂载将会失败。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes/#mount-options

  • nodeAffinity (VolumeNodeAffinity)

    nodeAffinity 定义了限制此卷可以从哪些节点访问的约束。此字段会影响使用此卷的 Pod 的调度。

    VolumeNodeAffinity 定义了限制此卷可以从哪些节点访问的约束。

    • nodeAffinity.required (NodeSelector)

      required 指定了必须满足的硬性节点约束。

      节点选择器表示对一组节点执行的一个或多个标签查询结果的并集;也就是说,它代表由节点选择器术语表示的选择器的 OR 运算。

      • nodeAffinity.required.nodeSelectorTerms ([]NodeSelectorTerm), required

        原子性:合并时将被替换

        Required。节点选择器术语列表。这些术语之间是 OR 关系。

        一个空或 nil 的节点选择器术语不匹配任何对象。它们的条件是 AND 关系。TopologySelectorTerm 类型实现了 NodeSelectorTerm 的一个子集。

        • nodeAffinity.required.nodeSelectorTerms.matchExpressions ([]NodeSelectorRequirement)

          原子性:合并时将被替换

          按节点标签列出的节点选择器要求列表。

        • nodeAffinity.required.nodeSelectorTerms.matchFields ([]NodeSelectorRequirement)

          原子性:合并时将被替换

          按节点字段列出的节点选择器要求列表。

  • persistentVolumeReclaimPolicy (string)

    persistentVolumeReclaimPolicy 定义了持久卷在其 PersistentVolumeClaim 被释放时会发生什么。有效选项包括 Retain(手动创建 PersistentVolume 的默认值)、Delete(动态配置 PersistentVolume 的默认值)和 Recycle(已弃用)。Recycle 必须由该 PersistentVolume 底层的卷插件支持。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#reclaiming

  • storageClassName (string)

    storageClassName 是此持久卷所属 StorageClass 的名称。空值表示此卷不属于任何 StorageClass。

  • volumeAttributesClassName (string)

    此持久卷所属 VolumeAttributesClass 的名称。不允许空值。当此字段未设置时,表示此卷不属于任何 VolumeAttributesClass。此字段是可变的,在卷成功更新到新类别后,CSI 驱动程序可以更改它。对于未绑定的 PersistentVolume,在绑定过程中,volumeAttributesClassName 将与未绑定的 PersistentVolumeClaims 进行匹配。这是一个 Beta 字段,需要启用 VolumeAttributesClass 功能(默认关闭)。

  • volumeMode (string)

    volumeMode 定义了卷是打算与格式化的文件系统一起使用还是保持原始块设备状态。如果未包含在 spec 中,则默认值为 Filesystem。

Local

  • hostPath (HostPathVolumeSource)

    hostPath 表示主机上的一个目录。由开发人员或测试人员配置。这仅适用于单节点开发和测试!主机上的存储不支持多节点集群,并且在多节点集群中将无法工作。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes#hostpath

    表示映射到 Pod 中的主机路径。主机路径卷不支持所有权管理或 SELinux 重新标记。

  • local (LocalVolumeSource)

    local 表示具有节点亲和性的直连存储

    Local 表示具有节点亲和性的直连存储

    • local.path (string), required

      节点上卷的完整路径。它可以是目录或块设备(磁盘、分区等)。

    • local.fsType (string)

      fsType 是要挂载的文件系统类型。仅当 Path 是块设备时适用。必须是主机操作系统支持的文件系统类型。例如:"ext4", "xfs", "ntfs"。如果未指定,默认值是自动选择文件系统。

Persistent volumes

  • awsElasticBlockStore (AWSElasticBlockStoreVolumeSource)

    awsElasticBlockStore 表示附加到 kubelet 主机并暴露给 Pod 的 AWS 磁盘资源。已弃用:AWSElasticBlockStore 已弃用。所有针对树内 awsElasticBlockStore 类型的操作都将重定向到 ebs.csi.aws.com CSI 驱动程序。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes#awselasticblockstore

    *表示 AWS 中的持久性磁盘资源。

    在挂载到容器之前,AWS EBS 磁盘必须已经存在。该磁盘必须与 kubelet 位于同一个 AWS 区域。AWS EBS 磁盘只能以读/写一次的方式挂载。AWS EBS 卷支持所有权管理和 SELinux 重新标记。*

  • azureDisk (AzureDiskVolumeSource)

    azureDisk 表示在主机上挂载的 Azure 数据磁盘并绑定挂载到 Pod。已弃用:AzureDisk 已弃用。所有针对树内 azureDisk 类型的操作都将重定向到 disk.csi.azure.com CSI 驱动程序。

    AzureDisk 表示在主机上挂载的 Azure 数据磁盘并绑定挂载到 Pod。

    • azureDisk.diskName (string), required

      diskName 是 blob 存储中数据磁盘的名称

    • azureDisk.diskURI (string), required

      diskURI 是 blob 存储中数据磁盘的 URI

    • azureDisk.cachingMode (string)

      cachingMode 是主机缓存模式:None, Read Only, Read Write。

    • azureDisk.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为 "ext4"。

    • azureDisk.kind (string)

      kind 期望的值为 Shared:每个存储账户多个 blob 磁盘;Dedicated:每个存储账户单个 blob 磁盘;Managed:azure 托管数据磁盘(仅在托管可用性集中)。默认为 shared。

    • azureDisk.readOnly (boolean)

      readOnly 默认为 false(读/写)。此处的 ReadOnly 将强制 VolumeMounts 中的 ReadOnly 设置。

  • azureFile (AzureFilePersistentVolumeSource)

    azureFile 表示在主机上挂载的 Azure 文件服务并绑定挂载到 Pod。已弃用:AzureFile 已弃用。所有针对树内 azureFile 类型的操作都将重定向到 file.csi.azure.com CSI 驱动程序。

    AzureFile 表示在主机上挂载的 Azure 文件服务并绑定挂载到 Pod。

    • azureFile.secretName (string), required

      secretName 是包含 Azure 存储账户名称和密钥的 Secret 名称

    • azureFile.shareName (string), required

      shareName 是 Azure 共享名称

    • azureFile.readOnly (boolean)

      readOnly 默认为 false(读/写)。此处的 ReadOnly 将强制 VolumeMounts 中的 ReadOnly 设置。

    • azureFile.secretNamespace (string)

      secretNamespace 是包含 Azure 存储账户名称和密钥的 Secret 所在的命名空间,默认与 Pod 相同

  • cephfs (CephFSPersistentVolumeSource)

    cephFS 表示在主机上挂载的 Ceph FS,与 Pod 的生命周期共享。已弃用:CephFS 已弃用,并且不再支持树内 cephfs 类型。

    表示持续 Pod 生命周期的 Ceph 文件系统挂载。Cephfs 卷不支持所有权管理或 SELinux 重新标记。

  • cinder (CinderPersistentVolumeSource)

    cinder 表示附加并挂载到 kubelet 主机上的 cinder 卷。已弃用:Cinder 已弃用。所有针对树内 cinder 类型的操作都将重定向到 cinder.csi.openstack.org CSI 驱动程序。更多信息:https://examples.k8s.io/mysql-cinder-pd/README.md

    表示 Openstack 中的 cinder 卷资源。在挂载到容器之前,Cinder 卷必须已经存在。该卷还必须与 kubelet 位于同一个区域。Cinder 卷支持所有权管理和 SELinux 重新标记。

    • cinder.volumeID (string), required

      volumeID 用于标识 cinder 中的卷。更多信息:https://examples.k8s.io/mysql-cinder-pd/README.md

    • cinder.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为 "ext4"。更多信息:https://examples.k8s.io/mysql-cinder-pd/README.md

    • cinder.readOnly (boolean)

      readOnly 是 Optional:默认为 false(读/写)。此处的 ReadOnly 将强制 VolumeMounts 中的 ReadOnly 设置。更多信息:https://examples.k8s.io/mysql-cinder-pd/README.md

    • cinder.secretRef (SecretReference)

      secretRef 是 Optional:指向一个包含连接到 OpenStack 所用参数的 Secret 对象。

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • cinder.secretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • cinder.secretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

  • csi (CSIPersistentVolumeSource)

    csi 表示由外部 CSI 驱动程序处理的存储。

    表示由外部 CSI 卷驱动程序管理的存储

    • csi.driver (string), required

      driver 是用于此卷的驱动程序名称。Required。

    • csi.volumeHandle (string), required

      volumeHandle 是 CSI 卷插件的 CreateVolume 调用返回的唯一卷名称,用于在所有后续调用中引用该卷。Required。

    • csi.controllerExpandSecretRef (SecretReference)

      controllerExpandSecretRef 是对包含敏感信息(用于传递给 CSI 驱动程序以完成 CSI ControllerExpandVolume 调用)的 Secret 对象的引用。此字段是可选的,如果不需要 Secret,可以为空。如果 Secret 对象包含多个 Secret,所有 Secret 都将被传递。

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • csi.controllerExpandSecretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • csi.controllerExpandSecretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

    • csi.controllerPublishSecretRef (SecretReference)

      controllerPublishSecretRef 是对包含敏感信息(用于传递给 CSI 驱动程序以完成 CSI ControllerPublishVolume 和 ControllerUnpublishVolume 调用)的 Secret 对象的引用。此字段是可选的,如果不需要 Secret,可以为空。如果 Secret 对象包含多个 Secret,所有 Secret 都将被传递。

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • csi.controllerPublishSecretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • csi.controllerPublishSecretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

    • csi.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4", "xfs", "ntfs"。

    • csi.nodeExpandSecretRef (SecretReference)

      nodeExpandSecretRef 是对包含敏感信息(用于传递给 CSI 驱动程序以完成 CSI NodeExpandVolume 调用)的 Secret 对象的引用。此字段是可选的,如果不需要 Secret,可以省略。如果 Secret 对象包含多个 Secret,所有 Secret 都将被传递。

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • csi.nodeExpandSecretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • csi.nodeExpandSecretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

    • csi.nodePublishSecretRef (SecretReference)

      nodePublishSecretRef 是对包含敏感信息(用于传递给 CSI 驱动程序以完成 CSI NodePublishVolume 和 NodeUnpublishVolume 调用)的 Secret 对象的引用。此字段是可选的,如果不需要 Secret,可以为空。如果 Secret 对象包含多个 Secret,所有 Secret 都将被传递。

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • csi.nodePublishSecretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • csi.nodePublishSecretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

    • csi.nodeStageSecretRef (SecretReference)

      nodeStageSecretRef 是对包含敏感信息(用于传递给 CSI 驱动程序以完成 CSI NodeStageVolume 和 NodeUnstageVolume 调用)的 Secret 对象的引用。此字段是可选的,如果不需要 Secret,可以为空。如果 Secret 对象包含多个 Secret,所有 Secret 都将被传递。

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • csi.nodeStageSecretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • csi.nodeStageSecretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

    • csi.readOnly (boolean)

      传递给 ControllerPublishVolumeRequest 的 readOnly 值。默认为 false(读/写)。

    • csi.volumeAttributes (map[string]string)

      要发布的卷的 volumeAttributes。

  • fc (FCVolumeSource)

    fc 表示附加到 kubelet 主机并暴露给 Pod 的光纤通道资源。

    表示光纤通道卷。光纤通道卷只能以读/写一次的方式挂载。光纤通道卷支持所有权管理和 SELinux 重新标记。

    • fc.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为 "ext4"。

    • fc.lun (int32)

      lun 是 Optional:FC 目标 LUN 编号

    • fc.readOnly (boolean)

      readOnly 是 Optional:默认为 false(读/写)。此处的 ReadOnly 将强制 VolumeMounts 中的 ReadOnly 设置。

    • fc.targetWWNs ([]string)

      原子性:合并时将被替换

      targetWWNs 是 Optional:FC 目标全球名称 (WWN)

    • fc.wwids ([]string)

      原子性:合并时将被替换

      wwids 是 Optional:FC 卷全球标识符 (wwids)。必须设置 wwids 或 targetWWNs 和 lun 的组合,但不能同时设置两者。

  • flexVolume (FlexPersistentVolumeSource)

    flexVolume 表示使用基于 exec 的插件配置/附加的通用卷资源。已弃用:FlexVolume 已弃用。请考虑使用 CSIDriver。

    FlexPersistentVolumeSource 表示使用基于 exec 的插件配置/附加的通用持久卷资源。

    • flexVolume.driver (string), required

      driver 是用于此卷的驱动程序名称。

    • flexVolume.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4", "xfs", "ntfs"。默认文件系统取决于 FlexVolume 脚本。

    • flexVolume.options (map[string]string)

      options 是 Optional:此字段包含任何额外的命令行选项。

    • flexVolume.readOnly (boolean)

      readOnly 是 Optional:默认为 false(读/写)。此处的 ReadOnly 将强制 VolumeMounts 中的 ReadOnly 设置。

    • flexVolume.secretRef (SecretReference)

      secretRef 是 Optional:SecretRef 是对包含敏感信息(用于传递给插件脚本)的 Secret 对象的引用。如果没有指定 Secret 对象,此字段可以为空。如果 Secret 对象包含多个 Secret,所有 Secret 都将被传递给插件脚本。

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • flexVolume.secretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • flexVolume.secretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

  • flocker (FlockerVolumeSource)

    flocker 表示附加到 kubelet 主机并暴露给 Pod 使用的 Flocker 卷。这依赖于 Flocker 控制服务正在运行。已弃用:Flocker 已弃用,并且不再支持树内 flocker 类型。

    表示由 Flocker 代理挂载的 Flocker 卷。datasetName 和 datasetUUID 中只能设置一个。Flocker 卷不支持所有权管理或 SELinux 重新标记。

    • flocker.datasetName (string)

      datasetName 是数据集的名称,存储为 metadata -> name 在 Flocker 数据集上的用法应视为已弃用

    • flocker.datasetUUID (string)

      datasetUUID 是数据集的 UUID。这是 Flocker 数据集的唯一标识符

  • gcePersistentDisk (GCEPersistentDiskVolumeSource)

    gcePersistentDisk 表示附加到 kubelet 主机并暴露给 Pod 的 GCE Disk 资源。由管理员提供。已废弃:GCEPersistentDisk 已被废弃。所有用于树内 gcePersistentDisk 类型操作都被重定向到 pd.csi.storage.gke.io CSI 驱动。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes#gcepersistentdisk

    *表示 Google Compute Engine 中的持久磁盘资源。

    GCE PD 必须在挂载到容器之前存在。该磁盘也必须与 kubelet 位于相同的 GCE 项目和区域中。GCE PD 只能以单次读写(read/write once)或多次只读(read-only many times)模式挂载。GCE PD 支持所有权管理和 SELinux 重新标记。*

  • glusterfs (GlusterfsPersistentVolumeSource)

    glusterfs 表示附加到主机并暴露给 Pod 的 Glusterfs 卷。由管理员提供。已废弃:Glusterfs 已被废弃,不再支持树内 glusterfs 类型。更多信息:https://examples.k8s.io/volumes/glusterfs/README.md

    *表示持续 Pod 生命周期的 Glusterfs 挂载。Glusterfs 卷不支持所有权管理或 SELinux 重新标记。*

  • iscsi (ISCSIPersistentVolumeSource)

    iscsi 表示附加到 kubelet 主机并暴露给 Pod 的 ISCSI Disk 资源。由管理员提供。

    *ISCSIPersistentVolumeSource 表示 ISCSI 磁盘。ISCSI 卷只能以单次读写(read/write once)模式挂载。ISCSI 卷支持所有权管理和 SELinux 重新标记。*

    • iscsi.iqn (string),必需

      iqn 是目标 iSCSI 限定名称。

    • iscsi.lun (int32),必需

      lun 是 iSCSI 目标 LUN 号。

    • iscsi.targetPortal (string),必需

      targetPortal 是 iSCSI 目标入口。如果端口不是默认端口(通常是 TCP 端口 860 和 3260),入口可以是 IP 地址或 ip_addr:port 格式。

    • iscsi.chapAuthDiscovery (boolean)

      chapAuthDiscovery 定义是否支持 iSCSI Discovery CHAP 身份验证

    • iscsi.chapAuthSession (boolean)

      chapAuthSession 定义是否支持 iSCSI Session CHAP 身份验证

    • iscsi.fsType (string)

      fsType 是您要挂载的卷的文件系统类型。提示:确保主机操作系统支持此文件系统类型。示例:"ext4"、"xfs"、"ntfs"。如果未指定,则隐式推断为 "ext4"。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes#iscsi

    • iscsi.initiatorName (string)

      initiatorName 是自定义的 iSCSI 启动器名称。如果同时指定了 initiatorName 和 iscsiInterface,则将创建新的 iSCSI 接口 <target portal>:<volume name> 用于连接。

    • iscsi.iscsiInterface (string)

      iscsiInterface 是使用 iSCSI 传输协议的接口名称。默认为 'default' (tcp)。

    • iscsi.portals ([]string)

      原子性:合并时将被替换

      portals 是 iSCSI 目标入口列表。如果端口不是默认端口(通常是 TCP 端口 860 和 3260),入口可以是 IP 地址或 ip_addr:port 格式。

    • iscsi.readOnly (boolean)

      此处的 readOnly 将强制 VolumeMounts 中的 ReadOnly 设置。默认为 false。

    • iscsi.secretRef (SecretReference)

      secretRef 是用于 iSCSI 目标和启动器身份验证的 CHAP Secret

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • iscsi.secretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • iscsi.secretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

  • nfs (NFSVolumeSource)

    nfs 表示主机上的 NFS 挂载。由管理员提供。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes#nfs

    *表示持续 Pod 生命周期的 NFS 挂载。NFS 卷不支持所有权管理或 SELinux 重新标记。*

  • photonPersistentDisk (PhotonPersistentDiskVolumeSource)

    photonPersistentDisk 表示附加并挂载到 kubelet 主机上的 PhotonController 持久磁盘。已废弃:PhotonPersistentDisk 已被废弃,不再支持树内 photonPersistentDisk 类型。

    *表示 Photon Controller 持久磁盘资源。*

    • photonPersistentDisk.pdID (string),必需

      pdID 是标识 Photon Controller 持久磁盘的 ID

    • photonPersistentDisk.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为 "ext4"。

  • portworxVolume (PortworxVolumeSource)

    portworxVolume 表示附加并挂载到 kubelet 主机上的 portworx 卷。已废弃:PortworxVolume 已被废弃。当 CSIMigrationPortworx 功能门开启时,所有树内 portworxVolume 类型操作都被重定向到 pxd.portworx.com CSI 驱动。

    *PortworxVolumeSource 表示 Portworx 卷资源。*

    • portworxVolume.volumeID (string),必需

      volumeID 唯一标识 Portworx 卷

    • portworxVolume.fsType (string)

      fSType 表示要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4"、"xfs"。如果未指定,则隐式推断为 "ext4"。

    • portworxVolume.readOnly (boolean)

      readOnly 默认为 false(读/写)。此处的 ReadOnly 将强制 VolumeMounts 中的 ReadOnly 设置。

  • quobyte (QuobyteVolumeSource)

    quobyte 表示主机上持续 Pod 生命周期的 Quobyte 挂载。已废弃:Quobyte 已被废弃,不再支持树内 quobyte 类型。

    *表示持续 Pod 生命周期的 Quobyte 挂载。Quobyte 卷不支持所有权管理或 SELinux 重新标记。*

    • quobyte.registry (string),必需

      registry 表示一个或多个 Quobyte Registry 服务,指定为 host:port 对组成的字符串(多个条目用逗号分隔),它作为卷的中心注册表。

    • quobyte.volume (string),必需

      volume 是通过名称引用已创建的 Quobyte 卷的字符串。

    • quobyte.group (string)

      用于映射卷访问的组。默认无组。

    • quobyte.readOnly (boolean)

      此处的 readOnly 将强制 Quobyte 卷以只读权限挂载。默认为 false。

    • quobyte.tenant (string)

      拥有后端指定 Quobyte 卷的租户。用于动态配置的 Quobyte 卷,该值由插件设置。

    • quobyte.user (string)

      用于映射卷访问的用户。默认为 serviceaccount 用户。

  • rbd (RBDPersistentVolumeSource)

    rbd 表示主机上持续 Pod 生命周期的 Rados 块设备挂载。已废弃:RBD 已被废弃,不再支持树内 rbd 类型。更多信息:https://examples.k8s.io/volumes/rbd/README.md

    *表示持续 Pod 生命周期的 Rados 块设备挂载。RBD 卷支持所有权管理和 SELinux 重新标记。*

  • scaleIO (ScaleIOPersistentVolumeSource)

    scaleIO 表示附加并挂载到 Kubernetes 节点上的 ScaleIO 持久卷。已废弃:ScaleIO 已被废弃,不再支持树内 scaleIO 类型。

    *ScaleIOPersistentVolumeSource 表示 ScaleIO 持久卷。*

    • scaleIO.gateway (string),必需

      gateway 是 ScaleIO API 网关的主机地址。

    • scaleIO.secretRef (SecretReference),必需

      secretRef 引用 ScaleIO 用户及其他敏感信息的 secret。如果未提供,登录操作将失败。

      SecretReference 表示 Secret 引用。它包含足够的信息可以在任何命名空间中检索 Secret。

      • scaleIO.secretRef.name (string)

        name 在命名空间内必须唯一,用于引用 Secret 资源。

      • scaleIO.secretRef.namespace (string)

        namespace 定义了 Secret 名称必须唯一的空间范围。

    • scaleIO.system (string),必需

      system 是在 ScaleIO 中配置的存储系统的名称。

    • scaleIO.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4"、"xfs"、"ntfs"。默认为 "xfs"。

    • scaleIO.protectionDomain (string)

      protectionDomain 是配置存储的 ScaleIO 保护域的名称。

    • scaleIO.readOnly (boolean)

      readOnly 默认为 false(读/写)。此处的 ReadOnly 将强制 VolumeMounts 中的 ReadOnly 设置。

    • scaleIO.sslEnabled (boolean)

      sslEnabled 是启用/禁用与网关的 SSL 通信的标志,默认为 false。

    • scaleIO.storageMode (string)

      storageMode 指示卷的存储应为 ThickProvisioned(厚置备)或 ThinProvisioned(精简置备)。默认为 ThinProvisioned。

    • scaleIO.storagePool (string)

      storagePool 是与保护域关联的 ScaleIO 存储池。

    • scaleIO.volumeName (string)

      volumeName 是已在 ScaleIO 系统中创建并与此卷源关联的卷的名称。

  • storageos (StorageOSPersistentVolumeSource)

    storageOS 表示附加到 kubelet 主机并挂载到 Pod 中的 StorageOS 卷。已废弃:StorageOS 已被废弃,不再支持树内 storageos 类型。更多信息:https://examples.k8s.io/volumes/storageos/README.md

    *表示 StorageOS 持久卷资源。*

    • storageos.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为 "ext4"。

    • storageos.readOnly (boolean)

      readOnly 默认为 false(读/写)。此处的 ReadOnly 将强制 VolumeMounts 中的 ReadOnly 设置。

    • storageos.secretRef (ObjectReference)

      secretRef 指定用于获取 StorageOS API 凭据的 secret。如果未指定,将尝试使用默认值。

    • storageos.volumeName (string)

      volumeName 是 StorageOS 卷的可读名称。卷名称在命名空间内唯一。

    • storageos.volumeNamespace (string)

      volumeNamespace 指定卷在 StorageOS 中的范围。如果未指定命名空间,则使用 Pod 的命名空间。这使得 Kubernetes 的命名范围可以在 StorageOS 中镜像,从而实现更紧密的集成。将 VolumeName 设置为任何名称以覆盖默认行为。如果您在 StorageOS 中不使用命名空间,则设置为 "default"。在 StorageOS 中不存在的命名空间将被创建。

  • vsphereVolume (VsphereVirtualDiskVolumeSource)

    vsphereVolume 表示附加并挂载到 kubelet 主机上的 vSphere 卷。已废弃:VsphereVolume 已被废弃。所有用于树内 vsphereVolume 类型操作都被重定向到 csi.vsphere.vmware.com CSI 驱动。

    *表示 vSphere 卷资源。*

    • vsphereVolume.volumePath (string),必需

      volumePath 是标识 vSphere 卷 vmdk 的路径。

    • vsphereVolume.fsType (string)

      fsType 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。例如:"ext4"、"xfs"、"ntfs"。如果未指定,则隐式推断为 "ext4"。

    • vsphereVolume.storagePolicyID (string)

      storagePolicyID 是与 StoragePolicyName 关联的基于存储策略的管理 (SPBM) 配置文件 ID。

    • vsphereVolume.storagePolicyName (string)

      storagePolicyName 是基于存储策略的管理 (SPBM) 配置文件名称。

PersistentVolumeStatus

PersistentVolumeStatus 是持久卷的当前状态。


  • lastPhaseTransitionTime (Time)

    lastPhaseTransitionTime 是阶段从一个转换到另一个的时间,并且每次卷阶段转换时自动重置为当前时间。

    *Time 是 time.Time 的包装器,支持正确地封送为 YAML 和 JSON。为 time 包提供的许多工厂方法提供了包装器。*

  • message (string)

    message 是一个可读消息,指示卷处于此状态的详细原因。

  • phase (string)

    phase 指示卷是可用、已绑定到 PVC 还是已被 PVC 释放。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#phase

  • reason (string)

    reason 是一个简短的 CamelCase 字符串,描述任何失败,旨在供机器解析并在 CLI 中整洁显示。

PersistentVolumeList

PersistentVolumeList 是 PersistentVolume 条目的列表。


操作 (Operations)


get 读取指定的 PersistentVolume

HTTP 请求 (HTTP Request)

GET /api/v1/persistentvolumes/{name}

参数 (Parameters)

  • name (in path): string,必需

    PersistentVolume 的名称

  • pretty (in query): string

    pretty

响应 (Response)

200 (PersistentVolume): 成功 (OK)

401: 未授权 (Unauthorized)

get 读取指定 PersistentVolume 的状态

HTTP 请求 (HTTP Request)

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

参数 (Parameters)

  • name (in path): string,必需

    PersistentVolume 的名称

  • pretty (in query): string

    pretty

响应 (Response)

200 (PersistentVolume): 成功 (OK)

401: 未授权 (Unauthorized)

list 列出或监视种类为 PersistentVolume 的对象

HTTP 请求 (HTTP Request)

GET /api/v1/persistentvolumes

参数 (Parameters)

响应 (Response)

200 (PersistentVolumeList): 成功 (OK)

401: 未授权 (Unauthorized)

create 创建 PersistentVolume

HTTP 请求 (HTTP Request)

POST /api/v1/persistentvolumes

参数 (Parameters)

响应 (Response)

200 (PersistentVolume): 成功 (OK)

201 (PersistentVolume): 已创建 (Created)

202 (PersistentVolume): 已接受 (Accepted)

401: 未授权 (Unauthorized)

update 替换指定的 PersistentVolume

HTTP 请求 (HTTP Request)

PUT /api/v1/persistentvolumes/{name}

参数 (Parameters)

响应 (Response)

200 (PersistentVolume): 成功 (OK)

201 (PersistentVolume): 已创建 (Created)

401: 未授权 (Unauthorized)

update 替换指定的 PersistentVolume 状态

HTTP 请求 (HTTP Request)

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

参数 (Parameters)

响应 (Response)

200 (PersistentVolume): 成功 (OK)

201 (PersistentVolume): 已创建 (Created)

401: 未授权 (Unauthorized)

patch 部分更新指定的 PersistentVolume

HTTP 请求 (HTTP Request)

PATCH /api/v1/persistentvolumes/{name}

参数 (Parameters)

  • name (in path): string,必需

    PersistentVolume 的名称

  • body: Patch,必需

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • fieldValidation (in query): string

    fieldValidation

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

响应 (Response)

200 (PersistentVolume): 成功 (OK)

201 (PersistentVolume): 已创建 (Created)

401: 未授权 (Unauthorized)

patch 部分更新指定的 PersistentVolume 状态

HTTP 请求 (HTTP Request)

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

参数 (Parameters)

  • name (in path): string,必需

    PersistentVolume 的名称

  • body: Patch,必需

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • fieldValidation (in query): string

    fieldValidation

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

响应 (Response)

200 (PersistentVolume): 成功 (OK)

201 (PersistentVolume): 已创建 (Created)

401: 未授权 (Unauthorized)

delete 删除 PersistentVolume

HTTP 请求 (HTTP Request)

DELETE /api/v1/persistentvolumes/{name}

参数 (Parameters)

响应 (Response)

200 (PersistentVolume): 成功 (OK)

202 (PersistentVolume): 已接受 (Accepted)

401: 未授权 (Unauthorized)

deletecollection 删除 PersistentVolume 集合

HTTP 请求 (HTTP Request)

DELETE /api/v1/persistentvolumes

参数 (Parameters)

响应 (Response)

200 (Status): 成功 (OK)

401: 未授权 (Unauthorized)

此页面是自动生成的。

如果您打算报告此页面存在问题,请在问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

最后修改于 2025 年 4 月 9 日太平洋标准时间下午 6:36:更新 v1.32 的 API 参考文档 (a3b579d035)