v1alpha

Documentation

Overview

+k8s:deepcopy-gen=package +groupName=storage.arangodb.com

Index

• Constants
• Variables
• func IsValidation(err error) bool
• func Resource(resource string) schema.GroupResource
• type ArangoLocalStorage
  • func (d *ArangoLocalStorage) AsOwner() metav1.OwnerReference
  • func (in *ArangoLocalStorage) DeepCopy() *ArangoLocalStorage
  • func (in *ArangoLocalStorage) DeepCopyInto(out *ArangoLocalStorage)
  • func (in *ArangoLocalStorage) DeepCopyObject() runtime.Object
• type ArangoLocalStorageList
  • func (in *ArangoLocalStorageList) DeepCopy() *ArangoLocalStorageList
  • func (in *ArangoLocalStorageList) DeepCopyInto(out *ArangoLocalStorageList)
  • func (in *ArangoLocalStorageList) DeepCopyObject() runtime.Object
• type LocalStorageSpec
  • func (in *LocalStorageSpec) DeepCopy() *LocalStorageSpec
  • func (in *LocalStorageSpec) DeepCopyInto(out *LocalStorageSpec)
  • func (s LocalStorageSpec) ResetImmutableFields(target *LocalStorageSpec) []string
  • func (s *LocalStorageSpec) SetDefaults(localStorageName string)
  • func (s LocalStorageSpec) Validate() error
• type LocalStorageState
  • func (cs LocalStorageState) IsFailed() bool
• type LocalStorageStatus
  • func (in *LocalStorageStatus) DeepCopy() *LocalStorageStatus
  • func (in *LocalStorageStatus) DeepCopyInto(out *LocalStorageStatus)
• type StorageClassSpec
  • func (in *StorageClassSpec) DeepCopy() *StorageClassSpec
  • func (in *StorageClassSpec) DeepCopyInto(out *StorageClassSpec)
  • func (s StorageClassSpec) ResetImmutableFields(fieldPrefix string, target *StorageClassSpec) []string
  • func (s *StorageClassSpec) SetDefaults(localStorageName string)
  • func (s StorageClassSpec) Validate() error

Constants

const (
	ArangoLocalStorageResourceKind   = "ArangoLocalStorage"
	ArangoLocalStorageResourcePlural = "arangolocalstorages"
)

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme

	SchemeGroupVersion           = schema.GroupVersion{Group: groupName, Version: "v1alpha"}
	ArangoLocalStorageCRDName    = ArangoLocalStorageResourcePlural + "." + groupName
	ArangoLocalStorageShortNames = []string{"arangostorage"}
)

var (
	// ValidationError indicates a validation failure
	ValidationError = errors.New("validation failed")
)

Functions

func IsValidation

func IsValidation(err error) bool

IsValidation return true when the given error is or is caused by a ValidationError.

func Resource

func Resource(resource string) schema.GroupResource

Resource gets an ArangoCluster GroupResource for a specified resource

Types

type ArangoLocalStorage

type ArangoLocalStorage struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              LocalStorageSpec   `json:"spec"`
	Status            LocalStorageStatus `json:"status"`
}

ArangoLocalStorage contains the entire Kubernetes info for an ArangoDB local storage provider.

func (*ArangoLocalStorage) AsOwner

func (d *ArangoLocalStorage) AsOwner() metav1.OwnerReference

AsOwner creates an OwnerReference for the given storage

func (*ArangoLocalStorage) DeepCopy

func (in *ArangoLocalStorage) DeepCopy() *ArangoLocalStorage

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

func (*ArangoLocalStorage) DeepCopyInto

func (in *ArangoLocalStorage) DeepCopyInto(out *ArangoLocalStorage)

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

func (*ArangoLocalStorage) DeepCopyObject

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

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

type ArangoLocalStorageList

type ArangoLocalStorageList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ArangoLocalStorage `json:"items"`
}

ArangoLocalStorageList is a list of ArangoDB local storage providers.

func (*ArangoLocalStorageList) DeepCopy

