runtime

Documentation

Overview

Package runtime contains runtime implementations that can execute workflow actions. They are responsible for extracting workflow failure reason and messages from the the action file system at the following locations:

/tinkerbell/failure-reason
/tinkerbell/failure-message

Index

• Constants
• type Docker
  • func NewDocker(opts ...DockerOption) (*Docker, error)
  • func (d *Docker) Run(ctx context.Context, a workflow.Action) error
• type DockerOption
  • func WithClient(clnt *client.Client) DockerOption
  • func WithLogger(log logr.Logger) DockerOption
• type Fake
  • func Noop() Fake
  • func (f Fake) Run(_ context.Context, a workflow.Action) error

Constants

const (
	// ReasonMountPath is the path used by Actions to write their failure reasons.
	ReasonMountPath = "/tinkerbell/failure-reason"

	// MessageMountPath is the path used by Actions to write their failure message.
	MessageMountPath = "/tinkerbell/failure-message"
)

Types

type Docker

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

Docker is a docker runtime that satisfies agent.ContainerRuntime.

func NewDocker

func NewDocker(opts ...DockerOption) (*Docker, error)

NewDocker creates a new Docker instance.

func (*Docker) Run

func (d *Docker) Run(ctx context.Context, a workflow.Action) error

Run satisfies agent.ContainerRuntime.

type DockerOption

type DockerOption func(*Docker)

DockerOption defines optional configuration for a Docker instance.

func WithClient

func WithClient(clnt *client.Client) DockerOption

WithClient returns an option to configure a Docker client on a Docker instance.

func WithLogger

func WithLogger(log logr.Logger) DockerOption

WithLogger returns an option to configure the logger on a Docker instance.

type Fake

type Fake struct {
	Log logr.Logger
}

Fake is a runtime that always succeeds. It does not literally execute any actions.

func Noop

func Noop() Fake

func (Fake) Run

func (f Fake) Run(_ context.Context, a workflow.Action) error

Run satisfies agent.ContainerRuntime.