Merge pull request #41127 from Zhuzhenghao/cleanup/persistent-volume-v1

[zh] cleanup page persistent-volume-v1
This commit is contained in:
Kubernetes Prow Robot 2023-05-15 21:39:36 -07:00 committed by GitHub
commit a0ee7e897f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 238 additions and 173 deletions

View File

@ -76,6 +76,7 @@ PersistentVolumeSpec 是持久卷的规约。
accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
- **capacity** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
-->
- **accessModes** ([]string)
@ -90,6 +91,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **claimRef** (<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
- **mountOptions** ([]string)
@ -131,17 +133,20 @@ PersistentVolumeSpec 是持久卷的规约。
*A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
- **nodeAffinity.required.nodeSelectorTerms** ([]NodeSelectorTerm), required
Required. A list of node selector terms. The terms are ORed.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **nodeAffinity.required.nodeSelectorTerms.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
A list of node selector requirements by node's labels.
- **nodeAffinity.required.nodeSelectorTerms.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
A list of node selector requirements by node's fields.
-->
- **nodeAffinity.required** (NodeSelector)
required 指定必须满足的硬性节点约束。
@ -210,6 +215,7 @@ PersistentVolumeSpec 是持久卷的规约。
path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- **hostPath.type** (string)
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
-->
@ -234,6 +240,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **local** (LocalVolumeSource)
local represents directly-attached storage with node affinity
<a name="LocalVolumeSource"></a>
@ -243,6 +250,7 @@ PersistentVolumeSpec 是持久卷的规约。
path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
- **local.fsType** (string)
fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified.
-->
@ -265,6 +273,8 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
### Persistent volumes
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
@ -274,6 +284,7 @@ PersistentVolumeSpec 是持久卷的规约。
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.*
-->
### 持久卷 {#persistent-volumes}
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
awsElasticBlockStore 表示挂接到 kubelet 的主机随后暴露给 Pod 的一个 AWS Disk 资源。
@ -286,15 +297,19 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **awsElasticBlockStore.volumeID** (string), required
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- **awsElasticBlockStore.fsType** (string)
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- **awsElasticBlockStore.partition** (int32)
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- **awsElasticBlockStore.readOnly** (boolean)
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
-->
@ -322,6 +337,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **azureDisk** (AzureDiskVolumeSource)
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
<a name="AzureDiskVolumeSource"></a>
@ -343,15 +359,19 @@ PersistentVolumeSpec 是持久卷的规约。
diskURI is the URI of data disk in the blob storage
- **azureDisk.cachingMode** (string)
cachingMode is the Host Caching mode: None, Read Only, Read Write.
- **azureDisk.fsType** (string)
fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **azureDisk.kind** (string)
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
- **azureDisk.readOnly** (boolean)
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-->
@ -386,6 +406,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **azureFile** (AzureFilePersistentVolumeSource)
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
<a name="AzureFilePersistentVolumeSource"></a>
*AzureFile represents an Azure File Service mount on the host and bind mount to the pod.*
@ -397,9 +418,11 @@ PersistentVolumeSpec 是持久卷的规约。
shareName is the azure Share Name
- **azureFile.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **azureFile.secretNamespace** (string)
secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
-->
@ -428,6 +451,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **cephfs** (CephFSPersistentVolumeSource)
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
<a name="CephFSPersistentVolumeSource"></a>
@ -446,12 +470,14 @@ PersistentVolumeSpec 是持久卷的规约。
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.path** (string)
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- **cephfs.readOnly** (boolean)
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.secretFile** (string)
secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
-->
@ -476,6 +502,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **cephfs.secretRef** (SecretReference)
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
<a name="SecretReference"></a>
@ -488,6 +515,7 @@ PersistentVolumeSpec 是持久卷的规约。
namespace defines the space within which the secret name must be unique.
- **cephfs.user** (string)
user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
-->
@ -514,6 +542,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **cinder** (CinderPersistentVolumeSource)
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
<a name="CinderPersistentVolumeSource"></a>
@ -534,6 +563,7 @@ PersistentVolumeSpec 是持久卷的规约。
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- **cinder.fsType** (string)
fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- **cinder.readOnly** (boolean)
@ -568,6 +598,7 @@ PersistentVolumeSpec 是持久卷的规约。
name is unique within a namespace to reference a secret resource.
- **cinder.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
-->
@ -597,6 +628,7 @@ PersistentVolumeSpec 是持久卷的规约。
driver is the name of the driver to use for this volume. Required.
- **csi.volumeHandle** (string), required
volumeHandle is the unique volume name returned by the CSI volume plugins CreateVolume to refer to the volume on all subsequent calls. Required.
-->
@ -617,15 +649,18 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **csi.controllerExpandSecretRef** (SecretReference)
controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an beta field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.controllerExpandSecretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **csi.controllerExpandSecretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
-->
@ -650,6 +685,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **csi.controllerPublishSecretRef** (SecretReference)
controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
@ -792,6 +828,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **csi.readOnly** (boolean)
readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
- **csi.volumeAttributes** (map[string]string)
@ -823,18 +860,23 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **fc.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **fc.lun** (int32)
lun is Optional: FC target lun number
- **fc.readOnly** (boolean)
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **fc.targetWWNs** ([]string)
targetWWNs is Optional: FC target worldwide names (WWNs)
- **fc.wwids** ([]string)
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
-->
@ -863,6 +905,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **flexVolume** (FlexPersistentVolumeSource)
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
<a name="FlexPersistentVolumeSource"></a>
@ -884,9 +927,11 @@ PersistentVolumeSpec 是持久卷的规约。
fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
- **flexVolume.options** (map[string]string)
options is Optional: this field holds extra command options if any.
- **flexVolume.readOnly** (boolean)
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
-->
@ -910,6 +955,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **flexVolume.secretRef** (SecretReference)
secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
<a name="SecretReference"></a>
@ -919,6 +965,7 @@ PersistentVolumeSpec 是持久卷的规约。
name is unique within a namespace to reference a secret resource.
- **flexVolume.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
-->
@ -949,6 +996,7 @@ PersistentVolumeSpec 是持久卷的规约。
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
- **flocker.datasetUUID** (string)
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
-->
@ -1002,7 +1050,7 @@ PersistentVolumeSpec 是持久卷的规约。
- **gcePersistentDisk.readOnly** (boolean)
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
-->
-->
- **gcePersistentDisk.pdName** (string),必需
@ -1028,9 +1076,11 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **iscsi** (ISCSIPersistentVolumeSource)
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
<a name="ISCSIPersistentVolumeSource"></a>
*ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.*
-->
@ -1067,9 +1117,11 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **iscsi.chapAuthDiscovery** (boolean)
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- **iscsi.chapAuthSession** (boolean)
chapAuthSession defines whether support iSCSI Session CHAP authentication
- **iscsi.fsType** (string)
@ -1092,15 +1144,18 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **iscsi.initiatorName** (string)
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface \<target portal>:\<volume name> will be created for the connection.
- **iscsi.iscsiInterface** (string)
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
- **iscsi.portals** ([]string)
portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- **iscsi.readOnly** (boolean)
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
-->
@ -1124,6 +1179,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **iscsi.secretRef** (SecretReference)
secretRef is the CHAP Secret for iSCSI target and initiator authentication
<a name="SecretReference"></a>
@ -1133,6 +1189,7 @@ PersistentVolumeSpec 是持久卷的规约。
name is unique within a namespace to reference a secret resource.
- **iscsi.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
-->
@ -1165,6 +1222,7 @@ PersistentVolumeSpec 是持久卷的规约。
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- **nfs.readOnly** (boolean)
readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
-->
@ -1260,6 +1318,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **quobyte** (QuobyteVolumeSource)
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
<a name="QuobyteVolumeSource"></a>
@ -1352,6 +1411,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **rbd.fsType** (string)
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- **rbd.keyring** (string)
@ -1387,6 +1447,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **rbd.secretRef** (SecretReference)
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
<a name="SecretReference"></a>
@ -1425,6 +1486,7 @@ PersistentVolumeSpec 是持久卷的规约。
<!--
- **scaleIO** (ScaleIOPersistentVolumeSource)
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
<a name="ScaleIOPersistentVolumeSource"></a>
@ -1639,6 +1701,7 @@ PersistentVolumeSpec 是持久卷的规约。
storagePolicyName 是基于存储策略的管理SPBM配置文件名称。
## PersistentVolumeStatus {#PersistentVolumeStatus}
<!--
PersistentVolumeStatus is the current status of a persistent volume.
-->
@ -1717,6 +1780,7 @@ GET /api/v1/persistentvolumes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **pretty** (*in query*): string
-->
#### 参数
@ -1748,6 +1812,7 @@ GET /api/v1/persistentvolumes/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **pretty** (*in query*): string
-->
#### 参数