Documentation
¶
Overview ¶
Package v1beta1 contains the input type for the cue function runner. +kubebuilder:object:generate=true +groupName=cue.fn.crossplane.io +versionName=v1beta1
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CueFunctionParams ¶
type CueFunctionParams struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec is the input spec for the function.
Spec CueInputSpec `json:"spec"`
}
CueFunctionParams can be used to provide input to the cue function runner. +kubebuilder:object:root=true +kubebuilder:storageversion +kubebuilder:resource:categories=crossplane
func (*CueFunctionParams) DeepCopy ¶
func (in *CueFunctionParams) DeepCopy() *CueFunctionParams
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CueFunctionParams.
func (*CueFunctionParams) DeepCopyInto ¶
func (in *CueFunctionParams) DeepCopyInto(out *CueFunctionParams)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CueFunctionParams) DeepCopyObject ¶
func (in *CueFunctionParams) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CueInputSpec ¶
type CueInputSpec struct {
// Source of this script. Currently only Inline is supported.
// +kubebuilder:validation:Enum=Inline
// +kubebuilder:default=Inline
Source ScriptSource `json:"source"`
// Script specifies an inline script
// +optional
Script string `json:"script,omitempty"`
// TTL is a duration string which, when set, will cause the function to set the TTL
// for reconciliation to be the specified value. Defaults to 1m.
// +optional
TTL string `json:"ttl,omitempty"`
// Debug prints inputs to and outputs of the cue script for all XRs.
// Inputs are pre-processed to remove typically irrelevant information like
// the last applied kubectl annotation, managed fields etc.
// Objects are displayed in compact cue format. (the equivalent of `cue fmt -s`)
// When false, individual XRs can still be debugged by annotation them with
// crossplane-function-cue/debug: "true"
// +optional
Debug bool `json:"debug,omitempty"`
// DebugNew controls whether a new XR that is being processed by the function
// has debug output. A "new" XR is determined by the request having only an
// observed composite but no other observed resources. This allows debug output for
// first-time reconciles of XRs when the user has not yet had the opportunity to
// annotate them.
// +optional
DebugNew bool `json:"debugNew,omitempty"`
// DebugRaw disables the pre-processing of inputs.
// +optional
DebugRaw bool `json:"debugRaw,omitempty"`
// DebugScript displays the full generated script that is executed.
// +optional
DebugScript bool `json:"debugScript,omitempty"`
}
CueInputSpec is the spec for running a cue script.
func (*CueInputSpec) DeepCopy ¶
func (in *CueInputSpec) DeepCopy() *CueInputSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CueInputSpec.
func (*CueInputSpec) DeepCopyInto ¶
func (in *CueInputSpec) DeepCopyInto(out *CueInputSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScriptSource ¶
type ScriptSource string
A ScriptSource is a source from which a script can be loaded.
const ( // ScriptSourceInline specifies a script inline. ScriptSourceInline ScriptSource = "Inline" )
Supported script sources.
Source Files