web

Documentation

Index

• type Auth
• type Option
  • func WithAuth(auth Auth) Option
  • func WithLogger(l hclog.Logger) Option
  • func WithStore(st Store) Option
• type Server
  • func New(opts ...Option) (*Server, error)
  • func (s *Server) Serve(bind string) error
  • func (s *Server) Shutdown(ctx context.Context) error
• type Store

Types

type Auth

type Auth interface {
	AuthUser(context.Context, string, string, string) error
}

An Auth component is able to validate a username and password and returns a nil error only if the

type Option

type Option func(s *Server)

Option functions configure the webserver with various values.

func WithAuth

func WithAuth(auth Auth) Option

WithAuth configures the authentication backend.

func WithLogger

func WithLogger(l hclog.Logger) Option

WithLogger sets the logger for the server.

func WithStore

func WithStore(st Store) Option

WithStore sets up the storage backend.

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is an abstraction over all methods needed to operate the state server. It includes the required Store and binds all HTTP methods to the appropriate routes.

func New

func New(opts ...Option) (*Server, error)

New returns an initialized server, but not one that is prepared to serve. The embedded echo.Echo instance's Serve method must still be called.

func (*Server) Serve

func (s *Server) Serve(bind string) error

Serve binds and serves http on the bound socket. An error will be returned if the server cannot initialize.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown gracefully shuts down the server.

type Store

type Store interface {
	Get([]byte) ([]byte, error)
	Put([]byte, []byte) error
	Del([]byte) error

	Close() error
	Sync() error
}

A Store is an abstraction to a persistent storage system that terrastate will use to durably store the state data it is entrusted with. This may very well be a remote KV store, in which case terrastate is providing AAA services on top of the existing KV store.