v1alpha1

Documentation

Overview

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

Index

• Variables
• type ResourceReference
  • func (in *ResourceReference) DeepCopy() *ResourceReference
  • func (in *ResourceReference) DeepCopyInto(out *ResourceReference)
• type SimpleApp
  • func (in *SimpleApp) DeepCopy() *SimpleApp
  • func (in *SimpleApp) DeepCopyInto(out *SimpleApp)
  • func (in *SimpleApp) DeepCopyObject() runtime.Object
• type SimpleAppList
  • func (in *SimpleAppList) DeepCopy() *SimpleAppList
  • func (in *SimpleAppList) DeepCopyInto(out *SimpleAppList)
  • func (in *SimpleAppList) DeepCopyObject() runtime.Object
• type SimpleAppSpec
  • func (in *SimpleAppSpec) DeepCopy() *SimpleAppSpec
  • func (in *SimpleAppSpec) DeepCopyInto(out *SimpleAppSpec)
• type SimpleAppStatus
  • func (in *SimpleAppStatus) DeepCopy() *SimpleAppStatus
  • func (in *SimpleAppStatus) DeepCopyInto(out *SimpleAppStatus)

Variables

var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "apps.otterscale.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type ResourceReference

type ResourceReference struct {
	// Name is the name of the referenced resource.
	// +required
	Name string `json:"name"`

	// Namespace is the namespace of the referenced resource.
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

ResourceReference is a lightweight reference to a Kubernetes resource managed by the operator.

func (*ResourceReference) DeepCopy

func (in *ResourceReference) DeepCopy() *ResourceReference

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

func (*ResourceReference) DeepCopyInto

func (in *ResourceReference) DeepCopyInto(out *ResourceReference)

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

type SimpleApp

type SimpleApp struct {
	metav1.TypeMeta `json:",inline"`

	// Standard object's metadata.
	// +optional
	metav1.ObjectMeta `json:"metadata,omitzero"`

	// Spec defines the desired behavior of the SimpleApp.
	// +required
	Spec SimpleAppSpec `json:"spec"`

	// Status represents the current information about the SimpleApp.
	// +optional
	Status SimpleAppStatus `json:"status,omitzero"`
}

SimpleApp is the Schema for the simpleapps API. A SimpleApp provides a simplified abstraction for deploying an application with an optional Service and PersistentVolumeClaim.

func (*SimpleApp) DeepCopy

func (in *SimpleApp) DeepCopy() *SimpleApp

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

func (*SimpleApp) DeepCopyInto

func (in *SimpleApp) DeepCopyInto(out *SimpleApp)

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

func (*SimpleApp) DeepCopyObject

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

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

type SimpleAppList

type SimpleAppList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitzero"`
	Items           []SimpleApp `json:"items"`
}

SimpleAppList contains a list of SimpleApp resources.

func (*SimpleAppList) DeepCopy

func (in *SimpleAppList) DeepCopy() *SimpleAppList

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

func (*SimpleAppList) DeepCopyInto

func (in *SimpleAppList) DeepCopyInto(out *SimpleAppList)

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

func (*SimpleAppList) DeepCopyObject

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

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

type SimpleAppSpec

type SimpleAppSpec struct {
	// Deployment defines the deployment configuration.
	// The actual schema is composed at runtime by the Schema RPC from the apps/v1 Deployment.
	// +kubebuilder:pruning:PreserveUnknownFields
	// +required
	Deployment runtime.RawExtension `json:"deployment"`

	// Service defines the Service configuration.
	// If specified, a Service will be created.
	// The actual schema is composed at runtime by the Schema RPC from the core/v1 Service.
	// +kubebuilder:pruning:PreserveUnknownFields
	// +optional
	Service *runtime.RawExtension `json:"service,omitempty"`

	// PersistentVolumeClaim defines the PersistentVolumeClaim configuration.
	// If specified, a PersistentVolumeClaim will be created.
	// The actual schema is composed at runtime by the Schema RPC from the core/v1 PersistentVolumeClaim.
	// +kubebuilder:pruning:PreserveUnknownFields
	// +optional
	PersistentVolumeClaim *runtime.RawExtension `json:"persistentVolumeClaim,omitempty"`
}

SimpleAppSpec defines the desired state of a SimpleApp. It wraps a Deployment, optional Service, and optional PersistentVolumeClaim into a single declarative resource.

func (*SimpleAppSpec) DeepCopy

func (in *SimpleAppSpec) DeepCopy() *SimpleAppSpec

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

func (*SimpleAppSpec) DeepCopyInto

func (in *SimpleAppSpec) DeepCopyInto(out *SimpleAppSpec)

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

type SimpleAppStatus

type SimpleAppStatus struct {
	// ObservedGeneration is the most recent generation observed by the controller.
	// It corresponds to the SimpleApp's generation, which is updated on mutation by the API Server.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// DeploymentRef is a reference to the Deployment managed by this SimpleApp.
	// +optional
	DeploymentRef *ResourceReference `json:"deploymentRef,omitempty"`

	// ServiceRef is a reference to the Service managed by this SimpleApp.
	// +optional
	ServiceRef *ResourceReference `json:"serviceRef,omitempty"`

	// PersistentVolumeClaimRef is a reference to the PersistentVolumeClaim managed by this SimpleApp.
	// +optional
	PersistentVolumeClaimRef *ResourceReference `json:"persistentVolumeClaimRef,omitempty"`

	// Conditions store the status conditions of the SimpleApp (e.g., Ready, Progressing, Degraded).
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

SimpleAppStatus defines the observed state of a SimpleApp. It contains references to the actual Kubernetes resources created by the controller.

func (*SimpleAppStatus) DeepCopy

func (in *SimpleAppStatus) DeepCopy() *SimpleAppStatus

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

func (*SimpleAppStatus) DeepCopyInto

func (in *SimpleAppStatus) DeepCopyInto(out *SimpleAppStatus)

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