v1beta1

package
v0.0.0-...-cb1a7a4 Latest Latest
Warning

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

 Go to latest Published: Aug 21, 2022 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package v1beta1 is the v1 beta 1 version of the API.

+groupName=relay.sh +kubebuilder:object:generate=true

Index

Constants

This section is empty.

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme

	TenantKind         = SchemeGroupVersion.WithKind("Tenant")
	RunKind            = SchemeGroupVersion.WithKind("Run")
	WebhookTriggerKind = SchemeGroupVersion.WithKind("WebhookTrigger")
	WorkflowKind       = SchemeGroupVersion.WithKind("Workflow")
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: "relay.sh", Version: "v1beta1"}

Functions

func Kind 

func Kind(kind string) schema.GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Types

type APITokenSource 

type APITokenSource struct {
	// SecretKeyRef selects an API token by looking up the value in a secret.
	//
	// +optional
	SecretKeyRef *SecretKeySelector `json:"secretKeyRef,omitempty"`
}

func (*APITokenSource) DeepCopy 

func (in *APITokenSource) DeepCopy() *APITokenSource

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

func (*APITokenSource) DeepCopyInto 

func (in *APITokenSource) DeepCopyInto(out *APITokenSource)

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

type APITriggerEventSink 

type APITriggerEventSink struct {
	URL string `json:"url"`

	// Token is the API token to use.
	//
	// +optional
	Token string `json:"token,omitempty"`

	// TokenFrom allows the API token to be provided by another resource.
	//
	// +optional
	TokenFrom *APITokenSource `json:"tokenFrom,omitempty"`
}

func (*APITriggerEventSink) DeepCopy 

func (in *APITriggerEventSink) DeepCopy() *APITriggerEventSink

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

func (*APITriggerEventSink) DeepCopyInto 

func (in *APITriggerEventSink) DeepCopyInto(out *APITriggerEventSink)

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

type APIWorkflowExecutionSink 

type APIWorkflowExecutionSink struct {
	URL string `json:"url"`

	// Token is the API token to use.
	//
	// +optional
	Token string `json:"token,omitempty"`

	// TokenFrom allows the API token to be provided by another resource.
	//
	// +optional
	TokenFrom *APITokenSource `json:"tokenFrom,omitempty"`
}

func (*APIWorkflowExecutionSink) DeepCopy 

func (in *APIWorkflowExecutionSink) DeepCopy() *APIWorkflowExecutionSink

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

func (*APIWorkflowExecutionSink) DeepCopyInto 

func (in *APIWorkflowExecutionSink) DeepCopyInto(out *APIWorkflowExecutionSink)

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

type Condition 

type Condition struct {
	Status             corev1.ConditionStatus `json:"status"`
	LastTransitionTime metav1.Time            `json:"lastTransitionTime"`

	// Reason identifies the cause of the given status using an API-locked
	// camel-case identifier.
	//
	// +optional
	Reason string `json:"reason,omitempty"`

	// Message is a human-readable description of the given status.
	//
	// +optional
	Message string `json:"message,omitempty"`
}

Condition is the base type for Relay conditions, inlined into each condition type.

func (*Condition) DeepCopy 

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto 

func (in *Condition) DeepCopyInto(out *Condition)

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

type Container 

type Container struct {
	// Image is the Docker image to run when this webhook receives an event.
	Image string `json:"image"`

	// Input is the input script to provide to the container.
	//
	// +optional
	Input []string `json:"input,omitempty"`

	// Command is the path to the executable to run when the container starts.
	//
	// +optional
	Command string `json:"command,omitempty"`

	// Args are the command arguments.
	//
	// +optional
	Args []string `json:"args,omitempty"`

	// Spec is the Relay specification to be provided to the container image.
	//
	// +optional
	Spec UnstructuredObject `json:"spec,omitempty"`

	// Env allows environment variables to be provided to the container image.
	//
	// +optional
	Env UnstructuredObject `json:"env,omitempty"`
}

func (*Container) DeepCopy 

