v1alpha1

package
v0.8.0-pre.1 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2019 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the kudo v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kudobuilder/kudo/pkg/apis/kudo +k8s:defaulter-gen=TypeMeta +groupName=kudo.dev

Package v1alpha1 contains API Schema definitions for the kudo v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kudobuilder/kudo/pkg/apis/kudo +k8s:defaulter-gen=TypeMeta +groupName=kudo.dev

Index

Constants

View Source 
const DefaultKINDContext = "kind"

DefaultKINDContext defines the default kind context to use.

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "kudo.dev", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme is required by pkg/client/...
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

Types

type AggregatedStatus added in v0.7.0 

type AggregatedStatus struct {
	Status         ExecutionStatus `json:"status,omitempty"`
	ActivePlanName string          `json:"activePlanName,omitempty"`
}

AggregatedStatus is overview of an instance status derived from the plan status

func (*AggregatedStatus) DeepCopy added in v0.7.0 

func (in *AggregatedStatus) DeepCopy() *AggregatedStatus

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

func (*AggregatedStatus) DeepCopyInto added in v0.7.0 

func (in *AggregatedStatus) DeepCopyInto(out *AggregatedStatus)

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

type Command added in v0.7.0 

type Command struct {
	// The command and argument to run as a string.
	Command string `json:"command"`
	// If set, the `--namespace` flag will be appended to the command with the namespace to use.
	Namespaced bool `json:"namespaced"`
	// If set, failures will be ignored.
	IgnoreFailure bool `json:"ignoreFailure"`
}

Command describes a command to run as a part of a test step or suite.

func (*Command) DeepCopy added in v0.7.0 

func (in *Command) DeepCopy() *Command

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

func (*Command) DeepCopyInto added in v0.7.0 

func (in *Command) DeepCopyInto(out *Command)

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

type DummyTaskSpec 

type DummyTaskSpec struct {
	WantErr bool `json:"wantErr"`
	Fatal   bool `json:"fatal"`
	Done    bool `json:"done"`
}

DummyTaskSpec can succeed of fail on demand and is very useful for testing operators

func (*DummyTaskSpec) DeepCopy 

func (in *DummyTaskSpec) DeepCopy() *DummyTaskSpec

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

func (*DummyTaskSpec) DeepCopyInto 

func (in *DummyTaskSpec) DeepCopyInto(out *DummyTaskSpec)

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

type ExecutionStatus added in v0.7.0 

type ExecutionStatus string

ExecutionStatus captures the state of the rollout. 

const (
	// ExecutionInProgress actively deploying, but not yet healthy.
	ExecutionInProgress ExecutionStatus = "IN_PROGRESS"

	// ExecutionPending Not ready to deploy because dependent phases/steps not healthy.
	ExecutionPending ExecutionStatus = "PENDING"

	// ExecutionComplete deployed and healthy.
	ExecutionComplete ExecutionStatus = "COMPLETE"

	// ErrorStatus there was an error deploying the application.
	ErrorStatus ExecutionStatus = "ERROR"

	// ExecutionFatalError there was an error deploying the application.
	ExecutionFatalError ExecutionStatus = "FATAL_ERROR"

	// ExecutionNeverRun is used when this plan/phase/step was never run so far
	ExecutionNeverRun ExecutionStatus = "NEVER_RUN"

	// DeployPlanName is the name of the deployment plan
	DeployPlanName = "deploy"

	// UpgradePlanName is the name of the upgrade plan
	UpgradePlanName = "upgrade"

	// UpdatePlanName is the name of the update plan
	UpdatePlanName = "update"
)

func (ExecutionStatus) IsFinished added in v0.7.0 

func (s ExecutionStatus) IsFinished() bool

IsFinished returns true if the status is complete regardless of errors

func (ExecutionStatus) IsRunning added in v0.7.0 

func (s ExecutionStatus) IsRunning() bool

IsRunning returns true if the plan is currently being executed

func (ExecutionStatus) IsTerminal added in v0.7.0 

func (s ExecutionStatus) IsTerminal() bool

IsTerminal returns true if the status is terminal (either complete, or in a nonrecoverable error)

type Instance 

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

	Spec   InstanceSpec   `json:"spec,omitempty"`
	Status InstanceStatus `json:"status,omitempty"`
}

Instance is the Schema for the instances API. +k8s:openapi-gen=true

func (*Instance) DeepCopy 

