Skip to content

Commit

Permalink
Update alpha/beta fields
Browse files Browse the repository at this point in the history
  • Loading branch information
feloy committed Mar 30, 2021
1 parent a6c947a commit 8fea4ca
Show file tree
Hide file tree
Showing 3 changed files with 152 additions and 161 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,93 @@ PersistentVolumeSpec is the specification of a persistent volume.

Namespace defines the space within which the secret name must be unique.

- **csi** (CSIPersistentVolumeSource)

CSI represents storage that is handled by an external CSI driver (Beta feature).

<a name="CSIPersistentVolumeSource"></a>
*Represents storage that is managed by an external CSI volume driver (Beta feature)*

- **csi.driver** (string), required

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 plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

- **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 alpha 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.

- **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>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*

- **csi.controllerPublishSecretRef.name** (string)

Name is unique within a namespace to reference a secret resource.

- **csi.controllerPublishSecretRef.namespace** (string)

Namespace defines the space within which the secret name must be unique.

- **csi.fsType** (string)

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".

- **csi.nodePublishSecretRef** (SecretReference)

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume 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>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*

- **csi.nodePublishSecretRef.name** (string)

Name is unique within a namespace to reference a secret resource.

- **csi.nodePublishSecretRef.namespace** (string)

Namespace defines the space within which the secret name must be unique.

- **csi.nodeStageSecretRef** (SecretReference)

NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume 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>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*

- **csi.nodeStageSecretRef.name** (string)

Name is unique within a namespace to reference a secret resource.

- **csi.nodeStageSecretRef.namespace** (string)

Namespace defines the space within which the secret name must be unique.

- **csi.readOnly** (boolean)

Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).

- **csi.volumeAttributes** (map[string]string)

Attributes of the volume to publish.

- **fc** (FCVolumeSource)

FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
Expand Down Expand Up @@ -730,96 +817,6 @@ PersistentVolumeSpec is the specification of a persistent volume.

Storage Policy Based Management (SPBM) profile name.

### Beta level


- **csi** (CSIPersistentVolumeSource)

CSI represents storage that is handled by an external CSI driver (Beta feature).

<a name="CSIPersistentVolumeSource"></a>
*Represents storage that is managed by an external CSI volume driver (Beta feature)*

- **csi.driver** (string), required

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 plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

- **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 alpha 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.

- **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>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*

- **csi.controllerPublishSecretRef.name** (string)

Name is unique within a namespace to reference a secret resource.

- **csi.controllerPublishSecretRef.namespace** (string)

Namespace defines the space within which the secret name must be unique.

- **csi.fsType** (string)

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".

- **csi.nodePublishSecretRef** (SecretReference)

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume 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>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*

- **csi.nodePublishSecretRef.name** (string)

Name is unique within a namespace to reference a secret resource.

- **csi.nodePublishSecretRef.namespace** (string)

Namespace defines the space within which the secret name must be unique.

- **csi.nodeStageSecretRef** (SecretReference)

NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume 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>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*

- **csi.nodeStageSecretRef.name** (string)

Name is unique within a namespace to reference a secret resource.

- **csi.nodeStageSecretRef.namespace** (string)

Namespace defines the space within which the secret name must be unique.

- **csi.readOnly** (boolean)

Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).

- **csi.volumeAttributes** (map[string]string)

Attributes of the volume to publish.



## PersistentVolumeStatus {#PersistentVolumeStatus}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,33 @@ Volume represents a named volume in a pod that may be accessed by any container

Optional: points to a secret object containing parameters used to connect to OpenStack.

- **csi** (CSIVolumeSource)

CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

<a name="CSIVolumeSource"></a>
*Represents a source location of a volume to mount, managed by an external CSI driver*

- **csi.driver** (string), required

Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.

- **csi.fsType** (string)

Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

- **csi.nodePublishSecretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

- **csi.readOnly** (boolean)

Specifies a read-only configuration for the volume. Defaults to false (read/write).

- **csi.volumeAttributes** (map[string]string)

VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

- **fc** (FCVolumeSource)

FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
Expand Down Expand Up @@ -751,36 +778,6 @@ Volume represents a named volume in a pod that may be accessed by any container

Storage Policy Based Management (SPBM) profile name.

### Beta level


- **csi** (CSIVolumeSource)

CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

<a name="CSIVolumeSource"></a>
*Represents a source location of a volume to mount, managed by an external CSI driver*

- **csi.driver** (string), required

Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.

- **csi.fsType** (string)

Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

- **csi.nodePublishSecretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

- **csi.readOnly** (boolean)

Specifies a read-only configuration for the volume. Defaults to false (read/write).

- **csi.volumeAttributes** (map[string]string)

VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

### Alpha level


Expand Down
Loading

0 comments on commit 8fea4ca

Please sign in to comment.