Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the k8s v1 API group +kubebuilder:object:generate=true +groupName=k8s.cloudogu.com
Index ¶
Constants ¶
const ( // ComponentStatusNotInstalled represents a status for a component that is not installed ComponentStatusNotInstalled = "" // ComponentStatusInstalling represents a status for a component that is currently being installed ComponentStatusInstalling = "installing" // ComponentStatusUpgrading represents a status for a component that is currently being upgraded ComponentStatusUpgrading = "upgrading" // ComponentStatusDeleting represents a status for a component that is currently being deleted ComponentStatusDeleting = "deleting" // ComponentStatusInstalled represents a status for a component that was successfully installed ComponentStatusInstalled = "installed" // ComponentStatusTryToInstall represents a status for a component that is not installed but its install process is in requeue loop. ComponentStatusTryToInstall = "tryToInstall" // ComponentStatusTryToUpgrade represents a status for a component that is installed but its actual upgrade process is in requeue loop. // In this state the component can be healthy but the version in the spec is not installed. ComponentStatusTryToUpgrade = "tryToUpgrade" // ComponentStatusTryToDelete represents a status for a component that is installed but its delete process is in requeue loop. // In this state the component can be healthy. ComponentStatusTryToDelete = "tryToDelete" )
const ( ComponentNameLabelKey = "k8s.cloudogu.com/component.name" ComponentVersionLabelKey = "k8s.cloudogu.com/component.version" )
const FinalizerName = "component-finalizer"
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "k8s.cloudogu.com", Version: "v1"} // 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 Component ¶
type Component struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ComponentSpec `json:"spec,omitempty"`
Status ComponentStatus `json:"status,omitempty"`
}
Component is the Schema for the ces component API
func (*Component) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Component.
func (*Component) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Component) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Component) GetHelmChartSpec ¶
GetHelmChartSpec returns the helm chart for the component cr without custom values.
type ComponentList ¶
type ComponentList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Component `json:"items"`
}
ComponentList contains a list of Component
func (*ComponentList) DeepCopy ¶
func (in *ComponentList) DeepCopy() *ComponentList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentList.
func (*ComponentList) DeepCopyInto ¶
func (in *ComponentList) DeepCopyInto(out *ComponentList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ComponentList) DeepCopyObject ¶
func (in *ComponentList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ComponentSpec ¶
type ComponentSpec struct {
// Namespace of the component (e.g. k8s)
Namespace string `json:"namespace,omitempty"`
// Name of the component (e.g. k8s-dogu-operator)
Name string `json:"name,omitempty"`
// Desired version of the component (e.g. 2.4.48-3)
Version string `json:"version,omitempty"`
// DeployNamespace is the namespace where the helm chart should be deployed in.
// This value is optional. If it is empty the operator deploys the helm chart in the namespace where the operator is deployed.
DeployNamespace string `json:"deployNamespace,omitempty"`
// ValuesYamlOverwrite is a multiline-yaml string that is applied alongside the original values.yaml-file of the component.
// It can be used to overwrite specific configurations. Lists are overwritten, maps are merged.
// +optional
ValuesYamlOverwrite string `json:"valuesYamlOverwrite,omitempty"`
}
ComponentSpec defines the desired state of a component.
func (*ComponentSpec) DeepCopy ¶
func (in *ComponentSpec) DeepCopy() *ComponentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentSpec.
func (*ComponentSpec) DeepCopyInto ¶
func (in *ComponentSpec) DeepCopyInto(out *ComponentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ComponentStatus ¶
type ComponentStatus struct {
// Status represents the state of the component in the ecosystem.
Status string `json:"status"`
// RequeueTimeNanos contains the time in nanoseconds to wait until the next requeue.
RequeueTimeNanos time.Duration `json:"requeueTimeNanos,omitempty"`
// Health describes the health status of the component.
// A component becomes 'available' if its Status is 'installed',
// and all its deployments, stateful sets, and daemon sets are available.
Health HealthStatus `json:"health,omitempty"`
// Installed version of the component (e.g. 2.4.48-3)
InstalledVersion string `json:"installedVersion,omitempty"`
}
ComponentStatus defines the observed state of a Component.
func (*ComponentStatus) DeepCopy ¶
func (in *ComponentStatus) DeepCopy() *ComponentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentStatus.
func (*ComponentStatus) DeepCopyInto ¶
func (in *ComponentStatus) DeepCopyInto(out *ComponentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HealthStatus ¶ added in v0.8.0
type HealthStatus string
const ( PendingHealthStatus HealthStatus = "" AvailableHealthStatus HealthStatus = "available" UnknownHealthStatus HealthStatus = "unknown" )
Source Files