v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the odf v1alpha1 API group +kubebuilder:object:generate=true +groupName=odf.ibm.com

Index

• Constants
• Variables
• type Condition
  • func (in *Condition) DeepCopy() *Condition
  • func (in *Condition) DeepCopyInto(out *Condition)
• type ConditionType
• type FlashSystemCluster
  • func (in *FlashSystemCluster) DeepCopy() *FlashSystemCluster
  • func (in *FlashSystemCluster) DeepCopyInto(out *FlashSystemCluster)
  • func (in *FlashSystemCluster) DeepCopyObject() runtime.Object
• type FlashSystemClusterList
  • func (in *FlashSystemClusterList) DeepCopy() *FlashSystemClusterList
  • func (in *FlashSystemClusterList) DeepCopyInto(out *FlashSystemClusterList)
  • func (in *FlashSystemClusterList) DeepCopyObject() runtime.Object
• type FlashSystemClusterSpec
  • func (in *FlashSystemClusterSpec) DeepCopy() *FlashSystemClusterSpec
  • func (in *FlashSystemClusterSpec) DeepCopyInto(out *FlashSystemClusterSpec)
• type FlashSystemClusterStatus
  • func (in *FlashSystemClusterStatus) DeepCopy() *FlashSystemClusterStatus
  • func (in *FlashSystemClusterStatus) DeepCopyInto(out *FlashSystemClusterStatus)
• type StorageClassConfig
  • func (in *StorageClassConfig) DeepCopy() *StorageClassConfig
  • func (in *StorageClassConfig) DeepCopyInto(out *StorageClassConfig)

Constants

const (
	ReasonReconcileFailed    = "ReconcileFailed"
	ReasonReconcileInit      = "Init"
	ReasonReconcileCompleted = "ReconcileCompleted"
)

const (
	// PhaseProgressing is used during launch exporter & CSI CR creation phase
	PhaseProgressing = "Progressing"
	// PhaseError is used when reconcile fails or there is any of false ready from conditions
	PhaseError = "Error"
	// PhaseReady is used when reconcile is successful
	PhaseReady = "Ready"
	// PhaseNotReady is used if reconcile fails
	PhaseNotReady = "Not Ready"
	// PhaseDeleting is used if deleting FlashSystemCluster is happening
	PhaseDeleting = "Deleting"
	// PhaseConnecting is reserved for later usage
	PhaseConnecting = "Connecting"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "odf.ibm.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
)

Types

type Condition

type Condition struct {
	Type ConditionType `json:"type" description:"type of condition."`

	Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`

	// +optional
	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`

	// +optional
	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`

	// +optional
	LastHeartbeatTime metav1.Time `json:"lastHeartbeatTime" description:"last time we got an update on a given condition"`

	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime" description:"last time the condition transit from one status to another"`
}

Condition represents the state of the operator's reconciliation functionality. +k8s:deepcopy-gen=true

func (*Condition) DeepCopy

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto

func (in *Condition) DeepCopyInto(out *Condition)

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

type ConditionType

type ConditionType string

ConditionType is the state of the operator's reconciliation functionality.

const (
	// ExporterCreated indicts exporter is launched by operator
	ExporterCreated ConditionType = "ExporterCreated"
	// ExporterReady is set from exporter and reason & message are provided if false condition
	ExporterReady ConditionType = "ExporterReady"
	// StorageClusterReady is set from exporter after query from FlashSystem
	StorageClusterReady ConditionType = "StorageClusterReady"
	// ProvisionerCreated indicts the FlashSystem CSI CR is created
	ProvisionerCreated ConditionType = "ProvisionerCreated"
	// ProvisionerReused indicts the existing FlashSystem CSI CR is reused
	ProvisionerReused ConditionType = "ProvisionerReused"
	// ProvisionerReady reflects the status of FlashSystem CSI CR
	ProvisionerReady ConditionType = "ProvisionerReady"
	// ConditionProgressing indicts the reconciling process is in progress
	ConditionProgressing ConditionType = "ReconcileProgressing"
	// ConditionReconcileComplete indicts the Reconcile function completes
	ConditionReconcileComplete ConditionType = "ReconcileComplete"
)

