v1alpha1

package
v0.0.0-...-c054a23 Latest Latest
Warning

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

 Go to latest Published: Apr 8, 2022 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v1alpha1 containes the MKS CustomResourceDefinition and its structs.

Currently there are three custom mks resource:-

  • MksTask
  • MksTaskRun
  • MksPipelineRun

Basics

A CustomResourceDefinition defined in a YAML file can be registered by providing its corresponding structs. For example let us take the following YAML: 

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
# name must match the spec fields below, and be in the form: <plural>.<group>
name: resource.mks.example.com
spec:
# group name to use for REST API: /apis/<group>/<version>
group: mks.example.com
# list of versions supported by this CustomResourceDefinition
versions:
	- name: v1
	# Each version can be enabled/disabled by Served flag.
	served: true
	# One and only one version must be marked as the storage version.
	storage: true
	schema:
		openAPIV3Schema:
		type: object
		properties:
			spec:
			type: object
			properties:
				name:
				type: string
# either Namespaced or Cluster
scope: Namespaced
names:
	# plural name to be used in the URL: /apis/<group>/<version>/<plural>
	plural: resources
	# singular name to be used as an alias on the CLI and for display
	singular: resource
	# kind is normally the CamelCased singular type. Your resource manifests use this.
	kind: Resource
	# shortNames allow shorter string to match your resource on the CLI
	shortNames:
	- rs

The above CRD can be translated into following structs: 

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

type Resource struct {
	metav1.TypeMeta 	`json:",inline"`
	metav1.ObjectMeta 	`json:"metadata,omitempty"`

	Spec ResourceSpec 	`json:"spec"`
}

type ResourceSpec struct {
	Name string `json:"name"`
}

type ResourceList struct {
	metav1.TypeMeta 	`json:",inline"`
	metav1.ListMeta 	`json:"metadata"`

	Items []Resource 	`json:"items"`
}

Working

Notice how the 'schema' field is translated into different struct based on its type. For each 'object' you should have a dedicated struct, for other types you should have fields inside the struct.

Code generation

Later Deepcopygen is used to generate cleintset and deepcopy definitions for these structs. They can be denoted in the file by adding following comment above the structs. 

// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

See https://github.com/kubernetes/code-generator for more information on code generation.

Register

Every defined type must be registered. See register.go in this package for more information on this.

Index

Constants

This section is empty.

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: mkscontroller.GroupName, Version: "v1alpha1"}

Group and Version to uniquely identify the API.

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind return the GroupKind for the current Group-Version pair.

func Resource 

func Resource(resource string) schema.GroupResource

Reosurce returns the GroupResource for the current Group-Version pair.

Types

type ArrayOrString 

type ArrayOrString struct {
	Type      string   `json:"type"` // Represents the stored type of ArrayOrString.
	StringVal string   `json:"stringVal"`
	ArrayVal  []string `json:"arrayVal"`
}

ArrayOrString is a type that can hold a single string or string array. Used in JSON unmarshalling so that a single JSON field can accept either an individual string or an array of strings.

func (*ArrayOrString) DeepCopy 

func (in *ArrayOrString) DeepCopy() *ArrayOrString

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

func (*ArrayOrString) DeepCopyInto 

func (in *ArrayOrString) DeepCopyInto(out *ArrayOrString)

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

type MksConfigMap 

type MksConfigMap struct {
	Name string `json:"name"`
}

func (*MksConfigMap) DeepCopy 

func (in *MksConfigMap) DeepCopy() *MksConfigMap

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

func (*MksConfigMap) DeepCopyInto 

func (in *MksConfigMap) DeepCopyInto(out *MksConfigMap)

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

type MksParam 

type MksParam struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

func (*MksParam) DeepCopy 

func (in *MksParam) DeepCopy() *MksParam

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

func (*MksParam) DeepCopyInto 

func (in *MksParam) DeepCopyInto(out *MksParam)

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

type MksParamSpec 

type MksParamSpec struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Type        string `json:"type"`
	Default     string `json:"default,omitempty"`
}

func (*MksParamSpec) DeepCopy 

func (in *MksParamSpec) DeepCopy() *MksParamSpec

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

func (*MksParamSpec) DeepCopyInto 

func (in *MksParamSpec) DeepCopyInto(out *MksParamSpec)

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

type MksPersistentVolumeClaim 

