v1alpha1

Documentation

Overview

Package v1 contains API Schema definitions for the camel v1 API group +kubebuilder:object:generate=true +groupName=camel.apache.org

Package v1 contains API Schema definitions for the camel v1 API group +kubebuilder:object:generate=true +groupName=camel.apache.org

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type App
  • func NewApp(namespace string, name string) App
  • func (in *App) DeepCopy() *App
  • func (in *App) DeepCopyInto(out *App)
  • func (in *App) DeepCopyObject() runtime.Object
• type AppList
  • func NewAppList() AppList
  • func (in *AppList) DeepCopy() *AppList
  • func (in *AppList) DeepCopyInto(out *AppList)
  • func (in *AppList) DeepCopyObject() runtime.Object
• type AppPhase
• type AppSpec
  • func (in *AppSpec) DeepCopy() *AppSpec
  • func (in *AppSpec) DeepCopyInto(out *AppSpec)
• type AppStatus
  • func (appStatus *AppStatus) AddCondition(condition metav1.Condition)
  • func (in *AppStatus) DeepCopy() *AppStatus
  • func (in *AppStatus) DeepCopyInto(out *AppStatus)
• type ExchangeInfo
  • func (in *ExchangeInfo) DeepCopy() *ExchangeInfo
  • func (in *ExchangeInfo) DeepCopyInto(out *ExchangeInfo)
• type ObservabilityServiceInfo
  • func (in *ObservabilityServiceInfo) DeepCopy() *ObservabilityServiceInfo
  • func (in *ObservabilityServiceInfo) DeepCopyInto(out *ObservabilityServiceInfo)
• type PodInfo
  • func (in *PodInfo) DeepCopy() *PodInfo
  • func (in *PodInfo) DeepCopyInto(out *PodInfo)
• type RuntimeInfo
  • func (in *RuntimeInfo) DeepCopy() *RuntimeInfo
  • func (in *RuntimeInfo) DeepCopyInto(out *RuntimeInfo)

Constants

const (
	// AppLabel is used to tag k8s object created by a given Camel Application.
	AppLabel = "camel.apache.org/app"
	// AppSyntheticLabel is used to tag k8s synthetic Camel Applications.
	AppSyntheticLabel = "camel.apache.org/is-synthetic"
	// AppImportedKindLabel specifies from what kind of resource an App was imported.
	AppImportedKindLabel = "camel.apache.org/imported-from-kind"
	// AppImportedNameLabel specifies from what resource an App was imported.
	AppImportedNameLabel = "camel.apache.org/imported-from-name"
	// AppPollingIntervalSecondsAnnotation is used to instruct a given application to poll interval.
	AppPollingIntervalSecondsAnnotation = "camel.apache.org/polling-interval-seconds"
)

const (
	// AppKind --.
	AppKind string = "App"
)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "camel.apache.org", Version: "v1alpha1"}

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

	// AddToScheme is a shortcut to SchemeBuilder.AddToScheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource.

Types

type App

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

	// the desired App specification
	Spec AppSpec `json:"spec,omitempty"`
	// the status of the App
	Status AppStatus `json:"status,omitempty"`
}

App is the Schema for the Camel Applications API.

func NewApp

func NewApp(namespace string, name string) App

func (*App) DeepCopy

func (in *App) DeepCopy() *App

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

func (*App) DeepCopyInto

func (in *App) DeepCopyInto(out *App)

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

func (*App) DeepCopyObject

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

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

type AppList

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

AppList contains a list of Apps.

func NewAppList

func NewAppList() AppList

func (*AppList) DeepCopy

func (in *AppList) DeepCopy() *AppList

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

func (*AppList) DeepCopyInto

func (in *AppList) DeepCopyInto(out *AppList)

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

func (*AppList) DeepCopyObject

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

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

type AppPhase

type AppPhase string

AppPhase --.

const (
	// AppPhaseRunning --.
	AppPhaseRunning AppPhase = "Running"
	// AppPhaseError --.
	AppPhaseError AppPhase = "Error"
)

type AppSpec

type AppSpec struct {
}

AppSpec specifies the configuration of an App.

func (*AppSpec) DeepCopy

func (in *AppSpec) DeepCopy() *AppSpec

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

func (*AppSpec) DeepCopyInto

