admin

Documentation

Index

• type LogStreamer
• type NewLogStreamerFunc
• type NewRemoterFunc
• type NewStatuserFunc
• type Provider
• type Providers
  • func (s Providers) FindFactory(curModule types.Module) *Provider
  • func (s Providers) FindLogStreamer(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (LogStreamer, error)
  • func (s Providers) FindRemoter(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (Remoter, error)
  • func (s Providers) FindStatuser(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (Statuser, error)
• type RemoteOptions
• type Remoter
• type StatusDetailReport
• type StatusDetailReports
• type StatusRecord
• type StatusRecords
• type StatusReport
• type Statuser

Types

type LogStreamer

type LogStreamer interface {
	Stream(ctx context.Context, options config.LogStreamOptions) error
}

type NewLogStreamerFunc

type NewLogStreamerFunc func(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (LogStreamer, error)

type NewRemoterFunc

type NewRemoterFunc func(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (Remoter, error)

type NewStatuserFunc

type NewStatuserFunc func(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (Statuser, error)

type Provider

type Provider struct {
	NewStatuser    NewStatuserFunc
	NewRemoter     NewRemoterFunc
	NewLogStreamer NewLogStreamerFunc
}

type Providers

type Providers map[types.ModuleContractName]Provider

func (Providers) FindFactory

func (s Providers) FindFactory(curModule types.Module) *Provider

func (Providers) FindLogStreamer

func (s Providers) FindLogStreamer(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (LogStreamer, error)

func (Providers) FindRemoter

func (s Providers) FindRemoter(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (Remoter, error)

func (Providers) FindStatuser

func (s Providers) FindStatuser(osWriters logging.OsWriters, nsConfig api.Config, appDetails app.Details) (Statuser, error)

type RemoteOptions

type RemoteOptions struct {
	// Task refers to the ECS task id for remote access if using ECS
	Task string
	// Pod refers to the k8s pod for remote access if using k8s
	Pod string
	// Container represents the specific container name for remote access in the k8s pod or ecs task
	Container    string
	PortForwards []config.PortForward
}

type Remoter

type Remoter interface {
	// Exec allows a user to execute a command (usually tunneling) into a running service
	// This only makes sense for container-based providers
	Exec(ctx context.Context, options RemoteOptions, cmd []string) error

	// Ssh allows a user to SSH into a running service
	Ssh(ctx context.Context, options RemoteOptions) error
}

type StatusDetailReport

type StatusDetailReport struct {
	Name    string
	Records StatusRecords
}

type StatusDetailReports

type StatusDetailReports []StatusDetailReport

type StatusRecord

type StatusRecord struct {
	Fields []string
	Data   map[string]interface{}
}

type StatusRecords

type StatusRecords []StatusRecord

type StatusReport

type StatusReport struct {
	Fields []string
	Data   map[string]interface{}
}

type Statuser

type Statuser interface {
	// Status returns a high-level status report on the specified app env
	Status(ctx context.Context) (StatusReport, error)

	// StatusDetail returns a detailed status report on the specified app env
	StatusDetail(ctx context.Context) (StatusDetailReports, error)
}