v1beta1

package
v1.15.0-kw9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 25, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

View Source 
const GroupName = "storage.k8s.io"

GroupName is the group name use in this package

Variables

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CSIDriver 

type CSIDriver struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the CSI Driver.
	// Required: true
	Spec *CSIDriverSpec `json:"spec"`
}

CSIDriver CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.

swagger:model CSIDriver

func (*CSIDriver) GroupVersionKind 

func (v *CSIDriver) GroupVersionKind() schema.GroupVersionKind

type CSIDriverList 

type CSIDriverList struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// items is the list of CSIDriver
	// Required: true
	Items []*CSIDriver `json:"items"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

CSIDriverList CSIDriverList is a collection of CSIDriver objects.

swagger:model CSIDriverList

func (*CSIDriverList) GroupVersionKind 

func (v *CSIDriverList) GroupVersionKind() schema.GroupVersionKind

type CSIDriverSpec 

type CSIDriverSpec struct {

	// 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.
	AttachRequired bool `json:"attachRequired,omitempty"`

	// 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)
	PodInfoOnMount bool `json:"podInfoOnMount,omitempty"`
}

CSIDriverSpec CSIDriverSpec is the specification of a CSIDriver.

swagger:model CSIDriverSpec

type CSINode 

type CSINode struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata.name must be the Kubernetes node name.
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// spec is the specification of CSINode
	// Required: true
	Spec *CSINodeSpec `json:"spec"`
}

CSINode CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object.

swagger:model CSINode

func (*CSINode) GroupVersionKind 

func (v *CSINode) GroupVersionKind() schema.GroupVersionKind

type CSINodeDriver 

type CSINodeDriver struct {

	// 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.
	// Required: true
	Name *string `json:"name"`

	// 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.
	// Required: true
	NodeID *string `json:"nodeID"`

	// 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.
	TopologyKeys []string `json:"topologyKeys,omitempty"`
}

CSINodeDriver CSINodeDriver holds information about the specification of one CSI driver installed on a node

swagger:model CSINodeDriver

type CSINodeList 

type CSINodeList struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// items is the list of CSINode
	// Required: true
	Items []*CSINode `json:"items"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

CSINodeList CSINodeList is a collection of CSINode objects.

swagger:model CSINodeList

func (*CSINodeList) GroupVersionKind 

func (v *CSINodeList) GroupVersionKind() schema.GroupVersionKind

type CSINodeSpec 

type CSINodeSpec struct {

	// drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.
	// Required: true
	Drivers []*CSINodeDriver `json:"drivers"`
}

CSINodeSpec CSINodeSpec holds information about the specification of all CSI drivers installed on a node

swagger:model CSINodeSpec

type StorageClass 

type StorageClass struct {

	// AllowVolumeExpansion shows whether the storage class allow volume expand
	AllowVolumeExpansion bool `json:"allowVolumeExpansion,omitempty"`

	// Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
	AllowedTopologies []*api_core_v1.TopologySelectorTerm `json:"allowedTopologies,omitempty"`

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
	MountOptions []string `json:"mountOptions,omitempty"`

	// Parameters holds the parameters for the provisioner that should create volumes of this storage class.
	Parameters map[string]string `json:"parameters,omitempty"`

	// Provisioner indicates the type of the provisioner.
	// Required: true
	Provisioner *string `json:"provisioner"`

	// Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
	ReclaimPolicy string `json:"reclaimPolicy,omitempty"`

	// VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound.  When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
	VolumeBindingMode string `json:"volumeBindingMode,omitempty"`
}

StorageClass StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

swagger:model StorageClass

func (*StorageClass) GroupVersionKind 

func (v *StorageClass) GroupVersionKind() schema.GroupVersionKind

type StorageClassList 

type StorageClassList struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Items is the list of StorageClasses
	// Required: true
	Items []*StorageClass `json:"items"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

StorageClassList StorageClassList is a collection of storage classes.

swagger:model StorageClassList

func (*StorageClassList) GroupVersionKind 

func (v *StorageClassList) GroupVersionKind() schema.GroupVersionKind

type VolumeAttachment 

type VolumeAttachment struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
	// Required: true
	Spec *VolumeAttachmentSpec `json:"spec"`

	// Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
	Status *VolumeAttachmentStatus `json:"status,omitempty"`
}

VolumeAttachment VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment objects are non-namespaced.

swagger:model VolumeAttachment

func (*VolumeAttachment) GroupVersionKind 

func (v *VolumeAttachment) GroupVersionKind() schema.GroupVersionKind

type VolumeAttachmentList 

type VolumeAttachmentList struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Items is the list of VolumeAttachments
	// Required: true
	Items []*VolumeAttachment `json:"items"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

VolumeAttachmentList VolumeAttachmentList is a collection of VolumeAttachment objects.

swagger:model VolumeAttachmentList

func (*VolumeAttachmentList) GroupVersionKind 

func (v *VolumeAttachmentList) GroupVersionKind() schema.GroupVersionKind

type VolumeAttachmentSource 

type VolumeAttachmentSource struct {

	// inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature.
	InlineVolumeSpec *api_core_v1.PersistentVolumeSpec `json:"inlineVolumeSpec,omitempty"`

	// Name of the persistent volume to attach.
	PersistentVolumeName string `json:"persistentVolumeName,omitempty"`
}

VolumeAttachmentSource VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.

swagger:model VolumeAttachmentSource

type VolumeAttachmentSpec 

type VolumeAttachmentSpec struct {

	// Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
	// Required: true
	Attacher *string `json:"attacher"`

	// The node that the volume should be attached to.
	// Required: true
	NodeName *string `json:"nodeName"`

	// Source represents the volume that should be attached.
	// Required: true
	Source *VolumeAttachmentSource `json:"source"`
}

VolumeAttachmentSpec VolumeAttachmentSpec is the specification of a VolumeAttachment request.

swagger:model VolumeAttachmentSpec

type VolumeAttachmentStatus 

type VolumeAttachmentStatus struct {

	// The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
	AttachError *VolumeError `json:"attachError,omitempty"`

	// Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
	// Required: true
	Attached *bool `json:"attached"`

	// Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
	AttachmentMetadata map[string]string `json:"attachmentMetadata,omitempty"`

	// The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
	DetachError *VolumeError `json:"detachError,omitempty"`
}

VolumeAttachmentStatus VolumeAttachmentStatus is the status of a VolumeAttachment request.

swagger:model VolumeAttachmentStatus

type VolumeError 

type VolumeError struct {

	// String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
	Message string `json:"message,omitempty"`

	// Time the error was encountered.
	Time *apimachinery_pkg_apis_meta_v1.Time `json:"time,omitempty"`
}

VolumeError VolumeError captures an error encountered during a volume operation.

swagger:model VolumeError

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.