func (in *ArangoLocalStorageList) DeepCopy() *ArangoLocalStorageList

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

func (*ArangoLocalStorageList) DeepCopyInto

func (in *ArangoLocalStorageList) DeepCopyInto(out *ArangoLocalStorageList)

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

func (*ArangoLocalStorageList) DeepCopyObject

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

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

type LocalStorageSpec

type LocalStorageSpec struct {
	StorageClass StorageClassSpec  `json:"storageClass"`
	LocalPath    []string          `json:"localPath,omitempty"`
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
}

LocalStorageSpec contains the specification part of an ArangoLocalStorage.

func (*LocalStorageSpec) DeepCopy

func (in *LocalStorageSpec) DeepCopy() *LocalStorageSpec

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

func (*LocalStorageSpec) DeepCopyInto

func (in *LocalStorageSpec) DeepCopyInto(out *LocalStorageSpec)

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

func (LocalStorageSpec) ResetImmutableFields

func (s LocalStorageSpec) ResetImmutableFields(target *LocalStorageSpec) []string

ResetImmutableFields replaces all immutable fields in the given target with values from the source spec. It returns a list of fields that have been reset. Field names are relative to `spec.`.

func (*LocalStorageSpec) SetDefaults

func (s *LocalStorageSpec) SetDefaults(localStorageName string)

SetDefaults fills empty field with default values.

func (LocalStorageSpec) Validate

func (s LocalStorageSpec) Validate() error

Validate the given spec, returning an error on validation problems or nil if all ok.

type LocalStorageState

type LocalStorageState string

LocalStorageState is a strongly typed state of a deploymenlocal storage

const (
	// LocalStorageStateNone indicates that the state is not set yet
	LocalStorageStateNone LocalStorageState = ""
	// LocalStorageStateCreating indicates that the local storage components are being created
	LocalStorageStateCreating LocalStorageState = "Creating"
	// LocalStorageStateRunning indicates that all components are running
	LocalStorageStateRunning LocalStorageState = "Running"
	// LocalStorageStateFailed indicates that a local storage is in a failed state
	// from which automatic recovery is impossible. Inspect `Reason` for more info.
	LocalStorageStateFailed LocalStorageState = "Failed"
)

func (LocalStorageState) IsFailed

func (cs LocalStorageState) IsFailed() bool

IsFailed returns true if given state is LocalStorageStateFailed

type LocalStorageStatus

type LocalStorageStatus struct {
	// State holds the current high level state of the local storage
	State LocalStorageState `json:"state,omitempty"`
	// Reason for the state this object is in.
	Reason string `json:"reason,omitempty"`
}

LocalStorageStatus contains the status part of an ArangoLocalStorage.

func (*LocalStorageStatus) DeepCopy

func (in *LocalStorageStatus) DeepCopy() *LocalStorageStatus

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

func (*LocalStorageStatus) DeepCopyInto

func (in *LocalStorageStatus) DeepCopyInto(out *LocalStorageStatus)

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

type StorageClassSpec

type StorageClassSpec struct {
	Name      string `json:"name,omitempty"`
	IsDefault bool   `json:"isDefault,omitempty"`
}

StorageClassSpec contains specification for create StorageClass.

func (*StorageClassSpec) DeepCopy

func (in *StorageClassSpec) DeepCopy() *StorageClassSpec

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

func (*StorageClassSpec) DeepCopyInto

func (in *StorageClassSpec) DeepCopyInto(out *StorageClassSpec)

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

func (StorageClassSpec) ResetImmutableFields

func (s StorageClassSpec) ResetImmutableFields(fieldPrefix string, target *StorageClassSpec) []string

ResetImmutableFields replaces all immutable fields in the given target with values from the source spec. It returns a list of fields that have been reset. Field names are relative to `spec.`.

func (*StorageClassSpec) SetDefaults

func (s *StorageClassSpec) SetDefaults(localStorageName string)

SetDefaults fills empty field with default values.

func (StorageClassSpec) Validate

func (s StorageClassSpec) Validate() error

Validate the given spec, returning an error on validation problems or nil if all ok.