func (in *Container) DeepCopy() *Container

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

func (*Container) DeepCopyInto 

func (in *Container) DeepCopyInto(out *Container)

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

type Decorator 

type Decorator struct {
	// Name is a way to identify the decorator
	Name string `json:"name"`

	// Link is a link-type decorator.
	// +optional
	Link *DecoratorLink `json:"link,omitempty"`
}

Decorator describes a result for a concluded step. These can be added to steps to represent hints to UI's (web, cli, etc.) about data generated as a result of a step's run.

func (*Decorator) DeepCopy 

func (in *Decorator) DeepCopy() *Decorator

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

func (*Decorator) DeepCopyInto 

func (in *Decorator) DeepCopyInto(out *Decorator)

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

type DecoratorLink struct {
	// Description describes what the URI points to.
	Description string `json:"description"`

	// URI must follow the syntax outlined in
	// https://datatracker.ietf.org/doc/html/rfc3986 and must be parsable by
	// Go's url.Parse function.
	URI string `json:"uri"`
}

DecoratorLink holds the value for a link-type result.

func (*DecoratorLink) DeepCopy 

func (in *DecoratorLink) DeepCopy() *DecoratorLink

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

func (*DecoratorLink) DeepCopyInto 

func (in *DecoratorLink) DeepCopyInto(out *DecoratorLink)

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

type Log 

type Log struct {
	// Name of the associated log.
	//
	// +optional
	Name string `json:"name"`

	// Context of the associated log.
	//
	// +optional
	Context string `json:"context"`
}

func (*Log) DeepCopy 

func (in *Log) DeepCopy() *Log

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

func (*Log) DeepCopyInto 

func (in *Log) DeepCopyInto(out *Log)

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

type LogStepMessageSource 

type LogStepMessageSource struct{}

LogStepMessageSource indicates that a step message originated in the execution of a step's container itself.

func (*LogStepMessageSource) DeepCopy 

func (in *LogStepMessageSource) DeepCopy() *LogStepMessageSource

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

func (*LogStepMessageSource) DeepCopyInto 

func (in *LogStepMessageSource) DeepCopyInto(out *LogStepMessageSource)

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

type NamespaceTemplate 

type NamespaceTemplate struct {
	// Metadata is the metadata to associate with the namespace to create, such
	// as a name and list of labels. If not specified, values are automatically
	// generated.
	//
	// Labels from the tenant are automatically propagated onto the created
	// namespace.
	//
	// +optional
	// +kubebuilder:validation:XPreserveUnknownFields
	Metadata metav1.ObjectMeta `json:"metadata,omitempty"`
}

func (*NamespaceTemplate) DeepCopy 

func (in *NamespaceTemplate) DeepCopy() *NamespaceTemplate

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

func (*NamespaceTemplate) DeepCopyInto 

func (in *NamespaceTemplate) DeepCopyInto(out *NamespaceTemplate)

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

type Parameter 

type Parameter struct {
	// Name is a unique name for this parameter.
	Name string `json:"name"`

	// Value is the default value for this parameter. If not specified, a value
	// must be provided at runtime.
	//
	// +optional
	Value *Unstructured `json:"default,omitempty"`
}

func (*Parameter) DeepCopy 

func (in *Parameter) DeepCopy() *Parameter

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

func (*Parameter) DeepCopyInto 

func (in *Parameter) DeepCopyInto(out *Parameter)

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

type Run 

type Run struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              RunSpec `json:"spec"`

	// +optional
	Status RunStatus `json:"status,omitempty"`
}

Run is a request to invoke a workflow.

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:storageversion

func (*Run) DeepCopy 

func (in *Run) DeepCopy() *Run

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

func (*Run) DeepCopyInto 

func (in *Run) DeepCopyInto(out *Run)

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

func (*Run) DeepCopyObject 

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

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

type RunCondition 

type RunCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=Cancelled;Completed;Succeeded
	Type RunConditionType `json:"type"`
}

func (*RunCondition) DeepCopy 

func (in *RunCondition) DeepCopy() *RunCondition

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

