csi_driver_spec.cr

# THIS FILE WAS AUTO GENERATED FROM THE K8S SWAGGER SPEC

require "yaml"
require "json"

module K8S
  # CSIDriverSpec is the specification of a CSIDriver.
  @[::K8S::Properties(
    attach_required: {type: Bool, nilable: true, key: "attachRequired", getter: false, setter: false},
    fs_group_policy: {type: String, nilable: true, key: "fsGroupPolicy", getter: false, setter: false},
    pod_info_on_mount: {type: Bool, nilable: true, key: "podInfoOnMount", getter: false, setter: false},
    requires_republish: {type: Bool, nilable: true, key: "requiresRepublish", getter: false, setter: false},
    storage_capacity: {type: Bool, nilable: true, key: "storageCapacity", getter: false, setter: false},
    token_requests: {type: Array(Api::Storage::V1::TokenRequest), nilable: true, key: "tokenRequests", getter: false, setter: false},
    volume_lifecycle_modes: {type: Array(String), nilable: true, key: "volumeLifecycleModes", getter: false, setter: false},
  )]
  class Api::Storage::V1::CSIDriverSpec
    include ::JSON::Serializable
    include ::YAML::Serializable

    # 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.
    @[::JSON::Field(key: "attachRequired", emit_null: false)]
    @[::YAML::Field(key: "attachRequired", emit_null: false)]
    property attach_required : Bool | Nil

    # 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 beta, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate.
    #
    # 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.
    @[::JSON::Field(key: "fsGroupPolicy", emit_null: false)]
    @[::YAML::Field(key: "fsGroupPolicy", emit_null: false)]
    property fs_group_policy : String | Nil

    # 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]("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.]("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.
    @[::JSON::Field(key: "podInfoOnMount", emit_null: false)]
    @[::YAML::Field(key: "podInfoOnMount", emit_null: false)]
    property pod_info_on_mount : Bool | Nil

    # 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.
    @[::JSON::Field(key: "requiresRepublish", emit_null: false)]
    @[::YAML::Field(key: "requiresRepublish", emit_null: false)]
    property requires_republish : Bool | Nil

    # 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.
    @[::JSON::Field(key: "storageCapacity", emit_null: false)]
    @[::YAML::Field(key: "storageCapacity", emit_null: false)]
    property storage_capacity : Bool | Nil

    # 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": {]("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.
    @[::JSON::Field(key: "tokenRequests", emit_null: false)]
    @[::YAML::Field(key: "tokenRequests", emit_null: false)]
    property token_requests : Array(Api::Storage::V1::TokenRequest) | Nil

    # 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.](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.
    @[::JSON::Field(key: "volumeLifecycleModes", emit_null: false)]
    @[::YAML::Field(key: "volumeLifecycleModes", emit_null: false)]
    property volume_lifecycle_modes : Array(String) | Nil

    def initialize(*, @attach_required : Bool | Nil = nil, @fs_group_policy : String | Nil = nil, @pod_info_on_mount : Bool | Nil = nil, @requires_republish : Bool | Nil = nil, @storage_capacity : Bool | Nil = nil, @token_requests : Array | Nil = nil, @volume_lifecycle_modes : Array | Nil = nil)
    end
  end
end