func (in *Instance) DeepCopy() *Instance

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

func (*Instance) DeepCopyInto 

func (in *Instance) DeepCopyInto(out *Instance)

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

func (*Instance) DeepCopyObject 

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

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

func (*Instance) EnsurePlanStatusInitialized added in v0.7.0 

func (i *Instance) EnsurePlanStatusInitialized(ov *OperatorVersion)

EnsurePlanStatusInitialized initializes plan status for all plans this instance supports it does not trigger run of any plan it either initializes everything for a fresh instance without any status or tries to adjust status after OV was updated

func (*Instance) GetLastExecutedPlanStatus added in v0.7.5 

func (i *Instance) GetLastExecutedPlanStatus() *PlanStatus

GetLastExecutedPlanStatus returns status of plan that is currently running, if there is one running if no plan is running it looks for last executed plan based on timestamps

func (*Instance) GetPlanInProgress added in v0.7.0 

func (i *Instance) GetPlanInProgress() *PlanStatus

GetPlanInProgress returns plan status of currently active plan or nil if no plan is running

func (*Instance) GetPlanToBeExecuted added in v0.7.0 

func (i *Instance) GetPlanToBeExecuted(ov *OperatorVersion) (*string, error)

GetPlanToBeExecuted returns name of the plan that should be executed

func (*Instance) NoPlanEverExecuted added in v0.7.0 

func (i *Instance) NoPlanEverExecuted() bool

NoPlanEverExecuted returns true is this is new instance for which we never executed any plan

func (*Instance) OperatorVersionNamespace added in v0.7.0 

func (i *Instance) OperatorVersionNamespace() string

OperatorVersionNamespace returns the namespace of the OperatorVersion that the Instance references.

func (*Instance) SaveSnapshot added in v0.7.0 

func (i *Instance) SaveSnapshot() error

SaveSnapshot stores the current spec of Instance into the snapshot annotation this information is used when executing update/upgrade plans, this overrides any snapshot that existed before

func (*Instance) StartPlanExecution added in v0.7.0 

func (i *Instance) StartPlanExecution(planName string, ov *OperatorVersion) error

StartPlanExecution mark plan as to be executed

func (*Instance) UpdateInstanceStatus added in v0.7.0 

func (i *Instance) UpdateInstanceStatus(planStatus *PlanStatus)

UpdateInstanceStatus updates `Status.PlanStatus` and `Status.AggregatedStatus` property based on the given plan

type InstanceError added in v0.7.0 

type InstanceError struct {
	EventName *string // nil if no warn event should be created
	// contains filtered or unexported fields
}

InstanceError indicates error on that can also emit a kubernetes warn event +k8s:deepcopy-gen=false

func (*InstanceError) Error added in v0.7.0 

func (e *InstanceError) Error() string

type InstanceList 

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

InstanceList contains a list of Instance.

func (*InstanceList) DeepCopy 

func (in *InstanceList) DeepCopy() *InstanceList

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

func (*InstanceList) DeepCopyInto 

func (in *InstanceList) DeepCopyInto(out *InstanceList)

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

func (*InstanceList) DeepCopyObject 

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

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

type InstanceSpec 

type InstanceSpec struct {
	// OperatorVersion specifies a reference to a specific Operator object.
	OperatorVersion corev1.ObjectReference `json:"operatorVersion,omitempty"`

	Parameters map[string]string `json:"parameters,omitempty"`
}

InstanceSpec defines the desired state of Instance.

func (*InstanceSpec) DeepCopy 

func (in *InstanceSpec) DeepCopy() *InstanceSpec

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

func (*InstanceSpec) DeepCopyInto 

func (in *InstanceSpec) DeepCopyInto(out *InstanceSpec)

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

type InstanceStatus 

type InstanceStatus struct {
	// slice would be enough here but we cannot use slice because order of sequence in yaml is considered significant while here it's not
	PlanStatus       map[string]PlanStatus `json:"planStatus,omitempty"`
	AggregatedStatus AggregatedStatus      `json:"aggregatedStatus,omitempty"`
}

InstanceStatus defines the observed state of Instance

func (*InstanceStatus) DeepCopy 

func (in *InstanceStatus) DeepCopy() *InstanceStatus

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

func (*InstanceStatus) DeepCopyInto 

func (in *InstanceStatus) DeepCopyInto(out *InstanceStatus)

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

type Maintainer added in v0.2.0 