type MksPersistentVolumeClaim struct {
	ClaimName string `json:"claimName"`
}

func (*MksPersistentVolumeClaim) DeepCopy 

func (in *MksPersistentVolumeClaim) DeepCopy() *MksPersistentVolumeClaim

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

func (*MksPersistentVolumeClaim) DeepCopyInto 

func (in *MksPersistentVolumeClaim) DeepCopyInto(out *MksPersistentVolumeClaim)

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

type MksPipeline 

type MksPipeline struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec MksPipelineSpec `json:"spec"`
}

+genclient +genreconciler +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*MksPipeline) DeepCopy 

func (in *MksPipeline) DeepCopy() *MksPipeline

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

func (*MksPipeline) DeepCopyInto 

func (in *MksPipeline) DeepCopyInto(out *MksPipeline)

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

func (*MksPipeline) DeepCopyObject 

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

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

type MksPipelineList 

type MksPipelineList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []MksPipeline `json:"items"`
}

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

func (*MksPipelineList) DeepCopy 

func (in *MksPipelineList) DeepCopy() *MksPipelineList

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

func (*MksPipelineList) DeepCopyInto 

func (in *MksPipelineList) DeepCopyInto(out *MksPipelineList)

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

func (*MksPipelineList) DeepCopyObject 

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

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

type MksPipelineRun 

type MksPipelineRun struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec MksPipelineRunSpec `json:"spec"`
}

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

MksPipelineRun struct corresponds to the following CustomResourceDefinition: 

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: mkspipelineruns.mkscontroller.example.mks
spec:
group: mkscontroller.example.mks
versions:
	- name: v1alpha1
	served: true
	storage: true
	schema:
		# schema used for validation
		openAPIV3Schema:
		type: object
		properties:
			spec:
			type: object
			properties:
				pipelineRef:
				type: object
				properties:
					name:
					type: string
names:
	kind: MksPipelineRun
	plural: mkspipelineruns
scope: Namespaced

func (*MksPipelineRun) DeepCopy 

func (in *MksPipelineRun) DeepCopy() *MksPipelineRun

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

func (*MksPipelineRun) DeepCopyInto 

func (in *MksPipelineRun) DeepCopyInto(out *MksPipelineRun)

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

func (*MksPipelineRun) DeepCopyObject 

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

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

type MksPipelineRunList 

