driveropts

Documentation

Index

• type DriverOption
  • func WithBackground(background bool) DriverOption
  • func WithDebug(debug bool) DriverOption
  • func WithExecOptions(eopts ...exec.ExecOption) DriverOption
  • func WithLogger(l log.Logger) DriverOption
  • func WithMachineStore(store *machine.MachineStore) DriverOption
  • func WithRuntimeDir(dir string) DriverOption
• type DriverOptions
  • func NewDriverOptions(opts ...DriverOption) (*DriverOptions, error)

Types

type DriverOption

type DriverOption func(do *DriverOptions) error

func WithBackground

func WithBackground(background bool) DriverOption

WithBackground indicates as to whether the driver should start in the background

func WithDebug

func WithDebug(debug bool) DriverOption

func WithExecOptions

func WithExecOptions(eopts ...exec.ExecOption) DriverOption

WithExecOptions offers configuration options to the underlying process executor

func WithLogger

func WithLogger(l log.Logger) DriverOption

WithLogger provides access to a logger to be used within the package

func WithMachineStore

func WithMachineStore(store *machine.MachineStore) DriverOption

WithMachineStore passes in an already instantiated `machine.MachineStore`

func WithRuntimeDir

func WithRuntimeDir(dir string) DriverOption

WithRuntimeDir sets the location of files associated with the runtime of KraftKit. This typically includes PID files, socket files, key-value databases, log files, etc.

type DriverOptions

type DriverOptions struct {
	Log         log.Logger
	ExecOptions []exec.ExecOption
	Debug       bool
	RuntimeDir  string
	Background  bool
	Store       *machine.MachineStore
}

func NewDriverOptions

func NewDriverOptions(opts ...DriverOption) (*DriverOptions, error)