server

Documentation

Index

• Constants
• Variables
• func AssetHandler(assetHandler, redirectHandler http.Handler) http.HandlerFunc
• func GetBaseHref(routePrefix string) string
• func IndexHTMLHandler(fsys fs.FS, log logr.Logger, routePrefix string) http.HandlerFunc
• func InjectHTMLBaseTag(html []byte, baseHref string) []byte
• func NewHandlers(ctx context.Context, log logr.Logger, cfg *Config, sm auth.SessionManager) (http.Handler, error)
• func WithRoutePrefix(mux *http.ServeMux, routePrefix string) *http.ServeMux
• type ApplicationsOption
  • func WithCRDFetcher(fetcher crd.Fetcher) ApplicationsOption
  • func WithClientGetter(clientGetter kube.ClientGetter) ApplicationsOption
• type ApplicationsOptions
• type Config

Constants

const DefaultHost = "0.0.0.0"

const DefaultPort = "9001"

Variables

var (
	PublicRoutes = []string{
		"/v1/featureflags",
	}
)

Functions

func AssetHandler

func AssetHandler(assetHandler, redirectHandler http.Handler) http.HandlerFunc

AssetHandler returns a http.Handler that serves static assets from the provided fs.FS. It also redirects all non-file requests to index.html.

func GetBaseHref

func GetBaseHref(routePrefix string) string

GetBaseHref formats the baseHref for the application given the configured route prefix. Its used to set the <base href> tag in the index.html file. This in turn will form the base URL for all the assets (js, css, etc) that are loaded by the browser.

The UI is built with Parcel and has been configured to generate relative script/link tags during the build (without a leading or trailing slash) e.g. <script src="main.js">. The base href we generate here must complete the URL for these assets and so should have a leading and trailing slash, e.g. <base href="/weave-gitops/"> or <base href="/">

func IndexHTMLHandler

func IndexHTMLHandler(fsys fs.FS, log logr.Logger, routePrefix string) http.HandlerFunc

IndexHTMLHandler ensures that index.html always gets served. The JS router will take care of actual navigation once the index.html page lands.

func InjectHTMLBaseTag

func InjectHTMLBaseTag(html []byte, baseHref string) []byte

InjectHTMLBaseTag injects a <base href> tag into the provided html. This is used to set the base URL for all the assets (js, css, etc) that are loaded by the browser.

func NewHandlers

func NewHandlers(ctx context.Context, log logr.Logger, cfg *Config, sm auth.SessionManager) (http.Handler, error)

NewHandlers creates and returns a new server configured to serve the core application.

func WithRoutePrefix

func WithRoutePrefix(mux *http.ServeMux, routePrefix string) *http.ServeMux

WithRoutePrefix wraps the provided mux with a new mux that handles the provided route prefix. This is useful when the application is served from a subpath, e.g. /weave-gitops. The route prefix is stripped from the request before being passed to the provided mux.

We also redirect the user to the route prefix if they hit the root of the server, e.g. if they port-forward.

Types

type ApplicationsOption

type ApplicationsOption func(*ApplicationsOptions)

ApplicationsOption defines the signature of a function that can be used to set an option for an ApplicationsServer.

func WithCRDFetcher

func WithCRDFetcher(fetcher crd.Fetcher) ApplicationsOption

WithCRDFetcher allows for setting a CRDFetcher.

func WithClientGetter

func WithClientGetter(clientGetter kube.ClientGetter) ApplicationsOption

WithClientGetter allows for setting a ClientGetter.

type ApplicationsOptions

type ApplicationsOptions struct {
	ClientGetter kube.ClientGetter
	CRDFetcher   crd.Fetcher
}

ApplicationsOptions includes all the options that can be set for an ApplicationsServer.

type Config

type Config struct {
	CoreServerConfig core.CoreServerConfig
	AuthServer       *auth.AuthServer
}