v1

Documentation

Overview

Package v1 contains API Schema definitions for the ocean v1 API group +k8s:deepcopy-gen=package,register +groupName=ocean.spot.io

Package v1 contains API Schema definitions for the ocean v1 API group +k8s:deepcopy-gen=package,register +groupName=ocean.spot.io

Index

• Variables
• type ConditionReason
• type ConditionType
• type InstallStatus
• type OceanToolkit
• type OceanToolkitComponent
• type OceanToolkitList
• type OceanToolkitSpec
• type OceanToolkitStatus
• type ReconcileStatus
• type StatusCondition
• type StatusDetails

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "ocean.spot.io", Version: "v1"}

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

Types

type ConditionReason

type ConditionReason string

ConditionReason is an enumeration of possible failure causes.

const (
	// The server has declined to indicate a specific reason.
	ConditionReasonUnknown ConditionReason = ""
)

type ConditionType

type ConditionType string

ConditionType is an enumeration of possible condition types.

const (
	// ConditionTypeReady indicates that the Cluster/LaunchSpec is ready and
	// able to scale if necessary: it's correctly configured and isn't disabled.
	ConditionTypeReady ConditionType = "Ready"
)

type InstallStatus

type InstallStatus int32

InstallStatus describes the current installation state of a component.

const (
	// Component is not present.
	InstallStatusUnknown InstallStatus = iota
	// Component is being updated to a different version.
	InstallStatusUpdating
	// Component is being reconciled.
	InstallStatusReconciling
	// Component is healthy.
	InstallStatusHealthy
	// Component is in an error state.
	InstallStatusError
)

type OceanToolkit

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

	// Specification of the desired behavior of the OceanToolkit.
	Spec OceanToolkitSpec `json:"spec,omitempty"`
	// Most recently observed status of the OceanToolkit.
	Status OceanToolkitStatus `json:"status,omitempty"`
}

OceanToolkit consists of one or more Toolkit components. +kubebuilder:subresource:status +kubebuilder:resource:path=clusters,scope=Namespaced

type OceanToolkitComponent

type OceanToolkitComponent struct {
	// Selects whether this component is installed.
	Enabled bool `json:"enabled"`
	// Local values. This is a validated pass-through to Helm templates.
	// See the Helm charts for schema details: https://github.com/spotinst/ocsean-charts/.
	Values map[string]interface{} `json:"values,omitempty"`
}

OceanToolkitComponent defines the desired state of a component.

type OceanToolkitList

type OceanToolkitList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// Items is the list of OceanToolkits.
	Items []OceanToolkit `json:"items"`
}

OceanToolkitList contains a list of OceanToolkit.

type OceanToolkitSpec

type OceanToolkitSpec struct {
	// List of components to install.
	Components map[string]*OceanToolkitComponent `json:"components,omitempty"`
	// Global values. This is a validated pass-through to Helm templates.
	// See the Helm charts for schema details: https://github.com/spotinst/ocsean-charts/.
	Values map[string]interface{} `json:"values,omitempty"`
}

OceanToolkitSpec defines the desired state of Ocean Toolkit.

type OceanToolkitStatus

type OceanToolkitStatus struct {
	// Most recently observed status of the Toolkit.
	ReconcileStatus `json:",inline"`
	// Observed status of the installation.
	InstallStatus map[string]InstallStatus `json:"installStatus,omitempty"`
}

OceanToolkitStatus defines the observed status of Ocean Toolkit.

type ReconcileStatus

type ReconcileStatus struct {
	// The generation observed by the controller.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Represents the latest available observations of the current state.
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions []StatusCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
	// Extended data associated with the status. This field is optional.
	Details StatusDetails `json:"details,omitempty"`
}

ReconcileStatus is the most recently observed status of a resource. It's used to communicate success or failure and the error message.

type StatusCondition

type StatusCondition struct {
	// Type of the condition.
	Type ConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status"`
	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`
	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
	// The reason for the condition's last transition.
	Reason ConditionReason `json:"reason,omitempty"`
}

StatusCondition contains condition information.

type StatusDetails

type StatusDetails struct {
	// Unique ID of the reconcile request.
	ReconcileRequestUID types.UID `json:"reconcileRequestUid,omitempty"`
}

StatusDetails is a set of additional properties that MAY be set by the controller to provide additional information.