csi_node_driver.cr

# THIS FILE WAS AUTO GENERATED FROM THE K8S SWAGGER SPEC

require "yaml"
require "json"

module K8S
  # CSINodeDriver holds information about the specification of one CSI driver installed on a node
  @[::K8S::Properties(
    allocatable: {type: Api::Storage::V1::VolumeNodeResources, nilable: true, key: "allocatable", getter: false, setter: false},
    name: {type: String, nilable: false, key: "name", getter: false, setter: false},
    node_id: {type: String, nilable: false, key: "nodeID", getter: false, setter: false},
    topology_keys: {type: Array(String), nilable: true, key: "topologyKeys", getter: false, setter: false},
  )]
  class Api::Storage::V1::CSINodeDriver
    include ::JSON::Serializable
    include ::YAML::Serializable

    # allocatable represents the volume resources of a node that are available for scheduling. This field is beta.
    @[::JSON::Field(key: "allocatable", emit_null: false)]
    @[::YAML::Field(key: "allocatable", emit_null: false)]
    property allocatable : Api::Storage::V1::VolumeNodeResources | Nil

    # This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
    @[::JSON::Field(key: "name", emit_null: true)]
    @[::YAML::Field(key: "name", emit_null: true)]
    property name : String

    # nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
    @[::JSON::Field(key: "nodeID", emit_null: true)]
    @[::YAML::Field(key: "nodeID", emit_null: true)]
    property node_id : String

    # topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. ["company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.]("company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.)
    @[::JSON::Field(key: "topologyKeys", emit_null: false)]
    @[::YAML::Field(key: "topologyKeys", emit_null: false)]
    property topology_keys : Array(String) | Nil

    def initialize(*, @name : String, @node_id : String, @allocatable : Api::Storage::V1::VolumeNodeResources | Nil = nil, @topology_keys : Array | Nil = nil)
    end
  end
end