v1

Documentation

Index

• Constants
• Variables
• type ResourceList
  • func (in *ResourceList) DeepCopy() *ResourceList
  • func (in *ResourceList) DeepCopyInto(out *ResourceList)
  • func (in *ResourceList) DeepCopyObject() runtime.Object
  • func (obj *ResourceList) GetObjectKind() schema.ObjectKind
  • func (obj *ResourceList) GroupVersionKind() schema.GroupVersionKind
  • func (obj *ResourceList) SetGroupVersionKind(gvk schema.GroupVersionKind)
• type Result
  • func (in *Result) DeepCopy() *Result
  • func (in *Result) DeepCopyInto(out *Result)
• type ResultFile
  • func (in *ResultFile) DeepCopy() *ResultFile
  • func (in *ResultFile) DeepCopyInto(out *ResultFile)
• type ResultResourceRef
  • func (in *ResultResourceRef) DeepCopy() *ResultResourceRef
  • func (in *ResultResourceRef) DeepCopyInto(out *ResultResourceRef)

Constants

const (

	// ResultSeverityError captures enum value "error"
	ResultSeverityError string = "error"

	// ResultSeverityWarning captures enum value "warning"
	ResultSeverityWarning string = "warning"

	// ResultSeverityInfo captures enum value "info"
	ResultSeverityInfo string = "info"
)

const (
	ResourceListKind = "ResourceList"
)

Variables

var SchemeGroupVersion = schema.GroupVersion{Group: "config.kubernetes.io", Version: "v1"}

Types

type ResourceList

type ResourceList struct {
	// apiVersion of ResourceList
	APIVersion string `json:"apiVersion"`

	// kind of ResourceList i.e. `ResourceList`
	Kind string `json:"kind"`

	// [input/output]
	// Items is a list of Kubernetes objects:
	// https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#types-kinds).
	//
	// A function will read this field in the input ResourceList and populate
	// this field in the output ResourceList.
	Items []*unstructured.Unstructured `json:"items"`

	// [input]
	// FunctionConfig is an optional Kubernetes object for passing arguments to a
	// function invocation.
	// +optional
	FunctionConfig *unstructured.Unstructured `json:"functionConfig,omitempty"`

	// [output]
	// Results is an optional list that can be used by function to emit results
	// for observability and debugging purposes.
	// +optional
	Results []*Result `json:"results,omitempty"`
}

ResourceList ResourceList is the input/output wire format for KRM functions.

swagger:model ResourceList +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ResourceList) DeepCopy

func (in *ResourceList) DeepCopy() *ResourceList

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

func (*ResourceList) DeepCopyInto

func (in *ResourceList) DeepCopyInto(out *ResourceList)

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

func (*ResourceList) DeepCopyObject

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

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

func (*ResourceList) GetObjectKind

func (obj *ResourceList) GetObjectKind() schema.ObjectKind

func (*ResourceList) GroupVersionKind

func (obj *ResourceList) GroupVersionKind() schema.GroupVersionKind

func (*ResourceList) SetGroupVersionKind

func (obj *ResourceList) SetGroupVersionKind(gvk schema.GroupVersionKind)

type Result

type Result struct {
	// Message is a human readable message.
	Message string `json:"message"`

	// file
	// +optional
	File *ResultFile `json:"file,omitempty"`

	// resource ref
	// +optional
	ResourceRef *ResultResourceRef `json:"resourceRef,omitempty"`

	// Severity is the severity of a result:
	//
	// "error": indicates an error result.
	// "warning": indicates a warning result.
	// "info": indicates an informational result.
	//
	// Enum: [error warning info]
	// +optional
	Severity string `json:"severity,omitempty"`

	// Tags is an unstructured key value map stored with a result that may be set
	// by external tools to store and retrieve arbitrary metadata.
	// +optional
	Tags map[string]string `json:"tags,omitempty"`
}

Result result

swagger:model Result

func (*Result) DeepCopy

func (in *Result) DeepCopy() *Result

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

func (*Result) DeepCopyInto

func (in *Result) DeepCopyInto(out *Result)

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

type ResultFile

type ResultFile struct {
	// Path is the OS agnostic, slash-delimited, relative path.
	// e.g. `some-dir/some-file.yaml`.
	Path string `json:"path"`

	// Index of the object in a multi-object YAML file.
	// +optional
	Index float64 `json:"index,omitempty"`
}

ResultFile File references a file containing the resource.

swagger:model ResultFile

func (*ResultFile) DeepCopy

func (in *ResultFile) DeepCopy() *ResultFile

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

func (*ResultFile) DeepCopyInto

func (in *ResultFile) DeepCopyInto(out *ResultFile)

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

type ResultResourceRef

type ResultResourceRef struct {

	// APIVersion refers to the `apiVersion` field of the object manifest.
	APIVersion string `json:"apiVersion"`

	// Kind refers to the `kind` field of the object.
	Kind string `json:"kind"`

	// Name refers to the `metadata.name` field of the object manifest.
	Name string `json:"name"`

	// Namespace refers to the `metadata.namespace` field of the object manifest.
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

ResultResourceRef ResourceRef is the metadata for referencing a Kubernetes object associated with a result.

swagger:model ResultResourceRef

func (*ResultResourceRef) DeepCopy

func (in *ResultResourceRef) DeepCopy() *ResultResourceRef

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

func (*ResultResourceRef) DeepCopyInto

func (in *ResultResourceRef) DeepCopyInto(out *ResultResourceRef)

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