web

Documentation

Index

• type Handler
  • func New(logger log.Logger, o *Options) *Handler
  • func (h *Handler) ApplyConfig(conf *config.Config, tmpl *template.Template) error
  • func (h *Handler) Ready()
  • func (h *Handler) Reload() <-chan chan error
  • func (h *Handler) Run(ctx context.Context) error
• type Options
• type VersionInfo

Types

type Handler

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

func New

func New(logger log.Logger, o *Options) *Handler

func (*Handler) ApplyConfig

func (h *Handler) ApplyConfig(conf *config.Config, tmpl *template.Template) error

ApplyConfig updates the config field of the Handler struct

func (*Handler) Ready

func (h *Handler) Ready()

Ready sets Handler to be ready.

func (*Handler) Reload

func (h *Handler) Reload() <-chan chan error

Reload returns the receive-only channel that signals configuration reload requests.

func (*Handler) Run

func (h *Handler) Run(ctx context.Context) error

Run serves the HTTP endpoints.

type Options

type Options struct {
	ListenAddress   string
	EnableWebUI     bool
	EnableLifecycle bool
	Version         *VersionInfo
	Flags           map[string]string
}

Options for the web Handler.

type VersionInfo

type VersionInfo = apiv1.VersionInfo