v1alpha1

package
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: May 30, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the k8storagex.mgoltzsche.github.com v1alpha1 API group +kubebuilder:object:generate=true +groupName=k8storagex.mgoltzsche.github.com

Index

Constants

View Source 
const (
	CachePhaseReady       CachePhase = "ready"
	CachePhaseReject      CachePhase = "reject"
	VolumePhaseMount                 = "mount"
	VolumePhaseCommit                = "commit"
	CacheFinalizer                   = "k8storagex.mgoltzsche.github.com/finalizer"
	ConditionStorageReset            = "StorageReset"
	ConditionPodsCleared             = "PodsCleared"
)
View Source 
const (
	ConditionConfigured                         = "Configured"
	AnnotationPersistentVolumeClaimNoProtection = "k8storagex.mgoltzsche.github.com/no-pvc-protection"
	Enabled                                     = "true"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "k8storagex.mgoltzsche.github.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type Cache 

type Cache struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   CacheSpec   `json:"spec,omitempty"`
	Status CacheStatus `json:"status,omitempty"`
}

Cache is the Schema for the caches API

func (*Cache) DeepCopy 

func (in *Cache) DeepCopy() *Cache

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cache.

func (*Cache) DeepCopyInto 

func (in *Cache) DeepCopyInto(out *Cache)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Cache) DeepCopyObject 

func (in *Cache) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CacheList 

type CacheList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Cache `json:"items"`
}

CacheList contains a list of Cache

func (*CacheList) DeepCopy 

func (in *CacheList) DeepCopy() *CacheList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CacheList.

func (*CacheList) DeepCopyInto 

func (in *CacheList) DeepCopyInto(out *CacheList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CacheList) DeepCopyObject 