type MksPipelineRunList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []MksPipelineRun `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object MksPipelineRunList struct defines a list for the MksPipelineRun type.

func (*MksPipelineRunList) DeepCopy 

func (in *MksPipelineRunList) DeepCopy() *MksPipelineRunList

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

func (*MksPipelineRunList) DeepCopyInto 

func (in *MksPipelineRunList) DeepCopyInto(out *MksPipelineRunList)

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

func (*MksPipelineRunList) DeepCopyObject 

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

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

type MksPipelineRunRef 

type MksPipelineRunRef struct {
	Name string `json:"name"` // name of the pipeline to be referenced
}

MksPipelneRunRef struct defines the PipelineRef field of MkspipelineRunref. - Name name of the pipeline to be referenced

func (*MksPipelineRunRef) DeepCopy 

func (in *MksPipelineRunRef) DeepCopy() *MksPipelineRunRef

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

func (*MksPipelineRunRef) DeepCopyInto 

func (in *MksPipelineRunRef) DeepCopyInto(out *MksPipelineRunRef)

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

type MksPipelineRunSpec 

type MksPipelineRunSpec struct {
	PipelineRef MksPipelineRunRef `json:"pipelineRef"`
	Workspaces  []MksprWorkspaces `json:"workspaces,omitempty"`
	Params      []MksParam        `json:"params,omitempty"`
}

MksPipelineRunSpec struct defines the Spec field of MksPipelineRun struct.

func (*MksPipelineRunSpec) DeepCopy 

func (in *MksPipelineRunSpec) DeepCopy() *MksPipelineRunSpec

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

func (*MksPipelineRunSpec) DeepCopyInto 

func (in *MksPipelineRunSpec) DeepCopyInto(out *MksPipelineRunSpec)

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

type MksPipelineSpec 

type MksPipelineSpec struct {
	Workspaces []MksPipelineWorkspace `json:"workspaces,omitempty"`
	Param      []ParamSpec            `json:"params,omitempty"`
	Task       []MksPipelineTask      `json:"tasks"`
}

func (*MksPipelineSpec) DeepCopy 

func (in *MksPipelineSpec) DeepCopy() *MksPipelineSpec

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

func (*MksPipelineSpec) DeepCopyInto 

func (in *MksPipelineSpec) DeepCopyInto(out *MksPipelineSpec)

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

type MksPipelineTask 

type MksPipelineTask struct {
	Name            string                 `json:"name"`
	PipelineTaskRef MksPipelineTaskRef     `json:"taskRef"`
	Workspaces      []MksPipelineWorkspace `json:"workspaces,omitempty"`
	Param           []Param                `json:"params,omitempty"`
	RunAfter        []string               `json:"runAfter,omitempty"`
}

func (*MksPipelineTask) DeepCopy 

func (in *MksPipelineTask) DeepCopy() *MksPipelineTask

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

func (*MksPipelineTask) DeepCopyInto 

func (in *MksPipelineTask) DeepCopyInto(out *MksPipelineTask)

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

type MksPipelineTaskRef 

type MksPipelineTaskRef struct {
	Name string `json:"name"` // name of the task to be referenced
	Kind string `json:"kind,omitempty"`
}

func (*MksPipelineTaskRef) DeepCopy 

func (in *MksPipelineTaskRef) DeepCopy() *MksPipelineTaskRef

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

func (*MksPipelineTaskRef) DeepCopyInto 

func (in *MksPipelineTaskRef) DeepCopyInto(out *MksPipelineTaskRef)

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

type MksPipelineWorkspace 

type MksPipelineWorkspace struct {
	Name      string `json:"name"`
	Workspace string `json:"workspace,omitempty"`
}

func (*MksPipelineWorkspace) DeepCopy 

func (in *MksPipelineWorkspace) DeepCopy() *MksPipelineWorkspace

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

func (*MksPipelineWorkspace) DeepCopyInto 

func (in *MksPipelineWorkspace) DeepCopyInto(out *MksPipelineWorkspace)

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

type MksTask 

type MksTask struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec MksTaskSpec `json:"spec"`
}

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

MksTask struct corresponds to the following CustomResourceDefinition: 

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: mkstasks.mkscontroller.example.mks
spec:
group: mkscontroller.example.mks
versions:
	- name: v1alpha1
	served: true
	storage: true
	schema:
		# schema used for validation
		openAPIV3Schema:
		type: object
		properties:
			spec:
			type: object
			properties:
				name:
				type: string
				image:
				type: string
				command:
				type: string
				args:
				type: string

names:
	kind: MksTask
	plural: mkstasks
scope: Namespaced

func (*MksTask) DeepCopy 

func (in *MksTask) DeepCopy() *MksTask

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

func (*MksTask) DeepCopyInto 

func (in *MksTask) DeepCopyInto(out *MksTask)

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

func (*MksTask) DeepCopyObject 

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

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

type MksTaskList 

type MksTaskList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []MksTask `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object MksTaskList struct defines a list for the MksTask type.

func (*MksTaskList) DeepCopy 

func (in *MksTaskList) DeepCopy() *MksTaskList

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

func (*MksTaskList) DeepCopyInto 

func (in *MksTaskList) DeepCopyInto(out *MksTaskList)

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

func (*MksTaskList) DeepCopyObject 

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

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

type MksTaskRef 

type MksTaskRef struct {
	Name string `json:"name"` // name of the task to be referenced
}

MksTaskRef struct defines the TaskRef field of the MkstaskRunSpec. - Name name of the task to be referenced

func (*MksTaskRef) DeepCopy 

func (in *MksTaskRef) DeepCopy() *MksTaskRef

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

func (*MksTaskRef) DeepCopyInto 

func (in *MksTaskRef) DeepCopyInto(out *MksTaskRef)

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

type MksTaskRun 

type MksTaskRun struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec MksTaskRunSpec `json:"spec"`
}

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

MksTaskRun struct corresponds to the following CustomResourceDefinition: 

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: mkstaskruns.mkscontroller.example.mks
spec:
group: mkscontroller.example.mks
versions:
	- name: v1alpha1
	served: true
	storage: true
	schema:
		# schema used for validation
		openAPIV3Schema:
		type: object
		properties:
			spec:
			type: object
			properties:
				taskRef:
				type: object
				properties:
					name:
					type: string

names:
	kind: MksTaskRun
	plural: mkstaskruns