type Maintainer struct {
	// Name is a user name or organization name.
	Name string `json:"name,omitempty"`

	// Email is an optional email address to contact the named maintainer.
	Email string `json:"email,omitempty"`
}

Maintainer describes an Operator maintainer.

func (*Maintainer) DeepCopy added in v0.7.0 

func (in *Maintainer) DeepCopy() *Maintainer

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

func (*Maintainer) DeepCopyInto added in v0.7.0 

func (in *Maintainer) DeepCopyInto(out *Maintainer)

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

type ObjectReference added in v0.4.0 

type ObjectReference struct {
	corev1.ObjectReference `json:",inline"`
	// Labels to match on.
	Labels map[string]string
}

ObjectReference is a Kubernetes object reference with added labels to allow referencing objects by label.

func (*ObjectReference) DeepCopy added in v0.4.0 

func (in *ObjectReference) DeepCopy() *ObjectReference

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

func (*ObjectReference) DeepCopyInto added in v0.4.0 

func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

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

type Operator added in v0.3.0 

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

	Spec   OperatorSpec   `json:"spec,omitempty"`
	Status OperatorStatus `json:"status,omitempty"`
}

Operator is the Schema for the operator API +k8s:openapi-gen=true

func (*Operator) DeepCopy added in v0.3.0 

func (in *Operator) DeepCopy() *Operator

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

func (*Operator) DeepCopyInto added in v0.3.0 

func (in *Operator) DeepCopyInto(out *Operator)

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

func (*Operator) DeepCopyObject added in v0.3.0 

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

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

type OperatorDependency added in v0.3.0 

type OperatorDependency struct {
	// Name specifies the name of the dependency. Referenced via defaults.config.
	ReferenceName string `json:"referenceName"`
	corev1.ObjectReference

	// Version captures the requirements for what versions of the above object
	// are allowed.
	//
	// Example: ^3.1.4
	Version string `json:"version"`
}

OperatorDependency references a defined operator.

func (*OperatorDependency) DeepCopy added in v0.3.0 

func (in *OperatorDependency) DeepCopy() *OperatorDependency

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

func (*OperatorDependency) DeepCopyInto added in v0.3.0 

func (in *OperatorDependency) DeepCopyInto(out *OperatorDependency)

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

type OperatorList added in v0.3.0 

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

OperatorList contains a list of Operator

func (*OperatorList) DeepCopy added in v0.3.0 

func (in *OperatorList) DeepCopy() *OperatorList

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

func (*OperatorList) DeepCopyInto added in v0.3.0 

func (in *OperatorList) DeepCopyInto(out *OperatorList)

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

func (*OperatorList) DeepCopyObject added in v0.3.0 

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

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

type OperatorSpec added in v0.3.0 

type OperatorSpec struct {
	Description       string        `json:"description,omitempty"`
	KudoVersion       string        `json:"kudoVersion,omitempty"`
	KubernetesVersion string        `json:"kubernetesVersion,omitempty"`
	Maintainers       []*Maintainer `json:"maintainers,omitempty"`
	URL               string        `json:"url,omitempty"`
}

OperatorSpec defines the desired state of Operator

func (*OperatorSpec) DeepCopy added in v0.3.0 

func (in *OperatorSpec) DeepCopy() *OperatorSpec

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

func (*OperatorSpec) DeepCopyInto added in v0.3.0 

func (in *OperatorSpec) DeepCopyInto(out *OperatorSpec)

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

type OperatorStatus added in v0.3.0 

type OperatorStatus struct {
}

OperatorStatus defines the observed state of Operator

func (*OperatorStatus) DeepCopy added in v0.3.0 

func (in *OperatorStatus) DeepCopy() *OperatorStatus

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

func (*OperatorStatus) DeepCopyInto added in v0.3.0 

func (in *OperatorStatus) DeepCopyInto(out *OperatorStatus)

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

type OperatorVersion added in v0.3.0 

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

	Spec   OperatorVersionSpec   `json:"spec,omitempty"`
	Status OperatorVersionStatus `json:"status,omitempty"`
}

OperatorVersion is the Schema for the operatorversions API. +k8s:openapi-gen=true

func (*OperatorVersion) DeepCopy added in v0.3.0 

func (in *OperatorVersion) DeepCopy() *OperatorVersion

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

func (*OperatorVersion) DeepCopyInto added in v0.3.0 

func (in *OperatorVersion) DeepCopyInto(out *OperatorVersion)

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