func (*RunCondition) DeepCopyInto 

func (in *RunCondition) DeepCopyInto(out *RunCondition)

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

type RunConditionType 

type RunConditionType string
const (
	// RunCancelled indicates whether a run was cancelled.
	RunCancelled RunConditionType = "Cancelled"

	// RunCompleted indicates whether an entire run has finished executing.
	RunCompleted RunConditionType = "Completed"

	// RunSucceeded indicates a run has succeeded.
	RunSucceeded RunConditionType = "Succeeded"
)

type RunList 

type RunList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Run `json:"items"`
}

RunList enumerates many Run resources.

+kubebuilder:object:root=true

func (*RunList) DeepCopy 

func (in *RunList) DeepCopy() *RunList

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

func (*RunList) DeepCopyInto 

func (in *RunList) DeepCopyInto(out *RunList)

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

func (*RunList) DeepCopyObject 

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

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

type RunSpec 

type RunSpec struct {
	// Parameters assigns values to parameters defined in the workflow.
	//
	// +optional
	Parameters UnstructuredObject `json:"parameters,omitempty"`

	// State allows applying desired state changes.
	//
	// +optional
	State RunState `json:"state,omitempty"`

	// WorkflowRef selects a defined workflow to use for this run.
	WorkflowRef corev1.LocalObjectReference `json:"workflowRef"`
}

func (*RunSpec) DeepCopy 

func (in *RunSpec) DeepCopy() *RunSpec

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

func (*RunSpec) DeepCopyInto 

func (in *RunSpec) DeepCopyInto(out *RunSpec)

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

type RunState 

type RunState struct {
	// Workflow allows applying desired workflow state changes.
	//
	// +optional
	Workflow UnstructuredObject `json:"workflow,omitempty"`

	// Step allows applying desired step state changes.
	// +optional
	Steps map[string]UnstructuredObject `json:"steps,omitempty"`
}

func (*RunState) DeepCopy 

func (in *RunState) DeepCopy() *RunState

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

func (*RunState) DeepCopyInto 

func (in *RunState) DeepCopyInto(out *RunState)

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

type RunStatus 

type RunStatus struct {
	// ObservedGeneration is the generation of the resource specification that
	// this status matches.
	//
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Steps provides information about the status of each step that makes up
	// this workflow run.
	//
	// +optional
	// +listType=map
	// +listMapKey=name
	Steps []*StepStatus `json:"steps,omitempty"`

	// StartTime is the this run began executing.
	//
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// CompletionTime is the time this run ended, whether successful or not.
	//
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// Conditions are the possible observable conditions for this run.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []RunCondition `json:"conditions,omitempty"`
}

func (*RunStatus) DeepCopy 

func (in *RunStatus) DeepCopy() *RunStatus

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

func (*RunStatus) DeepCopyInto 

func (in *RunStatus) DeepCopyInto(out *RunStatus)

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

type SecretKeySelector 

type SecretKeySelector struct {
	corev1.LocalObjectReference `json:",inline"`

	// Key is the key from the secret to use.
	Key string `json:"key"`
}

func (*SecretKeySelector) DeepCopy 

func (in *SecretKeySelector) DeepCopy() *SecretKeySelector

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

func (*SecretKeySelector) DeepCopyInto 

func (in *SecretKeySelector) DeepCopyInto(out *SecretKeySelector)

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

type SpecValidationStepMessageSource 

type SpecValidationStepMessageSource struct {
	// Path is the location within the spec to the expression that originated
	// the message, expressed as a JSON Pointer (RFC 6901).
	//
	// If not specified, or empty, the path refers to the entire spec.
	Path string `json:"path"`

	// Expression is the actual data of the expression that failed to validate,
	// copied verbatim from the workflow definition and relative to the path
	// field, if it is available.
	//
	// +optional
	Expression *Unstructured `json:"expression,omitempty"`

	// Schema is the JSON Schema that caused the validation error relative to
	// the path field.
	//
	// +optional
	Schema *Unstructured `json:"schema,omitempty"`
}

