v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the ocean v1alpha1 API group +kubebuilder:object:generate=true +groupName=ocean.spot.io

Index

• Constants
• Variables
• type OceanComponent
  • func (in *OceanComponent) DeepCopy() *OceanComponent
  • func (in *OceanComponent) DeepCopyInto(out *OceanComponent)
  • func (in *OceanComponent) DeepCopyObject() runtime.Object
• type OceanComponentCondition
  • func (in *OceanComponentCondition) DeepCopy() *OceanComponentCondition
  • func (in *OceanComponentCondition) DeepCopyInto(out *OceanComponentCondition)
• type OceanComponentConditionType
  • func (x OceanComponentConditionType) String() string
• type OceanComponentList
  • func (in *OceanComponentList) DeepCopy() *OceanComponentList
  • func (in *OceanComponentList) DeepCopyInto(out *OceanComponentList)
  • func (in *OceanComponentList) DeepCopyObject() runtime.Object
• type OceanComponentName
  • func (x OceanComponentName) String() string
• type OceanComponentSpec
  • func (in *OceanComponentSpec) DeepCopy() *OceanComponentSpec
  • func (in *OceanComponentSpec) DeepCopyInto(out *OceanComponentSpec)
• type OceanComponentState
  • func (x OceanComponentState) String() string
• type OceanComponentStatus
  • func (in *OceanComponentStatus) DeepCopy() *OceanComponentStatus
  • func (in *OceanComponentStatus) DeepCopyInto(out *OceanComponentStatus)
• type OceanComponentType
  • func (x OceanComponentType) String() string

Constants

const NamespaceSystem = "spot-system"

NamespaceSystem is the system namespace where we place Ocean components.

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "ocean.spot.io", 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 OceanComponent

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

	Spec   OceanComponentSpec   `json:"spec,omitempty"`
	Status OceanComponentStatus `json:"status,omitempty"`
}

OceanComponent is the Schema for the OceanComponent API

func (*OceanComponent) DeepCopy

func (in *OceanComponent) DeepCopy() *OceanComponent

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

func (*OceanComponent) DeepCopyInto

func (in *OceanComponent) DeepCopyInto(out *OceanComponent)

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

func (*OceanComponent) DeepCopyObject

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

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

type OceanComponentCondition

type OceanComponentCondition struct {
	// Type of deployment condition.
	Type OceanComponentConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=OceanComponentConditionType"`
	// Status of the condition, one of True, False, Unknown.
	Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"`
	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty" protobuf:"bytes,6,opt,name=lastUpdateTime"`
	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,7,opt,name=lastTransitionTime"`
	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"`
	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"`
}

OceanComponentCondition describes the state of a deployment at a certain point.

func (*OceanComponentCondition) DeepCopy

func (in *OceanComponentCondition) DeepCopy() *OceanComponentCondition

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

func (*OceanComponentCondition) DeepCopyInto

func (in *OceanComponentCondition) DeepCopyInto(out *OceanComponentCondition)

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

type OceanComponentConditionType

type OceanComponentConditionType string

OceanComponentConditionType represents the type of OceanComponentCondition.

const (
	// OceanComponentConditionTypeAvailable means the application is available.
	OceanComponentConditionTypeAvailable OceanComponentConditionType = "Available"
	// OceanComponentConditionTypeProgressing means the component is progressing.
	OceanComponentConditionTypeProgressing OceanComponentConditionType = "Progressing"
	// OceanComponentConditionTypeDegraded indicates the component is in a temporary degraded state.
	OceanComponentConditionTypeDegraded OceanComponentConditionType = "Degraded"
	// OceanComponentConditionTypeFailure indicates a significant error conditions.
	OceanComponentConditionTypeFailure OceanComponentConditionType = "Failing"
)

These are valid component conditions.

func (OceanComponentConditionType) String

func (x OceanComponentConditionType) String() string

type OceanComponentList

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

OceanComponentList contains a list of OceanComponent

func (*OceanComponentList) DeepCopy

func (in *OceanComponentList) DeepCopy() *OceanComponentList

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

func (*OceanComponentList) DeepCopyInto

func (in *OceanComponentList) DeepCopyInto(out *OceanComponentList)

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

func (*OceanComponentList) DeepCopyObject

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

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

type OceanComponentName

type OceanComponentName string

OceanComponentName represents the name of OceanComponent.

const (
	MetricsServerComponentName         OceanComponentName = "metrics-server"
	OceanControllerComponentName       OceanComponentName = "ocean-controller"
	LegacyOceanControllerComponentName OceanComponentName = "spotinst-kubernetes-cluster-controller"
)

These are valid component names.

func (OceanComponentName) String

func (x OceanComponentName) String() string

type OceanComponentSpec

type OceanComponentSpec struct {
	// Type is one of ["Helm"].
	Type OceanComponentType `json:"type"`
	// Name is the name of the OceanComponent.
	Name OceanComponentName `json:"name"`
	// State determines whether the component should be installed or removed.
	State OceanComponentState `json:"state"`
	// URL is the location of the OceanComponent archive file.
	URL string `json:"url"`
	// Version is a SemVer 2 conformant version string of the OceanComponent archive file.
	Version string `json:"version"`
	// Values is the set of extra values added to the OceanComponent.
	Values string `json:"values,omitempty"`
}

OceanComponentSpec defines the desired state of OceanComponent.

func (*OceanComponentSpec) DeepCopy

func (in *OceanComponentSpec) DeepCopy() *OceanComponentSpec

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

func (*OceanComponentSpec) DeepCopyInto

func (in *OceanComponentSpec) DeepCopyInto(out *OceanComponentSpec)

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

type OceanComponentState

type OceanComponentState string

OceanComponentState represents the state of OceanComponent.

const (
	OceanComponentStatePresent OceanComponentState = "Present"
	OceanComponentStateAbsent  OceanComponentState = "Absent"
)

These are valid component states.

func (OceanComponentState) String

func (x OceanComponentState) String() string

type OceanComponentStatus

type OceanComponentStatus struct {
	// A set of installation values specific to the component
	Properties map[string]string         `json:"properties,omitempty"`
	Conditions []OceanComponentCondition `json:"conditions,omitempty"`
}

OceanComponentStatus defines the observed state of OceanComponent.

func (*OceanComponentStatus) DeepCopy

func (in *OceanComponentStatus) DeepCopy() *OceanComponentStatus

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

func (*OceanComponentStatus) DeepCopyInto

func (in *OceanComponentStatus) DeepCopyInto(out *OceanComponentStatus)

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

type OceanComponentType

type OceanComponentType string

OceanComponentType represents the type of OceanComponent.

const (
	OceanComponentTypeHelm OceanComponentType = "Helm"
)

These are valid component types.

func (OceanComponentType) String

func (x OceanComponentType) String() string