func (*OperatorVersion) DeepCopyObject added in v0.3.0 

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

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

type OperatorVersionList added in v0.3.0 

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

OperatorVersionList contains a list of OperatorVersion.

func (*OperatorVersionList) DeepCopy added in v0.3.0 

func (in *OperatorVersionList) DeepCopy() *OperatorVersionList

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

func (*OperatorVersionList) DeepCopyInto added in v0.3.0 

func (in *OperatorVersionList) DeepCopyInto(out *OperatorVersionList)

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

func (*OperatorVersionList) DeepCopyObject added in v0.3.0 

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

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

type OperatorVersionSpec added in v0.3.0 

type OperatorVersionSpec struct {
	// +optional
	Operator corev1.ObjectReference `json:"operator,omitempty"`
	Version  string                 `json:"version,omitempty"`

	// Yaml captures a templated yaml list of elements that define the application operator instance.
	Templates map[string]string `json:"templates,omitempty"`
	Tasks     []Task            `json:"tasks,omitempty"`

	Parameters []Parameter `json:"parameters,omitempty"`

	// Plans maps a plan name to a plan.
	Plans map[string]Plan `json:"plans,omitempty"`

	// ConnectionString defines a templated string that can be used to connect to an instance of the Operator.
	// +optional
	ConnectionString string `json:"connectionString,omitempty"`

	// Dependencies a list of all dependencies of the operator.
	Dependencies []OperatorDependency `json:"dependencies,omitempty"`

	// UpgradableFrom lists all OperatorVersions that can upgrade to this OperatorVersion.
	UpgradableFrom []OperatorVersion `json:"upgradableFrom,omitempty"`
}

OperatorVersionSpec defines the desired state of OperatorVersion.

func (*OperatorVersionSpec) DeepCopy added in v0.3.0 

func (in *OperatorVersionSpec) DeepCopy() *OperatorVersionSpec

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

func (*OperatorVersionSpec) DeepCopyInto added in v0.3.0 

func (in *OperatorVersionSpec) DeepCopyInto(out *OperatorVersionSpec)

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

type OperatorVersionStatus added in v0.3.0 

type OperatorVersionStatus struct {
}

OperatorVersionStatus defines the observed state of OperatorVersion.

func (*OperatorVersionStatus) DeepCopy added in v0.3.0 

func (in *OperatorVersionStatus) DeepCopy() *OperatorVersionStatus

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

func (*OperatorVersionStatus) DeepCopyInto added in v0.3.0 

func (in *OperatorVersionStatus) DeepCopyInto(out *OperatorVersionStatus)

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

type Ordering 

type Ordering string

Ordering specifies how the subitems in this plan/phase should be rolled out. 

const (
	// Serial specifies that the plans or objects should be created in order. The first should be healthy before
	// continuing on.
	Serial Ordering = "serial"

	// Parallel specifies that the plan or objects in the phase can all be launched at the same time.
	Parallel Ordering = "parallel"
)

type Parameter 

type Parameter struct {
	// DisplayName can be used by UI's.
	DisplayName string `json:"displayName,omitempty"`

	// Name is the string that should be used in the templated file for example,
	// if `name: COUNT` then using the variable in a spec like:
	//
	// spec:
	//   replicas:  {{COUNT}}
	Name string `json:"name,omitempty"`

	// Description captures a longer description of how the parameter will be used.
	Description string `json:"description,omitempty"`

	// Required specifies if the parameter is required to be provided by all instances, or whether a default can suffice.
	Required bool `json:"required,omitempty"`

	// Default is a default value if no parameter is provided by the instance.
	Default *string `json:"default,omitempty"`

	// Trigger identifies the plan that gets executed when this parameter changes in the Instance object.
	// Default is `update` if a plan with that name exists, otherwise it's `deploy`
	Trigger string `json:"trigger,omitempty"`
}

Parameter captures the variability of an OperatorVersion being instantiated in an instance.

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 Phase 

type Phase struct {
	Name     string   `json:"name" validate:"required"`     // makes field mandatory and checks if set and non empty
	Strategy Ordering `json:"strategy" validate:"required"` // makes field mandatory and checks if set and non empty

	// Steps maps a step name to a list of templated Kubernetes objects stored as a string.
	Steps []Step `json:"steps" validate:"required,gt=0,dive"` // makes field mandatory and checks if its gt 0
}

Phase specifies a list of steps that contain Kubernetes objects.

