engine

Documentation

Index

• type BuildResult
• type HealthCheck
• type LaunchPlan
• type Options
• type Pipeline
  • func (p *Pipeline) Build(ctx context.Context, cfg patch.Config, steps []string) (BuildResult, error)
  • func (p *Pipeline) LaunchPlan(ctx context.Context, cfg patch.Config) (LaunchPlan, error)
  • func (p *Pipeline) MutateConfig(ctx context.Context, cfg patch.Config) (patch.Config, error)
  • func (p *Pipeline) Prepare(ctx context.Context, cfg patch.Config, steps []string) (PrepareResult, error)
  • func (p *Pipeline) Validate(ctx context.Context, cfg patch.Config) (ValidateResult, error)
• type PrepareResult
• type ServiceSpec
• type StepResult
• type ValidateResult

Types

type BuildResult

type BuildResult struct {
	Steps     []StepResult      `json:"steps,omitempty"`
	Artifacts map[string]string `json:"artifacts,omitempty"`
}

type HealthCheck

type HealthCheck struct {
	Type      string `json:"type"` // "tcp"|"http"
	Address   string `json:"address,omitempty"`
	URL       string `json:"url,omitempty"`
	TimeoutMs int64  `json:"timeout_ms,omitempty"`
}

type LaunchPlan

type LaunchPlan struct {
	Services []ServiceSpec `json:"services"`
}

type Options

type Options struct {
	Strict  bool
	DryRun  bool
	Timeout int64 // reserved
}

type Pipeline

type Pipeline struct {
	Clients []runtime.Client
	Opts    Options
}

func (*Pipeline) Build

func (p *Pipeline) Build(ctx context.Context, cfg patch.Config, steps []string) (BuildResult, error)

func (*Pipeline) LaunchPlan

func (p *Pipeline) LaunchPlan(ctx context.Context, cfg patch.Config) (LaunchPlan, error)

func (*Pipeline) MutateConfig

func (p *Pipeline) MutateConfig(ctx context.Context, cfg patch.Config) (patch.Config, error)

func (*Pipeline) Prepare

func (p *Pipeline) Prepare(ctx context.Context, cfg patch.Config, steps []string) (PrepareResult, error)

func (*Pipeline) Validate

func (p *Pipeline) Validate(ctx context.Context, cfg patch.Config) (ValidateResult, error)

type PrepareResult

type PrepareResult struct {
	Steps     []StepResult      `json:"steps,omitempty"`
	Artifacts map[string]string `json:"artifacts,omitempty"`
}

type ServiceSpec

type ServiceSpec struct {
	Name    string            `json:"name"`
	Cwd     string            `json:"cwd,omitempty"`
	Command []string          `json:"command"`
	Env     map[string]string `json:"env,omitempty"`
	Health  *HealthCheck      `json:"health,omitempty"`
}

type StepResult

type StepResult struct {
	Name       string `json:"name"`
	Ok         bool   `json:"ok"`
	DurationMs int64  `json:"duration_ms,omitempty"`
}

type ValidateResult

type ValidateResult struct {
	Valid    bool             `json:"valid"`
	Errors   []protocol.Error `json:"errors,omitempty"`
	Warnings []protocol.Error `json:"warnings,omitempty"`
}