func (in *CacheList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CachePhase 

type CachePhase string

type CacheSpec 

type CacheSpec struct {
	//BaseCacheName string `json:"baseCacheName,omitempty"`
	ReadOnly bool `json:"readOnly,omitempty"`
}

CacheSpec defines the desired state of Cache

func (*CacheSpec) DeepCopy 

func (in *CacheSpec) DeepCopy() *CacheSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CacheSpec.

func (*CacheSpec) DeepCopyInto 

func (in *CacheSpec) DeepCopyInto(out *CacheSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CacheStatus 

type CacheStatus struct {
	Image           string       `json:"image,omitempty"`
	CacheGeneration int64        `json:"cacheGeneration,omitempty"`
	LastImageID     *string      `json:"lastImageID,omitempty"`
	LastUsed        *metav1.Time `json:"lastUsed,omitempty"`
	LastWritten     *metav1.Time `json:"lastWritten,omitempty"`
	LastReset       *ResetStatus `json:"lastReset,omitempty"`
	Used            int64        `json:"used"`
	//LastWrittenByPersistentVolumeClaim string       `json:"lastWrittenByPersistentVolumeClaim,omitempty"`
	Nodes []NodeStatus `json:"nodes,omitempty"`
	Phase CachePhase   `json:"phase,omitempty"`
	// Conditions represent the latest available observations of a Cache's current state.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

CacheStatus defines the observed state of Cache

func (*CacheStatus) DeepCopy 

func (in *CacheStatus) DeepCopy() *CacheStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CacheStatus.

func (*CacheStatus) DeepCopyInto 

func (in *CacheStatus) DeepCopyInto(out *CacheStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Containers 

type Containers struct {
	Provisioner   ProvisionerContainer `json:"provisioner"`
	Deprovisioner ProvisionerContainer `json:"deprovisioner"`
}

Containers specifies the parameters used with the PodTemplate to create the Pods to handle the storage lifecycle

func (*Containers) DeepCopy 

func (in *Containers) DeepCopy() *Containers

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Containers.

func (*Containers) DeepCopyInto 

func (in *Containers) DeepCopyInto(out *Containers)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EnvVar 

type EnvVar struct {
	Name       string `json:"name"`
	Annotation string `json:"annotation"`
	Required   *bool  `json:"required,omitempty"`
}

EnvVar maps an annotation value to an env var that is provided to the de/provisioner Pod

func (*EnvVar) DeepCopy 

func (in *EnvVar) DeepCopy() *EnvVar

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EnvVar.

func (*EnvVar) DeepCopyInto 

func (in *EnvVar) DeepCopyInto(out *EnvVar)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NodePath 

type NodePath struct {
	Name string `json:"name,omitempty"`
	Path string `json:"path"`
}

NodePath maps nodes to a path

func (*NodePath) DeepCopy 

func (in *NodePath) DeepCopy() *NodePath

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodePath.

func (*NodePath) DeepCopyInto 

func (in *NodePath) DeepCopyInto(out *NodePath)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NodeStatus 

type NodeStatus struct {
	Name            string         `json:"name"`
	CacheGeneration int64          `json:"cacheGeneration,omitempty"`
	LastUsed        metav1.Time    `json:"lastUsed"`
	LastImageID     string         `json:"lastImageID,omitempty"`
	Volumes         []VolumeStatus `json:"volumes,omitempty"`
	LastError       *VolumeError   `json:"lastError,omitempty"`
}

NodeStatus defines the observed state of a cache on a node

func (*NodeStatus) DeepCopy 

func (in *NodeStatus) DeepCopy() *NodeStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeStatus.

func (*NodeStatus) DeepCopyInto 

func (in *NodeStatus) DeepCopyInto(out *NodeStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ProvisionerContainer 

type ProvisionerContainer struct {
	Command []string        `json:"command,omitempty"`
	Env     []corev1.EnvVar `json:"env,omitempty"`
}

ProvisionerContainer specifies a container that is merged with a Pod template

func (*ProvisionerContainer) DeepCopy 

func (in *ProvisionerContainer) DeepCopy() *ProvisionerContainer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProvisionerContainer.

func (*ProvisionerContainer) DeepCopyInto 

func (in *ProvisionerContainer) DeepCopyInto(out *ProvisionerContainer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResetStatus 

type ResetStatus struct {
	CacheGeneration int64       `json:"cacheGeneration"`
	ResetTime       metav1.Time `json:"resetTime"`
}

func (*ResetStatus) DeepCopy 

func (in *ResetStatus) DeepCopy() *ResetStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResetStatus.

func (*ResetStatus) DeepCopyInto 

func (in *ResetStatus) DeepCopyInto(out *ResetStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StorageProvisioner 

type StorageProvisioner struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StorageProvisionerSpec   `json:"spec,omitempty"`
	Status StorageProvisionerStatus `json:"status,omitempty"`
}

StorageProvisioner is the Schema for the storageprovisioners API

func (*StorageProvisioner) DeepCopy 

func (in *StorageProvisioner) DeepCopy() *StorageProvisioner

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageProvisioner.

func (*StorageProvisioner) DeepCopyInto 

func (in *StorageProvisioner) DeepCopyInto(out *StorageProvisioner)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StorageProvisioner) DeepCopyObject 

func (in *StorageProvisioner) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*StorageProvisioner) GetProvisionerName 

func (p *StorageProvisioner) GetProvisionerName() string

type StorageProvisionerList 

type StorageProvisionerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []StorageProvisioner `json:"items"`
}

StorageProvisionerList contains a list of StorageProvisioner

func (*StorageProvisionerList) DeepCopy 

func (in *StorageProvisionerList) DeepCopy() *StorageProvisionerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageProvisionerList.

func (*StorageProvisionerList) DeepCopyInto 

func (in *StorageProvisionerList) DeepCopyInto(out *StorageProvisionerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StorageProvisionerList) DeepCopyObject 

func (in *StorageProvisionerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StorageProvisionerSpec 

type StorageProvisionerSpec struct {
	Name                       string                      `json:"name"`
	DeprovisionOnPodCompletion bool                        `json:"deprovisionOnPodCompletion,omitempty"`
	PersistentVolumeTemplate   corev1.PersistentVolumeSpec `json:"persistentVolumeTemplate"`
	PodTemplate                corev1.PodSpec              `json:"podTemplate"`
	Containers                 Containers                  `json:"containers"`
	Env                        []EnvVar                    `json:"env,omitempty"`
	Nodes                      []NodePath                  `json:"nodes,omitempty"`
}

StorageProvisionerSpec defines the desired state of StorageProvisioner

func (*StorageProvisionerSpec) DeepCopy 

func (in *StorageProvisionerSpec) DeepCopy() *StorageProvisionerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageProvisionerSpec.

func (*StorageProvisionerSpec) DeepCopyInto 

func (in *StorageProvisionerSpec) DeepCopyInto(out *StorageProvisionerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StorageProvisionerStatus 

type StorageProvisionerStatus struct {
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

StorageProvisionerStatus defines the observed state of StorageProvisioner

func (*StorageProvisionerStatus) DeepCopy 

func (in *StorageProvisionerStatus) DeepCopy() *StorageProvisionerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageProvisionerStatus.

func (*StorageProvisionerStatus) DeepCopyInto 

func (in *StorageProvisionerStatus) DeepCopyInto(out *StorageProvisionerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeError 

type VolumeError struct {
	VolumeName      string      `json:"volumeName"`
	CacheGeneration *int64      `json:"cacheGeneration,omitempty"`
	Error           string      `json:"error"`
	Happened        metav1.Time `json:"happened"`
}

func (*VolumeError) DeepCopy 

func (in *VolumeError) DeepCopy() *VolumeError

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeError.

func (*VolumeError) DeepCopyInto 

func (in *VolumeError) DeepCopyInto(out *VolumeError)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumePhase 

type VolumePhase string

type VolumeStatus 

type VolumeStatus struct {
	Name            string       `json:"name"`
	CacheGeneration int64        `json:"cacheGeneration"`
	Created         metav1.Time  `json:"created"`
	Committable     bool         `json:"committable,omitempty"`
	CommitStartTime *metav1.Time `json:"commitStartTime,omitempty"`
}

VolumeStatus defines the observed state of a volume or rather cache mount/umount/commit lifecycle

func (*VolumeStatus) DeepCopy 

func (in *VolumeStatus) DeepCopy() *VolumeStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeStatus.

func (*VolumeStatus) DeepCopyInto 

func (in *VolumeStatus) DeepCopyInto(out *VolumeStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

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.