v1alpha1

package
v1.21.0-kw6 Latest Latest
Warning

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

 Go to latest Published: Mar 23, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CSIStorageCapacity 

type CSIStorageCapacity 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/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
	//
	// The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.
	Capacity *apimachinery_pkg_api_resource.Quantity `json:"capacity,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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
	//
	// This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.
	MaximumVolumeSize *apimachinery_pkg_api_resource.Quantity `json:"maximumVolumeSize,omitempty"`

	// Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name.
	//
	// Objects are namespaced.
	//
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.
	NodeTopology *apimachinery_pkg_apis_meta_v1.LabelSelector `json:"nodeTopology,omitempty"`

	// The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
	// Required: true
	StorageClassName *string `json:"storageClassName"`
}

CSIStorageCapacity CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes.

For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123"

The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero

The producer of these objects can decide which approach is more suitable.

They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.

swagger:model CSIStorageCapacity

func (CSIStorageCapacity) MarshalEasyJSON 

func (v CSIStorageCapacity) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CSIStorageCapacity) MarshalJSON 

func (v CSIStorageCapacity) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CSIStorageCapacity) UnmarshalEasyJSON 

func (v *CSIStorageCapacity) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CSIStorageCapacity) UnmarshalJSON 

func (v *CSIStorageCapacity) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type CSIStorageCapacityList 

type CSIStorageCapacityList 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/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Items is the list of CSIStorageCapacity objects.
	// Required: true
	Items []*CSIStorageCapacity `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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

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

CSIStorageCapacityList CSIStorageCapacityList is a collection of CSIStorageCapacity objects.

swagger:model CSIStorageCapacityList

func (CSIStorageCapacityList) MarshalEasyJSON 

func (v CSIStorageCapacityList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CSIStorageCapacityList) MarshalJSON 

func (v CSIStorageCapacityList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CSIStorageCapacityList) UnmarshalEasyJSON 

func (v *CSIStorageCapacityList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CSIStorageCapacityList) UnmarshalJSON 

func (v *CSIStorageCapacityList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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) MarshalEasyJSON 

func (v VolumeAttachment) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (VolumeAttachment) MarshalJSON 

func (v VolumeAttachment) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*VolumeAttachment) UnmarshalEasyJSON 

func (v *VolumeAttachment) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*VolumeAttachment) UnmarshalJSON 

func (v *VolumeAttachment) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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) MarshalEasyJSON 

func (v VolumeAttachmentList) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (VolumeAttachmentList) MarshalJSON 

func (v VolumeAttachmentList) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*VolumeAttachmentList) UnmarshalEasyJSON 

func (v *VolumeAttachmentList) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*VolumeAttachmentList) UnmarshalJSON 

func (v *VolumeAttachmentList) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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

func (VolumeAttachmentSource) MarshalEasyJSON 

func (v VolumeAttachmentSource) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (VolumeAttachmentSource) MarshalJSON 

func (v VolumeAttachmentSource) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*VolumeAttachmentSource) UnmarshalEasyJSON 

func (v *VolumeAttachmentSource) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*VolumeAttachmentSource) UnmarshalJSON 

func (v *VolumeAttachmentSource) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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

func (VolumeAttachmentSpec) MarshalEasyJSON 

func (v VolumeAttachmentSpec) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (VolumeAttachmentSpec) MarshalJSON 

func (v VolumeAttachmentSpec) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*VolumeAttachmentSpec) UnmarshalEasyJSON 

func (v *VolumeAttachmentSpec) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*VolumeAttachmentSpec) UnmarshalJSON 

func (v *VolumeAttachmentSpec) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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

func (VolumeAttachmentStatus) MarshalEasyJSON 

func (v VolumeAttachmentStatus) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (VolumeAttachmentStatus) MarshalJSON 

func (v VolumeAttachmentStatus) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*VolumeAttachmentStatus) UnmarshalEasyJSON 

func (v *VolumeAttachmentStatus) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*VolumeAttachmentStatus) UnmarshalJSON 

func (v *VolumeAttachmentStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type VolumeError 

type VolumeError struct {

	// String detailing the error encountered during Attach or Detach operation. This string maybe 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

func (VolumeError) MarshalEasyJSON 

func (v VolumeError) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (VolumeError) MarshalJSON 

func (v VolumeError) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*VolumeError) UnmarshalEasyJSON 

func (v *VolumeError) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*VolumeError) UnmarshalJSON 

func (v *VolumeError) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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.