Documentation ¶
Index ¶
Constants ¶
const ( ApplyTaskKind = "Apply" DeleteTaskKind = "Delete" DummyTaskKind = "Dummy" PipeTaskKind = "Pipe" ToggleTaskKind = "Toggle" KudoOperatorTaskKind = "KudoOperator" )
Available tasks kinds
const (
PipePodAnnotation = "kudo.dev/pipepod"
)
Variables ¶
This section is empty.
Functions ¶
func PipeArtifactName ¶ added in v0.9.0
PipeArtifactName returns a deterministic name for pipe artifact (ConfigMap, Secret)
func PipePodName ¶ added in v0.9.0
PipePodName returns a deterministic name for a pipe pod
Types ¶
type ApplyTask ¶
ApplyTask will apply a set of given resources to the cluster. See Run method for more details.
type Context ¶
type Context struct { Client client.Client Discovery discovery.CachedDiscoveryInterface Config *rest.Config Scheme *runtime.Scheme Enhancer renderer.Enhancer Meta renderer.Metadata Templates map[string]string // Raw templates Parameters map[string]interface{} // Instance and OperatorVersion parameters merged Pipes map[string]string // Pipe artifacts }
Context is a engine.task execution context containing k8s client, templates parameters etc.
type DeleteTask ¶
DeleteTask will delete a set of given resources from the cluster. See Run method for more details.
type KudoOperatorTask ¶ added in v0.14.0
type KudoOperatorTask struct { Name string OperatorName string InstanceName string AppVersion string OperatorVersion string ParameterFile string }
KudoOperatorTask installs an instance of a KUDO operator in a cluster
type PipeFile ¶ added in v0.9.0
type PipeFile struct { File string EnvFile string Kind PipeFileKind Key string }
type PipeFileKind ¶ added in v0.9.0
type PipeFileKind string
const ( // PipeFile will be persisted as a Secret PipeFileKindSecret PipeFileKind = "Secret" // PipeFile will be persisted as a ConfigMap PipeFileKindConfigMap PipeFileKind = "ConfigMap" )
type Tasker ¶
Tasker is an interface that represents any runnable task for an operator. This method is treated as idempotent and will be called multiple times during the life-cycle of the plan execution. Method returns a boolean, signalizing that the task has finished successfully, and an error. An error can wrap the ErrFatalExecution for errors that should not be retried e.g. failed template rendering. This will result in a v1beta1.ExecutionFatalError in the plan execution status. A normal error e.g. failure during accessing the API server will be treated as "transient", meaning plan execution engine can retry it next time. Only a (true, nil) return value will be treated as successful task execution.
type ToggleTask ¶ added in v0.11.0
ToggleTask will apply or delete a set of given resources to the cluster based on value of Parameter. See Run method for more details.