system

Documentation

Index

• func NewRouter(b Backend, c ClusterBackend, builder *buildkit.Builder, ...) router.Router
• type Backend
• type ClusterBackend
• type DiskUsageOptions
• type StatusProvider

Functions

func NewRouter

func NewRouter(b Backend, c ClusterBackend, builder *buildkit.Builder, features func() map[string]bool) router.Router

NewRouter initializes a new system router

Types

type Backend

type Backend interface {
	SystemInfo(context.Context) (*system.Info, error)
	SystemVersion(context.Context) (types.Version, error)
	SystemDiskUsage(ctx context.Context, opts DiskUsageOptions) (*types.DiskUsage, error)
	SubscribeToEvents(since, until time.Time, ef filters.Args) ([]events.Message, chan interface{})
	UnsubscribeFromEvents(chan interface{})
	AuthenticateToRegistry(ctx context.Context, authConfig *registry.AuthConfig) (string, string, error)
}

Backend is the methods that need to be implemented to provide system specific functionality.

type ClusterBackend

type ClusterBackend interface {
	Info(context.Context) swarm.Info
}

ClusterBackend is all the methods that need to be implemented to provide cluster system specific functionality.

type DiskUsageOptions

type DiskUsageOptions struct {
	// Containers controls whether container disk usage should be computed.
	Containers bool

	// Images controls whether image disk usage should be computed.
	Images bool

	// Volumes controls whether volume disk usage should be computed.
	Volumes bool
}

DiskUsageOptions holds parameters for system disk usage query.

type StatusProvider

type StatusProvider interface {
	Status() string
}

StatusProvider provides methods to get the swarm status of the current node.