SpecValidationStepMessageSource indicates that a step message came from the runtime validation of its spec.

func (*SpecValidationStepMessageSource) DeepCopy 

func (in *SpecValidationStepMessageSource) DeepCopy() *SpecValidationStepMessageSource

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

func (*SpecValidationStepMessageSource) DeepCopyInto 

func (in *SpecValidationStepMessageSource) DeepCopyInto(out *SpecValidationStepMessageSource)

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

type Step 

type Step struct {
	// Name is a unique name for this step.
	Name string `json:"name"`

	// Container defines the properties of the Docker container to run.
	Container `json:",inline"`

	// When provides a set of conditions that must be met for this step to run.
	//
	// +optional
	When *Unstructured `json:"when,omitempty"`

	// DependsOn causes this step to run after the given step names.
	//
	// +optional
	DependsOn []string `json:"dependsOn,omitempty"`
}

func (*Step) DeepCopy 

func (in *Step) DeepCopy() *Step

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

func (*Step) DeepCopyInto 

func (in *Step) DeepCopyInto(out *Step)

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

type StepCondition 

type StepCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=Completed;Skipped;Succeeded
	Type StepConditionType `json:"type"`
}

func (*StepCondition) DeepCopy 

func (in *StepCondition) DeepCopy() *StepCondition

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

func (*StepCondition) DeepCopyInto 

func (in *StepCondition) DeepCopyInto(out *StepCondition)

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

type StepConditionType 

type StepConditionType string
const (
	// StepCompleted indicates whether a step has finished executing.
	StepCompleted StepConditionType = "Completed"

	// StepSkipped indicates a step has been skipped.
	StepSkipped StepConditionType = "Skipped"

	// StepSucceeded indicates a step has succeeded.
	StepSucceeded StepConditionType = "Succeeded"
)

type StepMessage 

type StepMessage struct {
	// Source is the origin of the message.
	Source StepMessageSource `json:"source"`

	// Severity indicates the importance of this message.
	//
	// +kubebuilder:validation:Enum=Trace;Informational;Warning;Error
	Severity StepMessageSeverity `json:"severity"`

	// ObservationTime is the time that the causal event for the message
	// occurred.
	//
	// This may be different from the time the message was actually added to the
	// Run object.
	ObservationTime metav1.Time `json:"observationTime"`

	// Short is an abbreviated description of the message (if available) that
	// could be shown as a title or in space-constrained user interfaces.
	//
	// If not specified, the first few characters of the details will be used
	// instead.
	//
	// +kubebuilder:validation:MaxLength=24
	// +optional
	Short string `json:"short,omitempty"`

	// Details is the text content of the message to show to an interested user.
	//
	// +kubebuilder:validation:MaxLength=1024
	Details string `json:"details"`
}

func (*StepMessage) DeepCopy 

func (in *StepMessage) DeepCopy() *StepMessage

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

func (*StepMessage) DeepCopyInto 

func (in *StepMessage) DeepCopyInto(out *StepMessage)

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

type StepMessageSeverity 

type StepMessageSeverity string
const (
	// StepMessageSeverityTrace is for highly detailed messages that should
	// normally be hidden but could be inspected for debugging purposes.
	StepMessageSeverityTrace StepMessageSeverity = "Trace"

	// StepMessageSeverityInformational is for messages that alert a user to a
	// particular condition in a step's execution that does not require any user
	// action.
	StepMessageSeverityInformational StepMessageSeverity = "Informational"

	// StepMessageSeverityWarning is for important messages reporting on an
	// anomolous condition encountered by a step, but that do not necessarily
	// require user intervention.
	StepMessageSeverityWarning StepMessageSeverity = "Warning"

	// StepMessageSeverityError is for messages that indicate the step
	// encountered an uncorrectable situation. The step will usually fail, and
	// the user may need to intervene before retrying.
	StepMessageSeverityError StepMessageSeverity = "Error"
)

type StepMessageSource 