func (*Phase) DeepCopy 

func (in *Phase) DeepCopy() *Phase

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

func (*Phase) DeepCopyInto 

func (in *Phase) DeepCopyInto(out *Phase)

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

type PhaseStatus 

type PhaseStatus struct {
	Name   string          `json:"name,omitempty"`
	Status ExecutionStatus `json:"status,omitempty"`
	Steps  []StepStatus    `json:"steps,omitempty"`
}

PhaseStatus is representing status of a phase

func (*PhaseStatus) DeepCopy 

func (in *PhaseStatus) DeepCopy() *PhaseStatus

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

func (*PhaseStatus) DeepCopyInto 

func (in *PhaseStatus) DeepCopyInto(out *PhaseStatus)

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

type Plan 

type Plan struct {
	Strategy Ordering `json:"strategy" validate:"required"` // makes field mandatory and checks if set and non empty
	// Phases maps a phase name to a Phase object.
	Phases []Phase `json:"phases" validate:"required,gt=0,dive"` // makes field mandatory and checks if its gt 0
}

Plan specifies a series of Phases that need to be completed.

func (*Plan) DeepCopy 

func (in *Plan) DeepCopy() *Plan

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

func (*Plan) DeepCopyInto 

func (in *Plan) DeepCopyInto(out *Plan)

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

type PlanStatus added in v0.7.0 

type PlanStatus struct {
	Name            string          `json:"name,omitempty"`
	Status          ExecutionStatus `json:"status,omitempty"`
	LastFinishedRun metav1.Time     `json:"lastFinishedRun,omitempty"`
	Phases          []PhaseStatus   `json:"phases,omitempty"`
}

PlanStatus is representing status of a plan

These are valid states and transitions 

+----------------+
| Never executed |
+-------+--------+
        |
        v

+-------------+ +-------+--------+ | Error |<------>| Pending | +------+------+ +-------+--------+ 

^                       |
|                       v
|               +-------+--------+
+-------------->|  In progress   |
|               +-------+--------+
|                       |
v                       v

+------+------+ +-------+--------+ | Fatal error | | Complete | +-------------+ +----------------+

func (*PlanStatus) DeepCopy added in v0.7.0 

func (in *PlanStatus) DeepCopy() *PlanStatus

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

func (*PlanStatus) DeepCopyInto added in v0.7.0 

func (in *PlanStatus) DeepCopyInto(out *PlanStatus)

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

type ResourceTaskSpec 

type ResourceTaskSpec struct {
	Resources []string `json:"resources"`
}

ResourceTaskSpec is referencing a list of resources

func (*ResourceTaskSpec) DeepCopy 

func (in *ResourceTaskSpec) DeepCopy() *ResourceTaskSpec

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

func (*ResourceTaskSpec) DeepCopyInto 

func (in *ResourceTaskSpec) DeepCopyInto(out *ResourceTaskSpec)

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

type Step 

type Step struct {
	Name   string   `json:"name" validate:"required"`            // makes field mandatory and checks if set and non empty
	Tasks  []string `json:"tasks" validate:"required,gt=0,dive"` // makes field mandatory and checks if non empty
	Delete bool     `json:"delete,omitempty"`                    // no checks needed

	// Objects will be serialized for each instance as the params and defaults are provided.
	Objects []runtime.Object `json:"-"` // no checks needed
}

Step defines a specific set of operations that occur.

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 StepStatus 

type StepStatus struct {
	Name   string          `json:"name,omitempty"`
	Status ExecutionStatus `json:"status,omitempty"`
}

StepStatus is representing status of a step

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 Task 

type Task struct {
	Name string   `json:"name" validate:"required"`
	Kind string   `json:"kind" validate:"required"`
	Spec TaskSpec `json:"spec" validate:"required"`
}

Task is a global, polymorphic implementation of all publicly available tasks

func (*Task) DeepCopy 

func (in *Task) DeepCopy() *Task

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

func (*Task) DeepCopyInto 

func (in *Task) DeepCopyInto(out *Task)

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

type TaskSpec 

type TaskSpec struct {
	ResourceTaskSpec
	DummyTaskSpec
}

TaskSpec embeds all possible task specs. This allows us to avoid writing custom un/marshallers that would only parse certain fields depending on the task Kind. The downside of this approach is, that embedded types can not have fields with the same json names as it would become ambiguous for the default parser. We might revisit this approach in the future should this become an issue.

