Help us shape the future of Go! Take the 2026 Go Developer Survey

v1beta1

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 5, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package v1beta1 contains the input type for the hcl function runner. +kubebuilder:object:generate=true +groupName=hcl.fn.crossplane.io +versionName=v1beta1

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HclInput

type HclInput struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Source of this script. Currently only Inline is supported.
	// +kubebuilder:validation:Enum=Inline
	// +kubebuilder:default=Inline
	Source ScriptSource `json:"source"`
	// HCL specifies inline hcl. This can be the contents of a single file
	// or a set of files with unique names in txtar format. The actual names of
	// the files are irrelevant and only used for error reporting.
	// +optional
	HCL string `json:"hcl,omitempty"`
	// Debug prints inputs to and outputs of the hcl 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 crossplane render format such that they can easily
	// be re-used for render unit tests.
	// When false, individual XRs can still be debugged by annotating them with
	//    "hcl.fn.crossplane.io/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"`
}

HclInput can be used to provide input to the function. +kubebuilder:object:root=true +kubebuilder:storageversion +kubebuilder:resource:categories=crossplane

func (*HclInput) DeepCopy

func (in *HclInput) DeepCopy() *HclInput

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

func (*HclInput) DeepCopyInto

func (in *HclInput) DeepCopyInto(out *HclInput)

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

func (*HclInput) DeepCopyObject

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

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

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL