Documentation
¶
Overview ¶
Package v1alpha1 contains the input type for this Function +kubebuilder:object:generate=true +groupName=template.fn.crossplane.io +versionName=v1alpha1
Index ¶
Constants ¶
const FieldRefDefault = ""
FieldRefDefault optional value result returned for an Optional FieldRef. Defaults to an empty string.
const FieldRefPolicyOptional = "Optional"
FieldRefPolicyOptional if the field is not available use the value of FieldRefDefault.
const FieldRefPolicyRequired = "Required"
FieldRefPolicyRequired will error if the field is not available.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FieldRef ¶ added in v0.5.0
type FieldRef struct {
// Path is the field path of the field being referenced, i.e. spec.myfield, status.output
Path string `json:"path"`
// Policy when the field is not available. If set to "Required" will return
// an error if a field is missing. If set to "Optional" will return DefaultValue.
// +optional
// +kubebuilder:default:=Required
// +kubebuilder:validation:Enum=Optional;Required
Policy FieldRefPolicy `json:"policy,omitempty"`
// DefaultValue when Policy is Optional and field is not available defaults to ""
// +optional
// +kbuebuilder:default:=""
DefaultValue string `json:"defaultValue,omitempty"`
}
FieldRef refers to a composite field like spec.region.
func (*FieldRef) DeepCopy ¶ added in v0.5.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FieldRef.
func (*FieldRef) DeepCopyInto ¶ added in v0.5.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FieldRefPolicy ¶ added in v0.5.0
type FieldRefPolicy string
FieldRefPolicy is a field path Policy.
type Parameters ¶
type Parameters struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata"`
// shellEnvVarsRef
// +optional
ShellEnvVarsRef ShellEnvVarsRef `json:"shellEnvVarsRef"`
// shellEnvVars
// +optional
ShellEnvVars []ShellEnvVar `json:"shellEnvVars"`
// shellCmd
// +optional
ShellCommand string `json:"shellCommand"`
// shellCmdField
// +optional
ShellCommandField string `json:"shellCommandField,omitempty"`
// stdoutField
// +optional
StdoutField string `json:"stdoutField,omitempty"`
// stderrField
// +optional
StderrField string `json:"stderrField,omitempty"`
// TTL for response cache. Function Response caching is an
// alpha feature in Crossplane can be deprecated or changed
// in the future.
// +optional
// +kubebuilder:default:="1m"
CacheTTL string `json:"cacheTTL,omitempty"`
}
Parameters can be used to provide input to this Function. +kubebuilder:object:root=true +kubebuilder:storageversion +kubebuilder:resource:categories=crossplane
func (*Parameters) DeepCopy ¶
func (in *Parameters) DeepCopy() *Parameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Parameters.
func (*Parameters) DeepCopyInto ¶
func (in *Parameters) DeepCopyInto(out *Parameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Parameters) DeepCopyObject ¶
func (in *Parameters) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ShellEnvVar ¶
type ShellEnvVar struct {
// Key is the Environment Variable key like API_KEY
Key string `json:"key,omitempty"`
// Value is a fixed value, like http://api.example.com
Value string `json:"value,omitempty"`
// ValueRef retrieves a Environment Variable value from a composite field.
// Can result in error if field is not set: use FieldRef which can handle missing fields.
ValueRef string `json:"valueRef,omitempty"`
// FieldRef is a reference to a field in the Composition.
FieldRef *FieldRef `json:"fieldRef,omitempty"`
// Type is the type of ShellEnVar: Value, ValueRef, FieldRef.
Type ShellEnvVarType `json:"type,omitempty"`
}
ShellEnvVar is a Shell Environment Variable of the form key=value.
func (*ShellEnvVar) DeepCopy ¶
func (in *ShellEnvVar) DeepCopy() *ShellEnvVar
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShellEnvVar.
func (*ShellEnvVar) DeepCopyInto ¶
func (in *ShellEnvVar) DeepCopyInto(out *ShellEnvVar)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ShellEnvVar) GetType ¶ added in v0.5.0
func (sev *ShellEnvVar) GetType() ShellEnvVarType
GetType determines the ShellEnvVar type.
type ShellEnvVarType ¶ added in v0.5.0
type ShellEnvVarType string
ShellEnvVarType is a type of ShellEnvVar.
const ( // ShellEnvVarTypeFieldRef is a reference to a field in the Composition. ShellEnvVarTypeFieldRef ShellEnvVarType = "FieldRef" // ShellEnvVarTypeValue populates the value from a string. ShellEnvVarTypeValue ShellEnvVarType = "Value" // ShellEnvVarTypeValueRef is a reference to a field in the Composition. ShellEnvVarTypeValueRef ShellEnvVarType = "ValueRef" )
type ShellEnvVarsRef ¶
type ShellEnvVarsRef struct {
// The Key whose value is the secret
Keys []string `json:"keys,omitempty"`
// Name of the environment variable
Name string `json:"name,omitempty"`
}
ShellEnvVarsRef refers to an environment variable or secret leaded into the function pod.
func (*ShellEnvVarsRef) DeepCopy ¶
func (in *ShellEnvVarsRef) DeepCopy() *ShellEnvVarsRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShellEnvVarsRef.
func (*ShellEnvVarsRef) DeepCopyInto ¶
func (in *ShellEnvVarsRef) DeepCopyInto(out *ShellEnvVarsRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files