Documentation ¶
Overview ¶
Package routes holds a collection of optional genericapiserver http handlers.
Index ¶
- func StringFlagPutHandler(setter StringFlagSetterFunc) http.HandlerFunc
- type DebugFlags
- type DefaultMetrics
- type Index
- type IndexLister
- type ListedPathProvider
- type ListedPathProviders
- type MetricsWithReset
- type OpenAPI
- type Profiling
- type StringFlagSetterFunc
- type Swagger
- type SwaggerUI
- type Version
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func StringFlagPutHandler ¶ added in v1.11.6
func StringFlagPutHandler(setter StringFlagSetterFunc) http.HandlerFunc
StringFlagPutHandler wraps an http Handler to set string type flag.
Types ¶
type DebugFlags ¶ added in v1.11.6
type DebugFlags struct { }
DebugFlags adds handlers for flags under /debug/flags.
func (DebugFlags) Index ¶ added in v1.11.6
func (f DebugFlags) Index(w http.ResponseWriter, r *http.Request)
Index responds with the `/debug/flags` request. For example, "/debug/flags/v" serves the "--v" flag. Index responds to a request for "/debug/flags/" with an HTML page listing the available flags.
func (DebugFlags) Install ¶ added in v1.11.6
func (f DebugFlags) Install(c *mux.PathRecorderMux, flag string, handler func(http.ResponseWriter, *http.Request))
Install registers the APIServer's flags handler.
type DefaultMetrics ¶
type DefaultMetrics struct{}
DefaultMetrics installs the default prometheus metrics handler
func (DefaultMetrics) Install ¶
func (m DefaultMetrics) Install(c *mux.PathRecorderMux)
Install adds the DefaultMetrics handler
type Index ¶
type Index struct{}
Index provides a webservice for the http root / listing all known paths.
func (Index) Install ¶
func (i Index) Install(pathProvider ListedPathProvider, mux *mux.PathRecorderMux)
Install adds the Index webservice to the given mux.
type IndexLister ¶ added in v1.7.0
type IndexLister struct { StatusCode int PathProvider ListedPathProvider }
IndexLister lists the available indexes with the status code provided
func (IndexLister) ServeHTTP ¶ added in v1.7.0
func (i IndexLister) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP serves the available paths.
type ListedPathProvider ¶ added in v1.7.0
type ListedPathProvider interface { // ListedPaths is an alphabetically sorted list of paths to be reported at /. ListedPaths() []string }
ListedPathProvider is an interface for providing paths that should be reported at /.
type ListedPathProviders ¶ added in v1.7.0
type ListedPathProviders []ListedPathProvider
ListedPathProviders is a convenient way to combine multiple ListedPathProviders
func (ListedPathProviders) ListedPaths ¶ added in v1.7.0
func (p ListedPathProviders) ListedPaths() []string
ListedPaths unions and sorts the included paths.
type MetricsWithReset ¶
type MetricsWithReset struct{}
MetricsWithReset install the prometheus metrics handler extended with support for the DELETE method which resets the metrics.
func (MetricsWithReset) Install ¶
func (m MetricsWithReset) Install(c *mux.PathRecorderMux)
Install adds the MetricsWithReset handler
type Profiling ¶
type Profiling struct{}
Profiling adds handlers for pprof under /debug/pprof.
func (Profiling) Install ¶
func (d Profiling) Install(c *mux.PathRecorderMux)
Install adds the Profiling webservice to the given mux.
type StringFlagSetterFunc ¶ added in v1.11.6
StringFlagSetterFunc is a func used for setting string type flag.
type Swagger ¶
type Swagger struct {
Config *swagger.Config
}
Swagger installs the /swaggerapi/ endpoint to allow schema discovery and traversal. It is optional to allow consumers of the Kubernetes GenericAPIServer to register their own web services into the Kubernetes mux prior to initialization of swagger, so that other resource types show up in the documentation.