func (*TaskSpec) DeepCopy 

func (in *TaskSpec) DeepCopy() *TaskSpec

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

func (*TaskSpec) DeepCopyInto 

func (in *TaskSpec) DeepCopyInto(out *TaskSpec)

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

type TestAssert added in v0.3.0 

type TestAssert struct {
	// The type meta object, should always be a GVK of kudo.dev/v1alpha1/TestAssert.
	metav1.TypeMeta `json:",inline"`
	// Override the default timeout of 30 seconds (in seconds).
	Timeout int `json:"timeout"`
}

TestAssert represents the settings needed to verify the result of a test step.

func (*TestAssert) DeepCopy added in v0.3.0 

func (in *TestAssert) DeepCopy() *TestAssert

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

func (*TestAssert) DeepCopyInto added in v0.3.0 

func (in *TestAssert) DeepCopyInto(out *TestAssert)

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

func (*TestAssert) DeepCopyObject added in v0.3.0 

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

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

type TestStep added in v0.3.0 

type TestStep struct {
	// The type meta object, should always be a GVK of kudo.dev/v1alpha1/TestStep.
	metav1.TypeMeta `json:",inline"`
	// Override the default metadata. Set labels or override the test step name.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Index int `json:"index,omitempty"`
	// Objects to delete at the beginning of the test step.
	Delete []ObjectReference `json:"delete,omitempty"`

	// Indicates that this is a unit test - safe to run without a real Kubernetes cluster.
	UnitTest bool `json:"unitTest"`

	// Kubectl commands to run at the start of the test
	Kubectl []string `json:"kubectl"`

	// Commands to run prior at the beginning of the test step.
	Commands []Command `json:"commands"`
}

TestStep settings to apply to a test step.

func (*TestStep) DeepCopy added in v0.3.0 

func (in *TestStep) DeepCopy() *TestStep

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

func (*TestStep) DeepCopyInto added in v0.3.0 

func (in *TestStep) DeepCopyInto(out *TestStep)

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

func (*TestStep) DeepCopyObject added in v0.3.0 

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

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

type TestSuite added in v0.3.0 

type TestSuite struct {
	// The type meta object, should always be a GVK of kudo.dev/v1alpha1/TestSuite.
	metav1.TypeMeta `json:",inline"`
	// Set labels or the test suite name.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Path to CRDs to install before running tests.
	CRDDir string `json:"crdDir"`
	// Paths to directories containing manifests to install before running tests.
	ManifestDirs []string `json:"manifestDirs"`
	// Directories containing test cases to run.
	TestDirs []string `json:"testDirs"`
	// Whether or not to start a local etcd and kubernetes API server for the tests.
	StartControlPlane bool `json:"startControlPlane"`
	// Whether or not to start a local kind cluster for the tests.
	StartKIND bool `json:"startKIND"`
	// Path to the KIND configuration file to use.
	KINDConfig string `json:"kindConfig"`
	// KIND context to use.
	KINDContext string `json:"kindContext"`
	// If set, each node defined in the kind configuration will have a docker named volume mounted into it to persist
	// pulled container images across test runs.
	KINDNodeCache bool `json:"kindNodeCache"`
	// Whether or not to start the KUDO controller for the tests.
	StartKUDO bool `json:"startKUDO"`
	// If set, do not delete the resources after running the tests (implies SkipClusterDelete).
	SkipDelete bool `json:"skipDelete"`
	// If set, do not delete the mocked control plane or kind cluster.
	SkipClusterDelete bool `json:"skipClusterDelete"`
	// Override the default timeout of 30 seconds (in seconds).
	Timeout int `json:"timeout"`
	// The maximum number of tests to run at once (default: 8).
	Parallel int `json:"parallel"`
	// The directory to output artifacts to (current working directory if not specified).
	ArtifactsDir string `json:"artifactsDir"`
	// Kubectl commands to run before running any tests.
	Kubectl []string `json:"kubectl"`
	// Commands to run prior to running the tests.
	Commands []Command `json:"commands"`
}

TestSuite configures which tests should be loaded.

func (*TestSuite) DeepCopy added in v0.3.0 

func (in *TestSuite) DeepCopy() *TestSuite

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

func (*TestSuite) DeepCopyInto added in v0.3.0 

func (in *TestSuite) DeepCopyInto(out *TestSuite)

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

func (*TestSuite) DeepCopyObject added in v0.3.0 

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

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

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.