Package com.marcnuri.yakc.model.io.k8s.api.storage.v1beta1

Class CSIDriverSpec.Builder

  • Enclosing class:
    CSIDriverSpec
    public static class CSIDriverSpec.Builder
extends java.lang.Object

    • Method Detail

      • attachRequired

        public CSIDriverSpec.Builder attachRequired​(java.lang.Boolean attachRequired)
        attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called.


        This field is immutable.

        Returns:
        this.

      • fsGroupPolicy

        public CSIDriverSpec.Builder fsGroupPolicy​(java.lang.String fsGroupPolicy)
        Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate.


        This field is immutable.

        Returns:
        this.

      • podInfoOnMount

        public CSIDriverSpec.Builder podInfoOnMount​(java.lang.Boolean podInfoOnMount)
        If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume

        defined by a CSIVolumeSource, otherwise "false"


        "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver.


        This field is immutable.

        Returns:
        this.

      • requiresRepublish

        public CSIDriverSpec.Builder requiresRepublish​(java.lang.Boolean requiresRepublish)
        RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false.


        Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.


        This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.

        Returns:
        this.

      • storageCapacity

        public CSIDriverSpec.Builder storageCapacity​(java.lang.Boolean storageCapacity)
        If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information.


        The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object.


        Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published.


        This field is immutable.


        This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.

        Returns:
        this.

      • addToVolumeLifecycleModes

        public CSIDriverSpec.Builder addToVolumeLifecycleModes​(java.lang.String addToVolumeLifecycleModes)

      • volumeLifecycleModes

        public CSIDriverSpec.Builder volumeLifecycleModes​(java.util.Collection<? extends java.lang.String> volumeLifecycleModes)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object