Documentation
¶
Index ¶
- Variables
- func AbortOnError(err error) bool
- func Subst(index Indexable, substitute ...any) error
- type AllowFailure
- type And
- type Bootstraper
- type Concurrent
- type Env
- type Executable
- type GarbageCollector
- type If
- type Indexable
- type Inherit
- type Input
- type Logger
- type Matrix
- type Needs
- type Next
- type OtelMetrics
- type OtelTrace
- type Output
- type OutputCloser
- type OutputFactory
- type OutputParam
- type Pipe
- type Pipeline
- type PipelineBuilder
- type ProcessorBuilder
- func WithAllowFailure() ProcessorBuilder
- func WithAnd() ProcessorBuilder
- func WithConcurrent(pool pond.Pool) ProcessorBuilder
- func WithEnv(osEnv, defaultEnv map[string]string) ProcessorBuilder
- func WithGarbageCollector(noGC bool, driver runtime.Interface, teardown chan Teardown) ProcessorBuilder
- func WithIf(celEnv *cel.Env) ProcessorBuilder
- func WithInherit(builder PipelineBuilder, store storage.Interface) ProcessorBuilder
- func WithInput(celEnv *cel.Env) ProcessorBuilder
- func WithLogger(logger logr.Logger, zapConfig *zap.Config) ProcessorBuilder
- func WithMatrix(pool pond.Pool) ProcessorBuilder
- func WithNeeds() ProcessorBuilder
- func WithOtelMetrics(meter metric.Meter) ProcessorBuilder
- func WithOtelTrace(logger logr.Logger, tracer trace.Tracer) ProcessorBuilder
- func WithOutput() ProcessorBuilder
- func WithPipe(tee bool) ProcessorBuilder
- func WithProgress(progress bool) ProcessorBuilder
- func WithRecover() ProcessorBuilder
- func WithReport(store ResultStore) ProcessorBuilder
- func WithResult() ProcessorBuilder
- func WithRetry() ProcessorBuilder
- func WithRun(defaultPullPolicy runtime.PullImagePolicy, driver runtime.Interface, ...) ProcessorBuilder
- func WithSkipBlacklist(blacklist []string) ProcessorBuilder
- func WithSkipDone(skipDone bool) ProcessorBuilder
- func WithStdio(outputFactory OutputFactory, stdin io.Reader, stdout, stderr io.Writer) ProcessorBuilder
- func WithStdioRedirect(tee bool) ProcessorBuilder
- func WithTemplate(template v1beta1.Template) ProcessorBuilder
- func WithTimeout() ProcessorBuilder
- func WithTmpDir() ProcessorBuilder
- type Progress
- type Recover
- type Report
- type Result
- type ResultStore
- type Retry
- type Run
- type SkipBlacklist
- type SkipDone
- type Stdio
- type StdioRedirect
- type Step
- type StepContext
- type StepResult
- type Teardown
- type Template
- type Timeout
- type TmpDir
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrAllowFailure = errors.New("ignore error returned from step")
View Source
var ErrConditionFalse = errors.New("conditional step skipped")
View Source
var ErrEmptyMatrix = errors.New("empty matrix")
View Source
var ErrSkipBlacklist = errors.New("skip blacklisted step")
View Source
var ErrSkipDone = errors.New("skip step marked as successful")
Functions ¶
func AbortOnError ¶
Types ¶
type AllowFailure ¶
type AllowFailure struct {
}
type Bootstraper ¶
func Builder ¶
func Builder(spec *v1beta1.Step, builders ...ProcessorBuilder) []Bootstraper
type Concurrent ¶
type Concurrent struct {
// contains filtered or unexported fields
}
type Executable ¶
type Executable func(ctx context.Context) (StepContext, map[string]v1beta1.ParamValue, error)
type GarbageCollector ¶
type GarbageCollector struct {
// contains filtered or unexported fields
}
type Next ¶
type Next func(ctx context.Context, stepContext StepContext) (StepContext, error)
type OtelMetrics ¶ added in v0.0.7
type OtelMetrics struct {
// contains filtered or unexported fields
}
type OtelTrace ¶ added in v0.0.7
type OtelTrace struct {
// contains filtered or unexported fields
}
type OutputCloser ¶
type OutputFactory ¶
type OutputParam ¶ added in v0.0.19
type PipelineBuilder ¶
type PipelineBuilder interface {
Build(pipeline v1beta1.Pipeline, entrypoint string, inputs map[string]v1beta1.ParamValue, stepCtx StepContext) (Executable, error)
}
type ProcessorBuilder ¶
type ProcessorBuilder func(spec *v1beta1.Step) Bootstraper
func WithAllowFailure ¶
func WithAllowFailure() ProcessorBuilder
func WithAnd ¶
func WithAnd() ProcessorBuilder
func WithConcurrent ¶
func WithConcurrent(pool pond.Pool) ProcessorBuilder
func WithEnv ¶ added in v0.0.7
func WithEnv(osEnv, defaultEnv map[string]string) ProcessorBuilder
func WithGarbageCollector ¶
func WithGarbageCollector(noGC bool, driver runtime.Interface, teardown chan Teardown) ProcessorBuilder
func WithIf ¶
func WithIf(celEnv *cel.Env) ProcessorBuilder
func WithInherit ¶
func WithInherit(builder PipelineBuilder, store storage.Interface) ProcessorBuilder
func WithInput ¶ added in v0.0.19
func WithInput(celEnv *cel.Env) ProcessorBuilder
func WithLogger ¶ added in v0.0.19
func WithLogger(logger logr.Logger, zapConfig *zap.Config) ProcessorBuilder
func WithMatrix ¶
func WithMatrix(pool pond.Pool) ProcessorBuilder
func WithNeeds ¶
func WithNeeds() ProcessorBuilder
func WithOtelMetrics ¶ added in v0.0.7
func WithOtelMetrics(meter metric.Meter) ProcessorBuilder
func WithOtelTrace ¶ added in v0.0.7
func WithOtelTrace(logger logr.Logger, tracer trace.Tracer) ProcessorBuilder
func WithOutput ¶ added in v0.0.19
func WithOutput() ProcessorBuilder
func WithPipe ¶
func WithPipe(tee bool) ProcessorBuilder
func WithProgress ¶ added in v0.0.19
func WithProgress(progress bool) ProcessorBuilder
func WithRecover ¶ added in v0.0.19
func WithRecover() ProcessorBuilder
func WithReport ¶
func WithReport(store ResultStore) ProcessorBuilder
func WithResult ¶ added in v0.0.7
func WithResult() ProcessorBuilder
func WithRetry ¶
func WithRetry() ProcessorBuilder
func WithRun ¶
func WithRun(defaultPullPolicy runtime.PullImagePolicy, driver runtime.Interface, outputFactory OutputFactory, teardown chan Teardown) ProcessorBuilder
func WithSkipBlacklist ¶ added in v0.0.7
func WithSkipBlacklist(blacklist []string) ProcessorBuilder
func WithSkipDone ¶
func WithSkipDone(skipDone bool) ProcessorBuilder
func WithStdio ¶
func WithStdio(outputFactory OutputFactory, stdin io.Reader, stdout, stderr io.Writer) ProcessorBuilder
func WithStdioRedirect ¶ added in v0.0.19
func WithStdioRedirect(tee bool) ProcessorBuilder
func WithTemplate ¶ added in v0.0.19
func WithTemplate(template v1beta1.Template) ProcessorBuilder
func WithTimeout ¶
func WithTimeout() ProcessorBuilder
func WithTmpDir ¶ added in v0.0.9
func WithTmpDir() ProcessorBuilder
type ResultStore ¶
type ResultStore interface {
Add(stepName string, result *StepResult)
}
type SkipBlacklist ¶ added in v0.0.7
type SkipBlacklist struct {
// contains filtered or unexported fields
}
type StdioRedirect ¶ added in v0.0.19
type StdioRedirect struct {
// contains filtered or unexported fields
}
type Step ¶
type Step interface {
Processors() []Bootstraper
Entrypoint() (Next, error)
}
type StepContext ¶
type StepContext struct {
Dir string
DataDir string
Matrix map[string]string
Inputs map[string]v1beta1.ParamValue
Steps map[string]*StepResult
Envs map[string]string
Containers map[string]cruntime.ContainerStatus
Tags map[string]string
NamePrefix string
Env string
Outputs []OutputParam
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
AdditionalStdout []io.Writer
AdditionalStderr []io.Writer
Template *v1beta1.Template
}
func NewContext ¶
func NewContext() StepContext
func (StepContext) DeepCopy ¶
func (c StepContext) DeepCopy() StepContext
func (StepContext) FromV1Beta1 ¶
func (t StepContext) FromV1Beta1(vars *v1beta1.Context)
func (StepContext) Merge ¶
func (t StepContext) Merge(c StepContext) StepContext
func (StepContext) ToV1Beta1 ¶
func (t StepContext) ToV1Beta1() *v1beta1.Context
type StepResult ¶
type StepResult struct {
StartedAt time.Time
EndedAt time.Time
Outputs map[string]v1beta1.ParamValue
Error error
DataDir string
}
func (*StepResult) Duration ¶
func (t *StepResult) Duration() time.Duration
Source Files
¶
- allow_failure.go
- and.go
- builder.go
- concurrent.go
- context.go
- env.go
- errors.go
- garbage_collector.go
- if.go
- inherit.go
- input.go
- logger.go
- matrix.go
- needs.go
- otel_metrics.go
- otel_trace.go
- output.go
- pipe.go
- processor.go
- progress.go
- recover.go
- report.go
- result.go
- retry.go
- run.go
- skip_blacklist.go
- skip_done.go
- sources.go
- stdio.go
- stdio_redirect.go
- substitute.go
- template.go
- timeout.go
- tmpdir.go
- utils.go
Click to show internal directories.
Click to hide internal directories.