scope: Namespaced

func (*MksTaskRun) DeepCopy 

func (in *MksTaskRun) DeepCopy() *MksTaskRun

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

func (*MksTaskRun) DeepCopyInto 

func (in *MksTaskRun) DeepCopyInto(out *MksTaskRun)

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

func (*MksTaskRun) DeepCopyObject 

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

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

type MksTaskRunList 

type MksTaskRunList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []MksTaskRun `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object MksTaskRunList struct defines a list for the MksTaskRun type.

func (*MksTaskRunList) DeepCopy 

func (in *MksTaskRunList) DeepCopy() *MksTaskRunList

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

func (*MksTaskRunList) DeepCopyInto 

func (in *MksTaskRunList) DeepCopyInto(out *MksTaskRunList)

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

func (*MksTaskRunList) DeepCopyObject 

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

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

type MksTaskRunSpec 

type MksTaskRunSpec struct {
	TaskRef MksTaskRef `json:"taskRef"`
}

MksTaskRunSpec struct defines the Spec field of MksTaskRun struct.

func (*MksTaskRunSpec) DeepCopy 

func (in *MksTaskRunSpec) DeepCopy() *MksTaskRunSpec

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

func (*MksTaskRunSpec) DeepCopyInto 

func (in *MksTaskRunSpec) DeepCopyInto(out *MksTaskRunSpec)

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

type MksTaskSpec 

type MksTaskSpec struct {
	Steps  []MksTaskSteps `json:"steps"`
	Params []MksParamSpec `json:"params,omitempty"`
}

MksTaskSpec struct defines the Spec field of the MksTask struct. - Name name of the task. - Image docker image for the task. - Command command to be run. - Args arguments to the command.

func (*MksTaskSpec) DeepCopy 

func (in *MksTaskSpec) DeepCopy() *MksTaskSpec

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

func (*MksTaskSpec) DeepCopyInto 

func (in *MksTaskSpec) DeepCopyInto(out *MksTaskSpec)

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

type MksTaskSteps 

type MksTaskSteps struct {
	Name       string `json:"name"`    // name of the task
	Image      string `json:"image"`   // docker image for the task
	Command    string `json:"command"` // command to be run
	WorkingDir string `json:"workingDir,omitempty"`
	Args       string `json:"args"` // arguments to the command
}

func (*MksTaskSteps) DeepCopy 

func (in *MksTaskSteps) DeepCopy() *MksTaskSteps

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

func (*MksTaskSteps) DeepCopyInto 

func (in *MksTaskSteps) DeepCopyInto(out *MksTaskSteps)

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

type MksprWorkspaces 

type MksprWorkspaces struct {
	Name                  string                   `json:"name"`
	PersistentVolumeClaim MksPersistentVolumeClaim `json:"persistentVolumeClaim,omitempty"`
	ConfigMap             MksConfigMap             `json:"configMap,omitempty"`
}

func (*MksprWorkspaces) DeepCopy 

func (in *MksprWorkspaces) DeepCopy() *MksprWorkspaces

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

func (*MksprWorkspaces) DeepCopyInto 

func (in *MksprWorkspaces) DeepCopyInto(out *MksprWorkspaces)

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

type Param 

type Param struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

Param defines a string value to be used for a ParamSpec with the same name.

func (*Param) DeepCopy 

func (in *Param) DeepCopy() *Param

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

func (*Param) DeepCopyInto 

func (in *Param) DeepCopyInto(out *Param)

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

type ParamSpec 

type ParamSpec struct {
	// Name declares the name by which a parameter is referenced.
	Name string `json:"name"`

	// Type is the user-specified type of the parameter. The possible types
	// are currently "string" and "array", and "string" is the default.
	// +optional
	Type string `json:"type,omitempty"`
	// Description is a user-facing description of the parameter that may be
	// used to populate a UI.
	// +optional
	Description string `json:"description,omitempty"`
	// Default is the value a parameter takes if no input value via a Param is supplied.
	// +optional
	Default string `json:"default,omitempty"`
}

ParamSpec defines an arbitrary named input whose value can be supplied by a `Param`.

func (*ParamSpec) DeepCopy 

func (in *ParamSpec) DeepCopy() *ParamSpec

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

func (*ParamSpec) DeepCopyInto 

func (in *ParamSpec) DeepCopyInto(out *ParamSpec)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.