func (in *AppSpec) DeepCopyInto(out *AppSpec)

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

type AppStatus

type AppStatus struct {
	// the actual phase
	Phase AppPhase `json:"phase,omitempty"`
	// the image used to run the application
	Image string `json:"image,omitempty"`
	// Some information about the pods backing the application
	Pods []PodInfo `json:"pods,omitempty"`
	// The number of replicas (pods running)
	Replicas *int32 `json:"replicas,omitempty"`
	// The number of replicas (pods running)
	Info string `json:"info,omitempty"`
	// The conditions catching more detailed information
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

AppStatus defines the observed state of an App.

func (*AppStatus) AddCondition

func (appStatus *AppStatus) AddCondition(condition metav1.Condition)

func (*AppStatus) DeepCopy

func (in *AppStatus) DeepCopy() *AppStatus

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

func (*AppStatus) DeepCopyInto

func (in *AppStatus) DeepCopyInto(out *AppStatus)

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

type ExchangeInfo

type ExchangeInfo struct {
	// The total number of exchanges
	Total int `json:"total,omitempty"`
	// The total number of exchanges succeeded
	Succeeded int `json:"succeed,omitempty"`
	// The total number of exchanges failed
	Failed int `json:"failed,omitempty"`
	// The total number of exchanges pending (in Camel jargon, inflight exchanges)
	Pending int `json:"pending,omitempty"`
}

ExchangeInfo contains the endpoints that can be possibly used to scrape more information.

func (*ExchangeInfo) DeepCopy

func (in *ExchangeInfo) DeepCopy() *ExchangeInfo

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

func (*ExchangeInfo) DeepCopyInto

func (in *ExchangeInfo) DeepCopyInto(out *ExchangeInfo)

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

type ObservabilityServiceInfo

type ObservabilityServiceInfo struct {
	// the health endpoint
	HealthEndpoint string `json:"healthEndpoint,omitempty"`
	// the health port
	HealthPort int `json:"healthPort,omitempty"`
	// the metrics endpoint
	MetricsEndpoint string `json:"metricsEndpoint,omitempty"`
	// the metrics port
	MetricsPort int `json:"metricsPort,omitempty"`
}

ObservabilityServiceInfo contains the endpoints that can be possibly used to scrape more information.

func (*ObservabilityServiceInfo) DeepCopy

func (in *ObservabilityServiceInfo) DeepCopy() *ObservabilityServiceInfo

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

func (*ObservabilityServiceInfo) DeepCopyInto

func (in *ObservabilityServiceInfo) DeepCopyInto(out *ObservabilityServiceInfo)

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

type PodInfo

type PodInfo struct {
	// the Pod name
	Name string `json:"name,omitempty"`
	// the Pod ip
	InternalIP string `json:"internalIp,omitempty"`
	// the Pod status
	Status string `json:"status,omitempty"`
	// the Pod readiness
	Ready bool `json:"ready,omitempty"`
	// Observability services information
	ObservabilityService *ObservabilityServiceInfo `json:"observe,omitempty"`
	// Some information about the Camel runtime
	Runtime *RuntimeInfo `json:"runtime,omitempty"`
}

PodInfo contains a set of information related to the Pod running the Camel application.

func (*PodInfo) DeepCopy

func (in *PodInfo) DeepCopy() *PodInfo

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

func (*PodInfo) DeepCopyInto

func (in *PodInfo) DeepCopyInto(out *PodInfo)

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

type RuntimeInfo

type RuntimeInfo struct {
	// the status as reported by health endpoint
	Status string `json:"status,omitempty"`
	// the runtime provider
	RuntimeProvider string `json:"runtimeProvider,omitempty"`
	// the runtime version
	RuntimeVersion string `json:"runtimeVersion,omitempty"`
	// the Camel core version
	CamelVersion string `json:"camelVersion,omitempty"`
	// Information about the exchange
	Exchange *ExchangeInfo `json:"exchange,omitempty"`
}

RuntimeInfo contains a set of information related to the Camel application runtime.

func (*RuntimeInfo) DeepCopy

func (in *RuntimeInfo) DeepCopy() *RuntimeInfo

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

func (*RuntimeInfo) DeepCopyInto

func (in *RuntimeInfo) DeepCopyInto(out *RuntimeInfo)

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