serve

Documentation

Overview

Package serve provides the `serve` command for the CLI. The command starts the server.

Index

• func Command(builder Builder) *cobra.Command
• type Builder
• type Server
  • func NewServer(cfg *config.Config, s store.Store, tracer tracer.Tracer, logger *zap.Logger, ...) Server

Functions

func Command

func Command(builder Builder) *cobra.Command

Command returns the BindPlane serve cobra command

Types

type Builder

type Builder interface {
	// Build returns a new Server.
	BuildServer(ctx context.Context) (Server, error)
}

Builder is an interface for building a Server.

type Server

type Server interface {
	// Seed will seed the BindPlane server.
	Seed(ctx context.Context) error

	// Serve will run a BindPlane server until an error occurs or the context is canceled.
	Serve(ctx context.Context) error
}

Server is an interface for serving BindPlane.

func NewServer

func NewServer(cfg *config.Config, s store.Store, tracer tracer.Tracer, logger *zap.Logger, routeBuilder exposedserver.RouteBuilder) Server

NewServer returns a new Server.