agentcli

Documentation

Overview

Package agentcli provides a CDPI agent that is configured using a protobuf-based manifest.

Index

• Variables
• type AgentConf
  • func (ac AgentConf) Run(ctx context.Context, appName string, args []string) (err error)
• type Handles
  • func DefaultHandles() Handles
• type Provider
• type UnsupportedEnactmentBackend
  • func (*UnsupportedEnactmentBackend) EnactmentBackend(_ context.Context, _ Handles, _ string, _ *anypb.Any) (enactment.Backend, error)
• type UnsupportedTelemetryBackend
  • func (*UnsupportedTelemetryBackend) TelemetryBackend(_ context.Context, _ Handles, _ string, _ *anypb.Any) (telemetry.Backend, error)

Variables

var ErrUnknownConfigProto = errors.New("unknown config proto")

ErrUnknownConfigProto is the error a Provider should return if the provided `anypb.Any` is of an unknown type.

Types

type AgentConf

type AgentConf struct {
	AppName   string
	Handles   Handles
	Providers []Provider
}

func (AgentConf) Run

func (ac AgentConf) Run(ctx context.Context, appName string, args []string) (err error)

type Handles

type Handles interface {
	Clock() clockwork.Clock
	Stdout() io.Writer
	Stderr() io.Writer
}

Handles are abstractions over impure, external resources like time and stdio streams.

func DefaultHandles

func DefaultHandles() Handles

DefaultHandles returns a Handles implementation that delegates to the standard implementations for external resources.

type Provider

type Provider interface {
	EnactmentBackend(_ context.Context, _ Handles, nodeID string, conf *anypb.Any) (enactment.Backend, error)
	TelemetryBackend(_ context.Context, _ Handles, nodeID string, conf *anypb.Any) (telemetry.Backend, error)
}

Provider provides a dynamic way of registering enactment or telemetry backend providers. If the provided configuration isn't of the appropriate type, the factory function is expected to return nil, ErrUnknownConfigProto.

type UnsupportedEnactmentBackend

type UnsupportedEnactmentBackend struct{}

func (*UnsupportedEnactmentBackend) EnactmentBackend

func (*UnsupportedEnactmentBackend) EnactmentBackend(_ context.Context, _ Handles, _ string, _ *anypb.Any) (enactment.Backend, error)

type UnsupportedTelemetryBackend

type UnsupportedTelemetryBackend struct{}

func (*UnsupportedTelemetryBackend) TelemetryBackend

func (*UnsupportedTelemetryBackend) TelemetryBackend(_ context.Context, _ Handles, _ string, _ *anypb.Any) (telemetry.Backend, error)