assets

Documentation

Overview

Package assets includes all of the built static assets used by the OpenShift console and login flows, as well as all supporting server logic for running the console.

Assets have been generated into a .go file and then compiled into the OpenShift all-in-one binary. The source files for these assets are in https://github.com/openshift/origin-web-console

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetExtensionHandler(sourceDir, context string, html5Mode bool) http.Handler
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func CacheControlHandler(version string, h http.Handler) http.Handler
• func ExtensionScriptsHandler(files []string, developmentMode bool) (http.Handler, error)
• func ExtensionStylesheetsHandler(files []string, developmentMode bool) (http.Handler, error)
• func GeneratedConfigHandler(config WebConsoleConfig, version WebConsoleVersion, ...) (http.Handler, error)
• func GzipHandler(h http.Handler) http.Handler
• func HTML5ModeHandler(contextRoot string, subcontextMap map[string]string, h http.Handler, ...) (http.Handler, error)
• func MustAsset(name string) []byte
• func RegisterMimeTypes()
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type AssetDirFunc
  • func JoinAssetDirFuncs(funcs ...AssetDirFunc) AssetDirFunc
• type AssetFunc
  • func JoinAssetFuncs(funcs ...AssetFunc) AssetFunc
• type LongestToShortest
  • func (s LongestToShortest) Len() int
  • func (s LongestToShortest) Less(i, j int) bool
  • func (s LongestToShortest) Swap(i, j int)
• type WebConsoleConfig
• type WebConsoleExtensionProperties
• type WebConsoleExtensionProperty
• type WebConsoleVersion

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 AssetExtensionHandler

func AssetExtensionHandler(sourceDir, context string, html5Mode bool) http.Handler

AssetExtensionHandler serves extension files from sourceDir. context is the URL context for this extension.

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 CacheControlHandler

func CacheControlHandler(version string, h http.Handler) http.Handler

func ExtensionScriptsHandler

func ExtensionScriptsHandler(files []string, developmentMode bool) (http.Handler, error)

ExtensionScriptsHandler concatenates and serves extension JavaScript files as one HTTP response.

func ExtensionStylesheetsHandler

func ExtensionStylesheetsHandler(files []string, developmentMode bool) (http.Handler, error)

ExtensionStylesheetsHandler concatenates and serves extension stylesheets as one HTTP response.

func GeneratedConfigHandler

func GeneratedConfigHandler(config WebConsoleConfig, version WebConsoleVersion, extensionProps WebConsoleExtensionProperties) (http.Handler, error)

func GzipHandler

func GzipHandler(h http.Handler) http.Handler

GzipHandler wraps a http.Handler to support transparent gzip encoding.

func HTML5ModeHandler

func HTML5ModeHandler(contextRoot string, subcontextMap map[string]string, h http.Handler, getAsset AssetFunc) (http.Handler, error)

HTML5ModeHandler will serve any static assets we know about, all other paths are assumed to be HTML5 paths for the console application and index.html will be served. contextRoot must contain leading and trailing slashes, e.g. /console/

subcontextMap is a map of keys (subcontexts, no leading or trailing slashes) to the asset path (no leading slash) to serve for that subcontext if a resource that does not exist is requested

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 RegisterMimeTypes

func RegisterMimeTypes()

RegisterMimeTypes adds mime type registrations for the file types the assets server will serve. Registering here so we work without /etc/mime.types installed

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 AssetDirFunc

type AssetDirFunc func(path string) ([]string, error)

func JoinAssetDirFuncs

func JoinAssetDirFuncs(funcs ...AssetDirFunc) AssetDirFunc

JoinAssetDirFuncs returns an asset dir function that delegates to the provided asset dir functions. The functions are assumed to provide non-overlapping assets

type AssetFunc

type AssetFunc func(path string) ([]byte, error)

func JoinAssetFuncs

func JoinAssetFuncs(funcs ...AssetFunc) AssetFunc

JoinAssetFuncs returns an asset function that delegates to each of the provided asset functions in turn. The functions are assumed to provide non-overlapping assets

type LongestToShortest

type LongestToShortest []string

func (LongestToShortest) Len

func (s LongestToShortest) Len() int

func (LongestToShortest) Less

func (s LongestToShortest) Less(i, j int) bool

func (LongestToShortest) Swap

func (s LongestToShortest) Swap(i, j int)

type WebConsoleConfig

type WebConsoleConfig struct {
	// APIGroupAddr is the host:port the UI should call the API groups on. Scheme is derived from the scheme the UI is served on, so they must be the same.
	APIGroupAddr string
	// APIGroupPrefix is the API group context root
	APIGroupPrefix string
	// MasterAddr is the host:port the UI should call the master API on. Scheme is derived from the scheme the UI is served on, so they must be the same.
	MasterAddr string
	// MasterPrefix is the OpenShift API context root
	MasterPrefix string
	// MasterResources holds resource names for the OpenShift API
	MasterResources []string
	// KubernetesAddr is the host:port the UI should call the kubernetes API on. Scheme is derived from the scheme the UI is served on, so they must be the same.
	// TODO this is probably unneeded since everything goes through the openshift master's proxy
	KubernetesAddr string
	// KubernetesPrefix is the Kubernetes API context root
	KubernetesPrefix string
	// KubernetesResources holds resource names for the Kubernetes API
	KubernetesResources []string
	// OAuthAuthorizeURI is the OAuth2 endpoint to use to request an API token. It must support request_type=token.
	OAuthAuthorizeURI string
	// OAuthTokenURI is the OAuth2 endpoint to use to request an API token. If set, the OAuthClientID must support a client_secret of "".
	OAuthTokenURI string
	// OAuthRedirectBase is the base URI of the web console. It must be a valid redirect_uri for the OAuthClientID
	OAuthRedirectBase string
	// OAuthClientID is the OAuth2 client_id to use to request an API token. It must be authorized to redirect to the web console URL.
	OAuthClientID string
	// LogoutURI is an optional (absolute) URI to redirect to after completing a logout. If not specified, the built-in logout page is shown.
	LogoutURI string
	// LoggingURL is the endpoint for logging (optional)
	LoggingURL string
	// MetricsURL is the endpoint for metrics (optional)
	MetricsURL string
	// LimitRequestOverrides contains the ratios for overriding request/limit on containers.
	// Applied in order:
	//   LimitCPUToMemoryPercent
	//   CPURequestToLimitPercent
	//   MemoryRequestToLimitPercent
	LimitRequestOverrides *api.ClusterResourceOverrideConfig
}

type WebConsoleExtensionProperties

type WebConsoleExtensionProperties struct {
	ExtensionProperties []WebConsoleExtensionProperty
}

type WebConsoleExtensionProperty

type WebConsoleExtensionProperty struct {
	Key   string
	Value string
}

type WebConsoleVersion

type WebConsoleVersion struct {
	KubernetesVersion string
	OpenShiftVersion  string
}