type StepMessageSource struct {
	// WhenEvaluation is a source used by runtime processing of when conditions.
	//
	// +optional
	WhenEvaluation *WhenEvaluationStepMessageSource `json:"whenEvaluation,omitempty"`

	// SpecValidation is a source used by the runtime validation of the spec.
	//
	// +optional
	SpecValidation *SpecValidationStepMessageSource `json:"specValidation,omitempty"`

	// Log is a source used by the logging APIs exposed to step authors.
	//
	// +optional
	Log *LogStepMessageSource `json:"log,omitempty"`
}

StepMessageSource is the origin of a step message.

At most one of the fields may be specified at any given time. The behavior is undefined if no source is specified or if more than one is specified.

func (*StepMessageSource) DeepCopy 

func (in *StepMessageSource) DeepCopy() *StepMessageSource

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

func (*StepMessageSource) DeepCopyInto 

func (in *StepMessageSource) DeepCopyInto(out *StepMessageSource)

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

type StepOutput 

type StepOutput struct {
	// Name is the name of this output.
	Name string `json:"name"`

	// Sensitive is whether this output contains sensitive or privileged data.
	// If this output is sensitive, the value will not be set.
	//
	// +optional
	Sensitive bool `json:"sensitive"`

	// Value is the value provided by the step for the output.
	//
	// +optional
	Value *Unstructured `json:"value"`
}

func (*StepOutput) DeepCopy 

func (in *StepOutput) DeepCopy() *StepOutput

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

func (*StepOutput) DeepCopyInto 

func (in *StepOutput) DeepCopyInto(out *StepOutput)

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

type StepStatus 

type StepStatus struct {
	// Name is the name of this step.
	Name string `json:"name"`

	// Outputs are each of the outputs provided by this step, if available.
	//
	// +optional
	// +listType=map
	// +listMapKey=name
	Outputs []*StepOutput `json:"outputs,omitempty"`

	// +optional
	// +listType=map
	// +listMapKey=name
	Decorators []*Decorator `json:"decorators,omitempty"`

	// Messages provide additional human-oriented context information about a
	// step's execution.
	//
	// +optional
	Messages []*StepMessage `json:"messages,omitempty"`

	// StartTime is the time this step began executing.
	//
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// CompletionTime is the time this step ended, whether successful or not.
	//
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// InitializationTime is the time taken to initialize the step.
	//
	// +optional
	InitializationTime *metav1.Time `json:"initTime,omitempty"`

	// Associated logs for this step.
	//
	// +optional
	Logs []*Log `json:"logs,omitempty"`

	// Conditions are the possible observable conditions for this step.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []StepCondition `json:"conditions,omitempty"`
}

func (*StepStatus) DeepCopy 

func (in *StepStatus) DeepCopy() *StepStatus

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

func (*StepStatus) DeepCopyInto 

func (in *StepStatus) DeepCopyInto(out *StepStatus)

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

type Tenant 

type Tenant struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              TenantSpec `json:"spec"`

	// +optional
	Status TenantStatus `json:"status"`
}

Tenant represents a scoping mechanism for runs and triggers.

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:storageversion

func (*Tenant) DeepCopy 

func (in *Tenant) DeepCopy() *Tenant

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

func (*Tenant) DeepCopyInto 

func (in *Tenant) DeepCopyInto(out *Tenant)

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

func (*Tenant) DeepCopyObject 

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

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

type TenantCondition 

type TenantCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=NamespaceReady;EventSinkReady;ToolInjectionReady;Ready
	Type TenantConditionType `json:"type"`
}

func (*TenantCondition) DeepCopy 

func (in *TenantCondition) DeepCopy() *TenantCondition

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

func (*TenantCondition) DeepCopyInto 

func (in *TenantCondition) DeepCopyInto(out *TenantCondition)

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

type TenantConditionType 

