routing

Documentation

Index

• func NewRouter(conf *config.Config, kialiCache cache.KialiCache, ...) (*mux.Router, error)
• type Route
• type Routes
  • func NewRoutes(conf *config.Config, kialiCache cache.KialiCache, ...) (r *Routes)

Functions

func NewRouter

func NewRouter(
	conf *config.Config,
	kialiCache cache.KialiCache,
	clientFactory kubernetes.ClientFactory,
	prom kialiprometheus.ClientInterface,
	traceClientLoader func() tracing.ClientInterface,
	cpm business.ControlPlaneMonitor,
	grafana *grafana.Service,
) (*mux.Router, error)

NewRouter creates the router with all API routes and the static files handler

Types

type Route

type Route struct {
	Name          string
	Method        string
	Pattern       string
	HandlerFunc   http.HandlerFunc
	Authenticated bool
}

Route describes a single route

type Routes

type Routes struct {
	Routes []Route
}

Routes holds an array of Route. A note on swagger documentation. The path variables and query parameters are defined in ../doc.go. YOu need to manually associate params and routes.

func NewRoutes

func NewRoutes(
	conf *config.Config,
	kialiCache cache.KialiCache,
	clientFactory kubernetes.ClientFactory,
	prom prometheus.ClientInterface,
	traceClientLoader func() tracing.ClientInterface,
	cpm business.ControlPlaneMonitor,
	authController authentication.AuthController,
	grafana *grafana.Service,
) (r *Routes)

NewRoutes creates and returns all the API routes