Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group. +kubebuilder:object:generate=true +groupName=functions.dev
Index ¶
- Constants
- Variables
- type Function
- func (f *Function) CalculateReadyCondition()
- func (in *Function) DeepCopy() *Function
- func (in *Function) DeepCopyInto(out *Function)
- func (in *Function) DeepCopyObject() runtime.Object
- func (f *Function) InitializeConditions()
- func (f *Function) MarkDeployNotReady(reason, messageFormat string, messageA ...interface{}) bool
- func (f *Function) MarkDeployReady() bool
- func (f *Function) MarkFinalizeFailed(err error) bool
- func (f *Function) MarkMiddlewareNotUpToDate(reason, messageFormat string, messageA ...interface{}) bool
- func (f *Function) MarkMiddlewareNotUpToDateIntentionally(reason, messageFormat string, messageA ...interface{}) bool
- func (f *Function) MarkMiddlewareUpToDate() bool
- func (f *Function) MarkNotReady(reason, messageFormat string, messageA ...interface{}) bool
- func (f *Function) MarkReady() bool
- func (f *Function) MarkSourceNotReady(reason, messageFormat string, messageA ...interface{}) bool
- func (f *Function) MarkSourceReady() bool
- func (f *Function) MarkTerminating() bool
- type FunctionList
- type FunctionSpec
- type FunctionSpecRegistry
- type FunctionSpecRepository
- type FunctionStatus
- type FunctionStatusDeployment
- type FunctionStatusGit
- type FunctionStatusMiddleware
- type FunctionStatusMiddlewareAutoUpdate
Constants ¶
const ( // TypeReady indicates overall readiness (summary condition) TypeReady = "Ready" // TypeSourceReady indicates git source was cloned successfully TypeSourceReady = "SourceReady" // TypeDeployed indicates function is deployed TypeDeployed = "Deployed" // TypeMiddlewareUpToDate indicates middleware is current TypeMiddlewareUpToDate = "MiddlewareUpToDate" )
Condition types
Variables ¶
var ( // GroupVersion is group version used to register these objects. GroupVersion = schema.GroupVersion{Group: "functions.dev", 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 )
var FunctionsConditions = []string{ TypeSourceReady, TypeDeployed, TypeMiddlewareUpToDate, }
Functions ¶
This section is empty.
Types ¶
type Function ¶
type Function struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec FunctionSpec `json:"spec,omitempty"`
Status FunctionStatus `json:"status,omitempty"`
}
Function is the Schema for the functions API.
func (*Function) CalculateReadyCondition ¶
func (f *Function) CalculateReadyCondition()
func (*Function) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Function.
func (*Function) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Function) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Function) InitializeConditions ¶
func (f *Function) InitializeConditions()
InitializeConditions resets all conditions to ensure a fresh start for each reconcile. This prevents stale conditions from previous reconciles from persisting.
func (*Function) MarkDeployNotReady ¶
func (*Function) MarkDeployReady ¶
func (*Function) MarkFinalizeFailed ¶
func (*Function) MarkMiddlewareNotUpToDate ¶
func (*Function) MarkMiddlewareNotUpToDateIntentionally ¶ added in v0.2.0
func (*Function) MarkMiddlewareUpToDate ¶
func (*Function) MarkNotReady ¶
func (*Function) MarkSourceNotReady ¶
func (*Function) MarkSourceReady ¶
func (*Function) MarkTerminating ¶
type FunctionList ¶
type FunctionList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Function `json:"items"`
}
FunctionList contains a list of Function.
func (*FunctionList) DeepCopy ¶
func (in *FunctionList) DeepCopy() *FunctionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionList.
func (*FunctionList) DeepCopyInto ¶
func (in *FunctionList) DeepCopyInto(out *FunctionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*FunctionList) DeepCopyObject ¶
func (in *FunctionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type FunctionSpec ¶
type FunctionSpec struct {
Repository FunctionSpecRepository `json:"repository,omitempty"`
Registry FunctionSpecRegistry `json:"registry,omitempty"`
// AutoUpdateMiddleware defines if the operator should rebuild the function when an outdated middleware is detected.
// Defaults to the global operator config.
AutoUpdateMiddleware *bool `json:"autoUpdateMiddleware,omitempty"`
}
FunctionSpec defines the desired state of Function.
func (*FunctionSpec) DeepCopy ¶
func (in *FunctionSpec) DeepCopy() *FunctionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSpec.
func (*FunctionSpec) DeepCopyInto ¶
func (in *FunctionSpec) DeepCopyInto(out *FunctionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionSpecRegistry ¶
type FunctionSpecRegistry struct {
// AuthSecretRef is the reference to the secret containing the credentials for the registry authentication
AuthSecretRef *v1.LocalObjectReference `json:"authSecretRef,omitempty"`
}
func (*FunctionSpecRegistry) DeepCopy ¶
func (in *FunctionSpecRegistry) DeepCopy() *FunctionSpecRegistry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSpecRegistry.
func (*FunctionSpecRegistry) DeepCopyInto ¶
func (in *FunctionSpecRegistry) DeepCopyInto(out *FunctionSpecRegistry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionSpecRepository ¶ added in v0.2.0
type FunctionSpecRepository struct {
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength=1
// URL of the Git repository containing the function
URL string `json:"url"`
// +kubebuilder:validation:Optional
// Branch of the repository
Branch string `json:"branch,omitempty"`
// AuthSecretRef defines the reference to the auth secret in case the repository is private and needs authentication
AuthSecretRef *v1.LocalObjectReference `json:"authSecretRef,omitempty"`
// +kubebuilder:validation:Optional
// Path points to the function inside the repository. Defaults to "."
// TODO: implement logic
Path string `json:"path,omitempty"`
}
func (*FunctionSpecRepository) DeepCopy ¶ added in v0.2.0
func (in *FunctionSpecRepository) DeepCopy() *FunctionSpecRepository
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSpecRepository.
func (*FunctionSpecRepository) DeepCopyInto ¶ added in v0.2.0
func (in *FunctionSpecRepository) DeepCopyInto(out *FunctionSpecRepository)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionStatus ¶
type FunctionStatus struct {
Name string `json:"name"`
Conditions []metav1.Condition `json:"conditions,omitempty"`
Git FunctionStatusGit `json:"git,omitempty"`
Deployment FunctionStatusDeployment `json:"deployment,omitempty"`
Middleware FunctionStatusMiddleware `json:"middleware,omitempty"`
}
FunctionStatus defines the observed state of Function.
func (*FunctionStatus) DeepCopy ¶
func (in *FunctionStatus) DeepCopy() *FunctionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionStatus.
func (*FunctionStatus) DeepCopyInto ¶
func (in *FunctionStatus) DeepCopyInto(out *FunctionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionStatusDeployment ¶ added in v0.2.0
type FunctionStatusDeployment struct {
Image string `json:"image,omitempty"`
ImageBuilt metav1.Time `json:"imageBuilt,omitempty"`
Deployer string `json:"deployer,omitempty"`
Runtime string `json:"runtime,omitempty"`
}
func (*FunctionStatusDeployment) DeepCopy ¶ added in v0.2.0
func (in *FunctionStatusDeployment) DeepCopy() *FunctionStatusDeployment
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionStatusDeployment.
func (*FunctionStatusDeployment) DeepCopyInto ¶ added in v0.2.0
func (in *FunctionStatusDeployment) DeepCopyInto(out *FunctionStatusDeployment)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionStatusGit ¶ added in v0.2.0
type FunctionStatusGit struct {
ResolvedBranch string `json:"resolvedBranch,omitempty"`
ObservedCommit string `json:"observedCommit,omitempty"`
LastChecked metav1.Time `json:"lastChecked,omitempty"`
}
func (*FunctionStatusGit) DeepCopy ¶ added in v0.2.0
func (in *FunctionStatusGit) DeepCopy() *FunctionStatusGit
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionStatusGit.
func (*FunctionStatusGit) DeepCopyInto ¶ added in v0.2.0
func (in *FunctionStatusGit) DeepCopyInto(out *FunctionStatusGit)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionStatusMiddleware ¶ added in v0.2.0
type FunctionStatusMiddleware struct {
Current string `json:"current,omitempty"`
Available *string `json:"available,omitempty"`
AutoUpdate FunctionStatusMiddlewareAutoUpdate `json:"autoUpdate"`
PendingRebuild bool `json:"pendingRebuild"` // no omitempty to have it always shown
LastRebuild metav1.Time `json:"lastRebuild,omitempty"`
}
func (*FunctionStatusMiddleware) DeepCopy ¶ added in v0.2.0
func (in *FunctionStatusMiddleware) DeepCopy() *FunctionStatusMiddleware
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionStatusMiddleware.
func (*FunctionStatusMiddleware) DeepCopyInto ¶ added in v0.2.0
func (in *FunctionStatusMiddleware) DeepCopyInto(out *FunctionStatusMiddleware)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionStatusMiddlewareAutoUpdate ¶ added in v0.2.0
type FunctionStatusMiddlewareAutoUpdate struct {
Enabled bool `json:"enabled"` // no omitempty to have it always shown
Source string `json:"source,omitempty"`
}
func (*FunctionStatusMiddlewareAutoUpdate) DeepCopy ¶ added in v0.2.0
func (in *FunctionStatusMiddlewareAutoUpdate) DeepCopy() *FunctionStatusMiddlewareAutoUpdate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionStatusMiddlewareAutoUpdate.
func (*FunctionStatusMiddlewareAutoUpdate) DeepCopyInto ¶ added in v0.2.0
func (in *FunctionStatusMiddlewareAutoUpdate) DeepCopyInto(out *FunctionStatusMiddlewareAutoUpdate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.