type TenantConditionType string
const (
	// TenantNamespaceReady indicates whether the namespace requested by the
	// tenant namespace template is ready to use.
	TenantNamespaceReady TenantConditionType = "NamespaceReady"

	// TenantEventSinkReady indicates whether the event sink can be used. For
	// example, any secret references must be resolvable.
	TenantEventSinkReady TenantConditionType = "EventSinkReady"

	// TenantReady is set when all other conditions are ready.
	TenantReady TenantConditionType = "Ready"
)

type TenantList 

type TenantList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Tenant `json:"items"`
}

TenantList enumerates many Tenant resources.

+kubebuilder:object:root=true

func (*TenantList) DeepCopy 

func (in *TenantList) DeepCopy() *TenantList

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

func (*TenantList) DeepCopyInto 

func (in *TenantList) DeepCopyInto(out *TenantList)

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

func (*TenantList) DeepCopyObject 

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

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

type TenantSpec 

type TenantSpec struct {
	// NamespaceTemplate defines a template for a namespace that will be created
	// for this scope. If not specified, resources are created in the namespace
	// of this resource.
	//
	// +optional
	NamespaceTemplate NamespaceTemplate `json:"namespaceTemplate,omitempty"`

	// ToolInjection allows configuration of the PVC to be used for the
	// container runtime tools.
	//
	// +optional
	ToolInjection ToolInjection `json:"toolInjection,omitempty"`

	// TriggerEventSink represents the destination for events received as part
	// of trigger processing. If not specified, events will be logged and
	// discarded.
	//
	// +optional
	TriggerEventSink TriggerEventSink `json:"triggerEventSink,omitempty"`

	// WorkflowExecutionSink represents the destrination for workflow run requests.
	// If not specified, the metadata-api workflow run endpoint will reject a
	// request to run a workflow.
	//
	// +optional
	WorkflowExecutionSink WorkflowExecutionSink `json:"workflowExecutionSink,omitempty"`
}

func (*TenantSpec) DeepCopy 

func (in *TenantSpec) DeepCopy() *TenantSpec

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

func (*TenantSpec) DeepCopyInto 

func (in *TenantSpec) DeepCopyInto(out *TenantSpec)

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

type TenantStatus 

type TenantStatus struct {
	// ObservedGeneration is the generation of the resource specification that
	// this status matches.
	//
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Namespace is the namespace managed by this tenant or the namespace of the
	// tenant if it is unmanaged.
	//
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// Conditions are the observations of this resource's state.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []TenantCondition `json:"conditions,omitempty"`
}

func (*TenantStatus) DeepCopy 

func (in *TenantStatus) DeepCopy() *TenantStatus

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

func (*TenantStatus) DeepCopyInto 

func (in *TenantStatus) DeepCopyInto(out *TenantStatus)

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

type ToolInjection 

type ToolInjection struct {
	// VolumeClaimTemplate is an optional definition of the PVC that will be
	// populated and attached to every tenant container.
	//
	// +optional
	VolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
}

func (*ToolInjection) DeepCopy 

func (in *ToolInjection) DeepCopy() *ToolInjection

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

func (*ToolInjection) DeepCopyInto 

func (in *ToolInjection) DeepCopyInto(out *ToolInjection)

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

type TriggerEventSink 

type TriggerEventSink struct {
	// API is an event sink for the propretiary Relay API.
	//
	// +optional
	API *APITriggerEventSink `json:"api,omitempty"`
}

TriggerEventSink represents the destination for trigger events. At most one of the fields may be specified at any one given time. If more than one is specified, the behavior is undefined.

func (*TriggerEventSink) DeepCopy 

func (in *TriggerEventSink) DeepCopy() *TriggerEventSink

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

func (*TriggerEventSink) DeepCopyInto 

func (in *TriggerEventSink) DeepCopyInto(out *TriggerEventSink)

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

type Unstructured 

type Unstructured struct {
	// contains filtered or unexported fields
}

Unstructured is arbitrary JSON data, which may also include base64-encoded binary data.

+kubebuilder:validation:Type="" +kubebuilder:validation:XPreserveUnknownFields

func AsUnstructured 

func AsUnstructured(value interface{}) Unstructured

func (*Unstructured) DeepCopy 

