pipeline

Documentation

Index

• Constants
• func GetDefaultDeletionPolicy() synv1alpha1.DeletionPolicy
• type Context
• type Function
• type Object
• type Result
  • func AddTenantLabel(obj Object, data *Context) Result
  • func CheckIfDeleted(obj Object, data *Context) Result
  • func Common(obj Object, data *Context) Result
  • func DeepCopyOriginal(obj Object, data *Context) Result
  • func RunPipeline(obj Object, data *Context, steps []Step) Result
• type Step

Constants

const (
	DeleteProtectionAnnotation = "syn.tools/protected-delete"
)

Functions

func GetDefaultDeletionPolicy

func GetDefaultDeletionPolicy() synv1alpha1.DeletionPolicy

Types

type Context

type Context struct {
	FinalizerName string
	Client        client.Client
	Log           logr.Logger
	Deleted       bool

	Reconciler reconcile.Reconciler
	// contains filtered or unexported fields
}

Context contains additional data about the CRD being processed.

type Function

type Function func(Object, *Context) Result

Function defines the general form of a pipeline function.

type Object

type Object interface {
	GetObjectMeta() metav1.Object
	GetGitTemplate() *synv1alpha1.GitRepoTemplate
	GroupVersionKind() schema.GroupVersionKind
	GetTenantRef() corev1.LocalObjectReference
	GetDeletionPolicy() synv1alpha1.DeletionPolicy
	GetDisplayName() string
	SetGitRepoURLAndHostKeys(URL, hostKeys string)
	GetSpec() interface{}
	GetStatus() interface{}
}

Object defines an interface to extract necessary information from the CRs

type Result

type Result struct {
	Abort   bool
	Err     error
	Requeue bool
}

Result indicates whether the current execution should be aborted and if there was an error.

func AddTenantLabel

func AddTenantLabel(obj Object, data *Context) Result

AddTenantLabel adds the tenant label to an object.

func CheckIfDeleted

func CheckIfDeleted(obj Object, data *Context) Result

func Common

func Common(obj Object, data *Context) Result

func DeepCopyOriginal

func DeepCopyOriginal(obj Object, data *Context) Result

func RunPipeline

func RunPipeline(obj Object, data *Context, steps []Step) Result

type Step

type Step struct {
	Name string
	F    Function
}