type FlashSystemCluster

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

	Spec   FlashSystemClusterSpec   `json:"spec,omitempty"`
	Status FlashSystemClusterStatus `json:"status,omitempty"`
}

FlashSystemCluster is the Schema for the FlashSystemClusters API

func (*FlashSystemCluster) DeepCopy

func (in *FlashSystemCluster) DeepCopy() *FlashSystemCluster

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

func (*FlashSystemCluster) DeepCopyInto

func (in *FlashSystemCluster) DeepCopyInto(out *FlashSystemCluster)

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

func (*FlashSystemCluster) DeepCopyObject

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

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

type FlashSystemClusterList

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

FlashSystemClusterList contains a list of FlashSystemCluster

func (*FlashSystemClusterList) DeepCopy

func (in *FlashSystemClusterList) DeepCopy() *FlashSystemClusterList

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

func (*FlashSystemClusterList) DeepCopyInto

func (in *FlashSystemClusterList) DeepCopyInto(out *FlashSystemClusterList)

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

func (*FlashSystemClusterList) DeepCopyObject

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

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

type FlashSystemClusterSpec

type FlashSystemClusterSpec struct {
	// Name is the name of the flashsystem storage cluster
	Name string `json:"name"`
	// Secret refers to a secret that has the credentials for FlashSystem csi StorageClass
	Secret corev1.SecretReference `json:"secret"`
	// InsecureSkipVerify disables target certificate validation if true
	InsecureSkipVerify bool `json:"insecureSkipVerify,omitempty"`
	// DefaultPool has the configuration to create default storage class
	DefaultPool *StorageClassConfig `json:"defaultPool,omitempty"`
}

FlashSystemClusterSpec defines the desired state of FlashSystemCluster

func (*FlashSystemClusterSpec) DeepCopy

func (in *FlashSystemClusterSpec) DeepCopy() *FlashSystemClusterSpec

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

func (*FlashSystemClusterSpec) DeepCopyInto

func (in *FlashSystemClusterSpec) DeepCopyInto(out *FlashSystemClusterSpec)

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

type FlashSystemClusterStatus

type FlashSystemClusterStatus struct {
	// Phase describes the Phase of FlashSystemCluster
	// This is used by OLM UI to provide status information
	// to the user
	Phase string `json:"phase,omitempty"`

	// Conditions describes the state of the FlashSystemCluster resource.
	// +optional
	Conditions []Condition `json:"conditions,omitempty"`
}

FlashSystemClusterStatus defines the observed state of FlashSystemCluster

func (*FlashSystemClusterStatus) DeepCopy

func (in *FlashSystemClusterStatus) DeepCopy() *FlashSystemClusterStatus

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

func (*FlashSystemClusterStatus) DeepCopyInto

func (in *FlashSystemClusterStatus) DeepCopyInto(out *FlashSystemClusterStatus)

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

type StorageClassConfig

type StorageClassConfig struct {
	StorageClassName string `json:"storageclassName"`
	PoolName         string `json:"poolName"`
	// +kubebuilder:validation:Enum=ext4;xfs
	FsType string `json:"fsType,omitempty"`
	// +kubebuilder:validation:MaxLength=20
	VolumeNamePrefix string `json:"volumeNamePrefix,omitempty"`
	// +kubebuilder:validation:Enum=thick;thin;compressed;deduplicated
	SpaceEfficiency string `json:"spaceEfficiency,omitempty"`
}

func (*StorageClassConfig) DeepCopy

func (in *StorageClassConfig) DeepCopy() *StorageClassConfig

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

func (*StorageClassConfig) DeepCopyInto

func (in *StorageClassConfig) DeepCopyInto(out *StorageClassConfig)

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