func (in *Unstructured) DeepCopy() *Unstructured

func (*Unstructured) DeepCopyInto 

func (in *Unstructured) DeepCopyInto(out *Unstructured)

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

func (Unstructured) MarshalJSON 

func (u Unstructured) MarshalJSON() ([]byte, error)

func (*Unstructured) UnmarshalJSON 

func (u *Unstructured) UnmarshalJSON(data []byte) error

func (Unstructured) Value 

func (u Unstructured) Value() interface{}

type UnstructuredObject 

type UnstructuredObject map[string]Unstructured

func NewUnstructuredObject 

func NewUnstructuredObject(value map[string]interface{}) UnstructuredObject

func (UnstructuredObject) DeepCopy 

func (in UnstructuredObject) DeepCopy() UnstructuredObject

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

func (UnstructuredObject) DeepCopyInto 

func (in UnstructuredObject) DeepCopyInto(out *UnstructuredObject)

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

func (UnstructuredObject) Value 

func (uo UnstructuredObject) Value() map[string]interface{}

type WebhookTrigger 

type WebhookTrigger struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              WebhookTriggerSpec `json:"spec"`

	// +optional
	Status WebhookTriggerStatus `json:"status,omitempty"`
}

WebhookTrigger represents a definition of a webhook to receive events.

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:storageversion

func (*WebhookTrigger) DeepCopy 

func (in *WebhookTrigger) DeepCopy() *WebhookTrigger

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

func (*WebhookTrigger) DeepCopyInto 

func (in *WebhookTrigger) DeepCopyInto(out *WebhookTrigger)

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

func (*WebhookTrigger) DeepCopyObject 

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

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

type WebhookTriggerCondition 

type WebhookTriggerCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=ServiceReady;Ready
	Type WebhookTriggerConditionType `json:"type"`
}

func (*WebhookTriggerCondition) DeepCopy 

func (in *WebhookTriggerCondition) DeepCopy() *WebhookTriggerCondition

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

func (*WebhookTriggerCondition) DeepCopyInto 

func (in *WebhookTriggerCondition) DeepCopyInto(out *WebhookTriggerCondition)

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

type WebhookTriggerConditionType 

type WebhookTriggerConditionType string
const (
	WebhookTriggerServiceReady WebhookTriggerConditionType = "ServiceReady"
	WebhookTriggerReady        WebhookTriggerConditionType = "Ready"
)

type WebhookTriggerList 

type WebhookTriggerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []WebhookTrigger `json:"items"`
}

WebhookTriggerList enumerates many WebhookTrigger resources.

+kubebuilder:object:root=true

func (*WebhookTriggerList) DeepCopy 

func (in *WebhookTriggerList) DeepCopy() *WebhookTriggerList

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

func (*WebhookTriggerList) DeepCopyInto 

func (in *WebhookTriggerList) DeepCopyInto(out *WebhookTriggerList)

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

func (*WebhookTriggerList) DeepCopyObject 

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

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

type WebhookTriggerSpec 

type WebhookTriggerSpec struct {
	// TenantRef selects the tenant to apply this trigger to.
	TenantRef corev1.LocalObjectReference `json:"tenantRef"`

	// Name is a friendly name for this webhook trigger used for authentication
	// and reporting.
	//
	// +optional
	Name string `json:"name,omitempty"`

	// Container defines the properties of the Docker container to run.
	Container `json:",inline"`
}

func (*WebhookTriggerSpec) DeepCopy 

func (in *WebhookTriggerSpec) DeepCopy() *WebhookTriggerSpec

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

func (*WebhookTriggerSpec) DeepCopyInto 

func (in *WebhookTriggerSpec) DeepCopyInto(out *WebhookTriggerSpec)

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

type WebhookTriggerStatus 

type WebhookTriggerStatus struct {
	// ObservedGeneration is the generation of the resource specification that
	// this status matches.
	//
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Namespace is the Kubernetes namespace containing the target resources of
	// this webhook trigger.
	//
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// URL is the endpoint for the webhook once provisioned.
	//
	// +optional
	URL string `json:"url,omitempty"`

	// Conditions are the observations of this resource's tate.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []WebhookTriggerCondition `json:"conditions,omitempty"`
}

