api

Documentation

Index

• type DashboardHandler
  • func (g DashboardHandler) Append(router *mux.Router)
• type DebugHandler
  • func (g DebugHandler) Append(router *mux.Router)
• type Handler
  • func New(staticConfig static.Configuration, runtimeConfig *config.RuntimeConfiguration) *Handler
  • func (h Handler) Append(router *mux.Router)
• type RunTimeRepresentation

Types

type DashboardHandler

type DashboardHandler struct {
	Assets *assetfs.AssetFS
}

DashboardHandler expose dashboard routes

func (DashboardHandler) Append

func (g DashboardHandler) Append(router *mux.Router)

Append add dashboard routes on a router

type DebugHandler

type DebugHandler struct{}

DebugHandler expose debug routes

func (DebugHandler) Append

func (g DebugHandler) Append(router *mux.Router)

Append add debug routes on a router

type Handler

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

Handler serves the configuration and status of Traefik on API endpoints.

func New

func New(staticConfig static.Configuration, runtimeConfig *config.RuntimeConfiguration) *Handler

New returns a Handler defined by staticConfig, and if provided, by runtimeConfig. It finishes populating the information provided in the runtimeConfig.

func (Handler) Append

func (h Handler) Append(router *mux.Router)

Append add api routes on a router

type RunTimeRepresentation

type RunTimeRepresentation struct {
	Routers     map[string]*config.RouterInfo         `json:"routers,omitempty"`
	Middlewares map[string]*config.MiddlewareInfo     `json:"middlewares,omitempty"`
	Services    map[string]*serviceInfoRepresentation `json:"services,omitempty"`
	TCPRouters  map[string]*config.TCPRouterInfo      `json:"tcpRouters,omitempty"`
	TCPServices map[string]*config.TCPServiceInfo     `json:"tcpServices,omitempty"`
}

RunTimeRepresentation is the configuration information exposed by the API handler.