cmd

Documentation

Index

• Constants
• Variables
• func NewProcessExecer(localEnv *localexec.Env) *processExecer
• type Cmd
• type CmdList
• type CmdSpec
• type CmdStateRunning
• type CmdStateTerminated
• type CmdStateWaiting
• type CmdStatus
• type Controller
  • func NewController(ctx context.Context, execer Execer, proberManager ProberManager, ...) *Controller
  • func (r *Controller) CreateBuilder(mgr ctrl.Manager) (*builder.Builder, error)
  • func (c *Controller) ForceRun(ctx context.Context, cmd *v1alpha1.Cmd) (*v1alpha1.CmdStatus, error)
  • func (c *Controller) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (c *Controller) TearDown(ctx context.Context)
• type Execer
  • func ProvideExecer(localEnv *localexec.Env) Execer
• type FakeExecer
  • func NewFakeExecer() *FakeExecer
  • func (fe *FakeExecer) RequireNoKnownProcess(t *testing.T, cmd string)
  • func (e *FakeExecer) Start(ctx context.Context, cmd model.Cmd, w io.Writer) chan statusAndMetadata
• type FakeProberManager
  • func NewFakeProberManager() *FakeProberManager
  • func (m *FakeProberManager) Exec(name string, args ...string) prober.ProberFunc
  • func (m *FakeProberManager) HTTPGet(u *url.URL, headers http.Header) prober.ProberFunc
  • func (m *FakeProberManager) ProbeCount() int
  • func (m *FakeProberManager) TCPSocket(host string, port int) prober.ProberFunc
• type FileWatch
• type FileWatchSpec
• type ObjectMeta
• type ProberManager
  • func ProvideProberManager() ProberManager
• type RestartOnSpec
• type StartOnSpec
• type UIButton
• type UIButtonSpec

Constants

const (
	Unknown status = iota
	Running status = iota
	Done    status = iota
	Error   status = iota
)

Variables

var DefaultGracePeriod = 30 * time.Second

var ErrUnsupportedProbeType = errors.New("unsupported probe type")

var WireSet = wire.NewSet(
	ProvideExecer,
	ProvideProberManager,
	NewController,
)

Functions

func NewProcessExecer

func NewProcessExecer(localEnv *localexec.Env) *processExecer

Types

type Cmd

type Cmd = v1alpha1.Cmd

type CmdList

type CmdList = v1alpha1.CmdList

type CmdSpec

type CmdSpec = v1alpha1.CmdSpec

type CmdStateRunning

type CmdStateRunning = v1alpha1.CmdStateRunning

type CmdStateTerminated

type CmdStateTerminated = v1alpha1.CmdStateTerminated

type CmdStateWaiting

type CmdStateWaiting = v1alpha1.CmdStateWaiting

type CmdStatus

type CmdStatus = v1alpha1.CmdStatus

type Controller

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

A controller that reads CmdSpec and writes CmdStatus

func NewController

func NewController(ctx context.Context, execer Execer, proberManager ProberManager, client ctrlclient.Client, st store.RStore, clock clockwork.Clock, scheme *runtime.Scheme) *Controller

func (*Controller) CreateBuilder

func (r *Controller) CreateBuilder(mgr ctrl.Manager) (*builder.Builder, error)

func (*Controller) ForceRun

func (c *Controller) ForceRun(ctx context.Context, cmd *v1alpha1.Cmd) (*v1alpha1.CmdStatus, error)

Forces the command to run now.

This is a hack to get local_resource commands into the API server, even though the API server doesn't have a notion of resource deps yet.

Blocks until the command is finished, then returns its status.

func (*Controller) Reconcile

func (c *Controller) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (*Controller) TearDown

func (c *Controller) TearDown(ctx context.Context)

type Execer

type Execer interface {
	// Returns a channel to pull status updates from. After the process exists
	// (and transmits its final status), the channel is closed.
	Start(ctx context.Context, cmd model.Cmd, w io.Writer) chan statusAndMetadata
}

func ProvideExecer

func ProvideExecer(localEnv *localexec.Env) Execer

type FakeExecer

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

func NewFakeExecer

func NewFakeExecer() *FakeExecer

func (*FakeExecer) RequireNoKnownProcess

func (fe *FakeExecer) RequireNoKnownProcess(t *testing.T, cmd string)

func (*FakeExecer) Start

func (e *FakeExecer) Start(ctx context.Context, cmd model.Cmd, w io.Writer) chan statusAndMetadata

type FakeProberManager

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

func NewFakeProberManager

func NewFakeProberManager() *FakeProberManager

func (*FakeProberManager) Exec

func (m *FakeProberManager) Exec(name string, args ...string) prober.ProberFunc

func (*FakeProberManager) HTTPGet

func (m *FakeProberManager) HTTPGet(u *url.URL, headers http.Header) prober.ProberFunc

func (*FakeProberManager) ProbeCount

func (m *FakeProberManager) ProbeCount() int

func (*FakeProberManager) TCPSocket

func (m *FakeProberManager) TCPSocket(host string, port int) prober.ProberFunc

type FileWatch

type FileWatch = v1alpha1.FileWatch

type FileWatchSpec

type FileWatchSpec = v1alpha1.FileWatchSpec

type ObjectMeta

type ObjectMeta = metav1.ObjectMeta

type ProberManager

type ProberManager interface {
	HTTPGet(u *url.URL, headers http.Header) prober.ProberFunc
	TCPSocket(host string, port int) prober.ProberFunc
	Exec(name string, args ...string) prober.ProberFunc
}

func ProvideProberManager

func ProvideProberManager() ProberManager

type RestartOnSpec

type RestartOnSpec = v1alpha1.RestartOnSpec

type StartOnSpec

type StartOnSpec = v1alpha1.StartOnSpec

type UIButton

type UIButton = v1alpha1.UIButton

type UIButtonSpec

type UIButtonSpec = v1alpha1.UIButtonSpec