Package io.micronaut.kubernetes.client.openapi.model

Class V1CSIDriverSpec

java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1CSIDriverSpec
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen") public class V1CSIDriverSpec extends Object
CSIDriverSpec is the specification of a CSIDriver.

  • Field Details

  • Constructor Details

    • V1CSIDriverSpec

      public V1CSIDriverSpec()

  • Method Details

    • getAttachRequired

      public Boolean getAttachRequired()
      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:
      the attachRequired property value

    • setAttachRequired

      public void setAttachRequired(Boolean attachRequired)
      Set the attachRequired property value
      Parameters:
      attachRequired - property value to set

    • attachRequired

      public V1CSIDriverSpec attachRequired(Boolean attachRequired)
      Set attachRequired in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • getFsGroupPolicy

      public String getFsGroupPolicy()
      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 immutable. Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce.
      Returns:
      the fsGroupPolicy property value

    • setFsGroupPolicy

      public void setFsGroupPolicy(String fsGroupPolicy)
      Set the fsGroupPolicy property value
      Parameters:
      fsGroupPolicy - property value to set

    • fsGroupPolicy

      public V1CSIDriverSpec fsGroupPolicy(String fsGroupPolicy)
      Set fsGroupPolicy in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • getPodInfoOnMount

      public Boolean getPodInfoOnMount()
      podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. 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:
      the podInfoOnMount property value

    • setPodInfoOnMount

      public void setPodInfoOnMount(Boolean podInfoOnMount)
      Set the podInfoOnMount property value
      Parameters:
      podInfoOnMount - property value to set

    • podInfoOnMount

      public V1CSIDriverSpec podInfoOnMount(Boolean podInfoOnMount)
      Set podInfoOnMount in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • getRequiresRepublish

      public Boolean getRequiresRepublish()
      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.
      Returns:
      the requiresRepublish property value

    • setRequiresRepublish

      public void setRequiresRepublish(Boolean requiresRepublish)
      Set the requiresRepublish property value
      Parameters:
      requiresRepublish - property value to set

    • requiresRepublish

      public V1CSIDriverSpec requiresRepublish(Boolean requiresRepublish)
      Set requiresRepublish in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • getSeLinuxMount

      public Boolean getSeLinuxMount()
      seLinuxMount specifies if the CSI driver supports \"-o context\" mount option. When \"true\", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with \"-o context=xyz\" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context. When \"false\", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem. Default is \"false\".
      Returns:
      the seLinuxMount property value

    • setSeLinuxMount

      public void setSeLinuxMount(Boolean seLinuxMount)
      Set the seLinuxMount property value
      Parameters:
      seLinuxMount - property value to set

    • seLinuxMount

      public V1CSIDriverSpec seLinuxMount(Boolean seLinuxMount)
      Set seLinuxMount in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • getStorageCapacity

      public Boolean getStorageCapacity()
      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, if set to true. 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 was immutable in Kubernetes <= 1.22 and now is mutable.
      Returns:
      the storageCapacity property value

    • setStorageCapacity

      public void setStorageCapacity(Boolean storageCapacity)
      Set the storageCapacity property value
      Parameters:
      storageCapacity - property value to set

    • storageCapacity

      public V1CSIDriverSpec storageCapacity(Boolean storageCapacity)
      Set storageCapacity in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • getTokenRequests

      public List<@Valid StorageV1TokenRequest> getTokenRequests()
      tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: \"csi.storage.k8s.io/serviceAccount.tokens\": { \"<audience>\": { \"token\": <token>, \"expirationTimestamp\": <expiration timestamp in RFC3339>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.
      Returns:
      the tokenRequests property value

    • setTokenRequests

      public void setTokenRequests(List<@Valid StorageV1TokenRequest> tokenRequests)
      Set the tokenRequests property value
      Parameters:
      tokenRequests - property value to set

    • tokenRequests

      public V1CSIDriverSpec tokenRequests(List<@Valid StorageV1TokenRequest> tokenRequests)
      Set tokenRequests in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • addtokenRequestsItem

      public V1CSIDriverSpec addtokenRequestsItem(StorageV1TokenRequest tokenRequestsItem)
      Add an item to the tokenRequests property in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • getVolumeLifecycleModes

      public List<@NotNull String> getVolumeLifecycleModes()
      volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is \"Persistent\", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is \"Ephemeral\". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta. This field is immutable.
      Returns:
      the volumeLifecycleModes property value

    • setVolumeLifecycleModes

      public void setVolumeLifecycleModes(List<@NotNull String> volumeLifecycleModes)
      Set the volumeLifecycleModes property value
      Parameters:
      volumeLifecycleModes - property value to set

    • volumeLifecycleModes

      public V1CSIDriverSpec volumeLifecycleModes(List<@NotNull String> volumeLifecycleModes)
      Set volumeLifecycleModes in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • addvolumeLifecycleModesItem

      public V1CSIDriverSpec addvolumeLifecycleModesItem(String volumeLifecycleModesItem)
      Add an item to the volumeLifecycleModes property in a chainable fashion.
      Returns:
      The same instance of V1CSIDriverSpec for chaining.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object