uiserver

Documentation

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type Handler
  • func NewHandler(agentCfg *config.RuntimeConfig, logger hclog.Logger, transform UIDataTransform) *Handler
  • func (h *Handler) ReloadConfig(newCfg *config.RuntimeConfig) error
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type UIDataTransform

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type Handler

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

Handler is the http.Handler that serves the Consul UI. It may serve from the compiled-in AssetFS or from and external dir. It provides a few important transformations on the index.html file and includes a proxy for metrics backends.

func NewHandler

func NewHandler(agentCfg *config.RuntimeConfig, logger hclog.Logger, transform UIDataTransform) *Handler

NewHandler returns a Handler that can be used to serve UI http requests. It accepts a full agent config since properties like ACLs being enabled affect the UI so we need more than just UIConfig parts.

func (*Handler) ReloadConfig

func (h *Handler) ReloadConfig(newCfg *config.RuntimeConfig) error

ReloadConfig is called by the agent when the configuration is reloaded and updates the UIConfig values the handler uses to serve requests.

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler and serves UI HTTP requests

type UIDataTransform

type UIDataTransform func(cfg *config.RuntimeConfig, data map[string]interface{}) error

UIDataTransform is an optional dependency that allows the agent to add additional data into the UI index as needed. For example we use this to inject enterprise-only feature flags into the template without making this package inherently dependent on Enterprise-only code.

It is passed the current RuntimeConfig being applied and a map containing the current data that will be passed to the template. It should be modified directly to inject additional context.