bootstrap

Documentation

Index

• func Clear[T any](ctx *Context, k InfoKey[T])
• func Configure(opts ...Option)
• func Get[T any](ctx *Context, k InfoKey[T]) (T, bool)
• func RunPlan(ctx context.Context, plan *Plan) error
• func Save[T any](ctx *Context, k InfoKey[T], v T)
• func Set[T any](ctx *Context, k InfoKey[T], v T)
• func SetNeedsReboot(ctx *Context)
• func SimPlan(ctx context.Context, plan *Plan) error
• func WithDefaultStepFactory(name string, f func() *Step)
• type Context
  • func NewContext(ctx context.Context) *Context
• type InfoKey
  • func NewKey[T any](name string) InfoKey[T]
• type Option
  • func WithAlternatePlanCmd(name string, pf func() *Plan, customize func(*cobra.Command)) Option
  • func WithChildCmdBuilders(fns ...func() *cobra.Command) Option
  • func WithChildCmds(cmds ...*cobra.Command) Option
  • func WithSteps(steps ...*Step) Option
• type Plan
  • func NewDerivedPlan(exceptions ...string) *Plan
  • func NewPlan() *Plan
  • func (p *Plan) AddDefaultSteps()
  • func (p *Plan) AddSteps(steps ...*Step)
  • func (p *Plan) Ready() bool
  • func (p *Plan) Run(ctx context.Context) error
  • func (p *Plan) Sim(ctx context.Context) error
• type Step
  • func NewStep(name string, run func(*Context) error, opts ...StepOpt) *Step
  • func (s *Step) With(opts ...StepOpt) *Step
• type StepOpt
  • func AfterSteps(names ...string) StepOpt
  • func BeforeSteps(names ...string) StepOpt
  • func SimFunc(f func(*Context) error) StepOpt

Functions

func Clear

func Clear[T any](ctx *Context, k InfoKey[T])

func Configure

func Configure(opts ...Option)

func Get

func Get[T any](ctx *Context, k InfoKey[T]) (T, bool)

func RunPlan

func RunPlan(ctx context.Context, plan *Plan) error

func Save

func Save[T any](ctx *Context, k InfoKey[T], v T)

func Set

func Set[T any](ctx *Context, k InfoKey[T], v T)

func SetNeedsReboot

func SetNeedsReboot(ctx *Context)

func SimPlan

func SimPlan(ctx context.Context, plan *Plan) error

func WithDefaultStepFactory

func WithDefaultStepFactory(name string, f func() *Step)

WithDefaultStepFactory registers a function that will be called to create a default step with the given name. This is used to register steps that are referenced in existing step dependencies but not already added to the plan.

These steps essentially will be run if and only if some other step depends on them.

Normally this should only be used by bootstrap internals.

Types

type Context

type Context = internal.Context

func NewContext

func NewContext(ctx context.Context) *Context

type InfoKey

type InfoKey[T any] = internal.InfoKey[T]

func NewKey

func NewKey[T any](name string) InfoKey[T]

type Option

type Option func(*config)

func WithAlternatePlanCmd

func WithAlternatePlanCmd(
	name string,
	pf func() *Plan,
	customize func(*cobra.Command),
) Option

WithAlternatePlanCmd registers a command that will run an alternate bootstrap plan from the given factory function.

The customize parameter is optional, if given it will be called and can customize the command to e.g. override the short help or add long help or other settings.

func WithChildCmdBuilders

func WithChildCmdBuilders(fns ...func() *cobra.Command) Option

func WithChildCmds

func WithChildCmds(cmds ...*cobra.Command) Option

func WithSteps

func WithSteps(steps ...*Step) Option

type Plan

type Plan struct {
	// contains filtered or unexported fields
}

func NewDerivedPlan

func NewDerivedPlan(exceptions ...string) *Plan

NewDerivedPlan creates a new plan that is derived from the main plan, i.e. it has all of the steps copied to it, and you can then add more custom steps to it.

You can pass exceptions, steps you want to exclude from the copy, if you want to create a plan that has most but not all of the normal steps. It is up to you to ensure this doesn't create a plan with missing dependencies that can't be run.

Excluding a step that has a default factory may simply cause it to be re-added if other steps depend on it.

func NewPlan

func NewPlan() *Plan

func (*Plan) AddDefaultSteps

func (p *Plan) AddDefaultSteps()

Add any of the known "Default" steps that are referenced in existing step dependencies but not already added to the plan.

func (*Plan) AddSteps

func (p *Plan) AddSteps(steps ...*Step)

func (*Plan) Ready

func (p *Plan) Ready() bool

Ready tries to resolve all dependencies between plan steps to form a well-ordered plan. It returns whether this was successful.

You will usually want to call *Plan.AddDefaultSteps before this, or alternately do so if this fails before trying again.

func (*Plan) Run

func (p *Plan) Run(ctx context.Context) error

func (*Plan) Sim

func (p *Plan) Sim(ctx context.Context) error

type Step

type Step struct {
	// contains filtered or unexported fields
}

func NewStep

func NewStep(
	name string,
	run func(*Context) error,
	opts ...StepOpt,
) *Step

NewStep creates a new bootstrap step with the given name and run function.

Dependencies, simulation (dry-run) mode special case, and other options can be set via the additional option arguments.

func (*Step) With

func (s *Step) With(opts ...StepOpt) *Step

type StepOpt

type StepOpt func(*Step)

func AfterSteps

func AfterSteps(names ...string) StepOpt

AfterSteps adds normal dependencies to the step

func BeforeSteps

func BeforeSteps(names ...string) StepOpt

BeforeSteps adds reverse dependencies to the step

func SimFunc

func SimFunc(f func(*Context) error) StepOpt

SimFunc sets the simulation function that will be run instead of just printing the step name in [Sim] (dry run) invocations.