func (*WebhookTriggerStatus) DeepCopy 

func (in *WebhookTriggerStatus) DeepCopy() *WebhookTriggerStatus

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

func (*WebhookTriggerStatus) DeepCopyInto 

func (in *WebhookTriggerStatus) DeepCopyInto(out *WebhookTriggerStatus)

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

type WhenEvaluationStepMessageSource 

type WhenEvaluationStepMessageSource struct {
	// Path is the location within the when condition to the expression that
	// originated the message, expressed as a JSON Pointer (RFC 6901).
	//
	// If not specified, or empty, the path refers to the entire when condition.
	Path string `json:"path"`

	// Expression is the actual data of the expression that failed to evaluate,
	// copied verbatim from the workflow definition and relative to the path
	// field, if it is available.
	//
	// +optional
	Expression *Unstructured `json:"expression,omitempty"`
}

WhenEvaluationStepMessageSource indicates that a step message came from the runtime processing of its when conditions.

func (*WhenEvaluationStepMessageSource) DeepCopy 

func (in *WhenEvaluationStepMessageSource) DeepCopy() *WhenEvaluationStepMessageSource

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

func (*WhenEvaluationStepMessageSource) DeepCopyInto 

func (in *WhenEvaluationStepMessageSource) DeepCopyInto(out *WhenEvaluationStepMessageSource)

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

type Workflow 

type Workflow struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              WorkflowSpec `json:"spec"`
}

Workflow represents a set of steps that Relay can execute.

+kubebuilder:object:root=true +kubebuilder:storageversion

func (*Workflow) DeepCopy 

func (in *Workflow) DeepCopy() *Workflow

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

func (*Workflow) DeepCopyInto 

func (in *Workflow) DeepCopyInto(out *Workflow)

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

func (*Workflow) DeepCopyObject 

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

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

type WorkflowExecutionSink 

type WorkflowExecutionSink struct {
	// API is a workflow run sink for the propretiary Relay API.
	//
	// +optional
	API *APIWorkflowExecutionSink `json:"api,omitempty"`
}

WorkflowExecutionSink represents the destination for workflow run requests. At most one of the fields may be specified at any one given time. If more than one is specified, the behavior is undefined.

func (*WorkflowExecutionSink) DeepCopy 

func (in *WorkflowExecutionSink) DeepCopy() *WorkflowExecutionSink

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

func (*WorkflowExecutionSink) DeepCopyInto 

func (in *WorkflowExecutionSink) DeepCopyInto(out *WorkflowExecutionSink)

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

type WorkflowList 

type WorkflowList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Workflow `json:"items"`
}

WorkflowList enumerates many Workflow resources.

+kubebuilder:object:root=true

func (*WorkflowList) DeepCopy 

func (in *WorkflowList) DeepCopy() *WorkflowList

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

func (*WorkflowList) DeepCopyInto 

func (in *WorkflowList) DeepCopyInto(out *WorkflowList)

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

func (*WorkflowList) DeepCopyObject 

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

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

type WorkflowSpec 

type WorkflowSpec struct {
	// TenantRef selects the tenant to use for this workflow.
	TenantRef corev1.LocalObjectReference `json:"tenantRef"`

	// Parameters are the definitions of parameters used by this workflow.
	//
	// +optional
	// +listType=map
	// +listMapKey=name
	Parameters []*Parameter `json:"parameters,omitempty"`

	// Steps are the individual steps that make up the workflow.
	//
	// +optional
	// +listType=map
	// +listMapKey=name
	Steps []*Step `json:"steps,omitempty"`
}

func (*WorkflowSpec) DeepCopy 

func (in *WorkflowSpec) DeepCopy() *WorkflowSpec

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

func (*WorkflowSpec) DeepCopyInto 

func (in *WorkflowSpec) DeepCopyInto(out *WorkflowSpec)

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.