rpc

Documentation

Index

• Constants
• type Filter
• type LogEntry
  • func (l *LogEntry) String() string
• type Peer
• type StepState
• type Version
• type Workflow
• type WorkflowState

Constants

const (
	LogEntryStdout int = iota
	LogEntryStderr
	LogEntryExitCode
	LogEntryMetadata
	LogEntryProgress
)

Identifies the type of line in the logs.

Types

type Filter

type Filter struct {
	Labels map[string]string `json:"labels"`
}

Filter defines filters for fetching items from the queue.

type LogEntry

type LogEntry struct {
	StepUUID string `json:"step_uuid,omitempty"`
	Time     int64  `json:"time,omitempty"`
	Type     int    `json:"type,omitempty"`
	Line     int    `json:"line,omitempty"`
	Data     []byte `json:"data,omitempty"`
}

Line is a line of console output.

func (*LogEntry) String

func (l *LogEntry) String() string

type Peer

type Peer interface {
	// Version returns the server- & grpc-version
	Version(c context.Context) (*Version, error)

	// Next returns the next workflow in the queue
	Next(c context.Context, f Filter) (*Workflow, error)

	// Wait blocks until the workflow is complete
	Wait(c context.Context, workflowID string) error

	// Init signals the workflow is initialized
	Init(c context.Context, workflowID string, state WorkflowState) error

	// Done signals the workflow is complete
	Done(c context.Context, workflowID string, state WorkflowState) error

	// Extend extends the workflow deadline
	Extend(c context.Context, workflowID string) error

	// Update updates the step state
	Update(c context.Context, workflowID string, state StepState) error

	// EnqueueLog queues the step log entry for delayed sending
	EnqueueLog(logEntry *LogEntry)

	// RegisterAgent register our agent to the server
	RegisterAgent(ctx context.Context, platform, backend, version string, capacity int) (int64, error)

	// UnregisterAgent unregister our agent from the server
	UnregisterAgent(ctx context.Context) error

	// ReportHealth reports health status of the agent to the server
	ReportHealth(c context.Context) error
}

Peer defines a peer-to-peer connection.

type StepState

type StepState struct {
	StepUUID string `json:"step_uuid"`
	Started  int64  `json:"started"`
	Finished int64  `json:"finished"`
	Exited   bool   `json:"exited"`
	ExitCode int    `json:"exit_code"`
	Error    string `json:"error"`
}

StepState defines the step state.

type Version

type Version struct {
	GrpcVersion   int32  `json:"grpc_version,omitempty"`
	ServerVersion string `json:"server_version,omitempty"`
}

type Workflow

type Workflow struct {
	ID      string          `json:"id"`
	Config  *backend.Config `json:"config"`
	Timeout int64           `json:"timeout"`
}

Workflow defines the workflow execution details.

type WorkflowState

type WorkflowState struct {
	Started  int64  `json:"started"`
	Finished int64  `json:"finished"`
	Error    string `json:"error"`
}

WorkflowState defines the workflow state.