package routes

import "k8s.io/kubernetes/pkg/genericapiserver/routes"

Package routes holds a collection of optional genericapiserver http handlers.

Index ¶

• type DefaultMetrics
• func (m DefaultMetrics) Install(c *mux.APIContainer)
• type Index
• func (i Index) Install(c *mux.APIContainer)
• type MetricsWithReset
• func (m MetricsWithReset) Install(c *mux.APIContainer)
• type OpenAPI
• func (oa OpenAPI) Install(c *mux.APIContainer)
• type Profiling
• func (d Profiling) Install(c *mux.APIContainer)
• type Swagger
• func (s Swagger) Install(c *mux.APIContainer)
• type SwaggerUI
• func (l SwaggerUI) Install(c *mux.APIContainer)
• type Version
• func (v Version) Install(c *mux.APIContainer)

Types ¶

type DefaultMetrics ¶

type DefaultMetrics struct{}

DefaultMetrics installs the default prometheus metrics handler

func (DefaultMetrics) Install ¶

func (m DefaultMetrics) Install(c *mux.APIContainer)

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(c *mux.APIContainer)

Install adds the Index webservice to the given mux.

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.APIContainer)

Install adds the MetricsWithReset handler

type OpenAPI ¶

type OpenAPI struct {
	Config *common.Config
}

OpenAPI installs spec endpoints for each web service.

func (OpenAPI) Install ¶

func (oa OpenAPI) Install(c *mux.APIContainer)

Install adds the SwaggerUI webservice to the given mux.

type Profiling ¶

type Profiling struct{}

Profiling adds handlers for pprof under /debug/pprof.

func (Profiling) Install ¶

func (d Profiling) Install(c *mux.APIContainer)

Install adds the Profiling webservice to the given mux.

type Swagger ¶

type Swagger struct {
	ExternalAddress string
}

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.

func (Swagger) Install ¶

func (s Swagger) Install(c *mux.APIContainer)

Install adds the SwaggerUI webservice to the given mux.

type SwaggerUI ¶

type SwaggerUI struct{}

SwaggerUI exposes files in third_party/swagger-ui/ under /swagger-ui.

func (SwaggerUI) Install ¶

func (l SwaggerUI) Install(c *mux.APIContainer)

Install adds the SwaggerUI webservice to the given mux.

type Version ¶

type Version struct {
	Version *version.Info
}

Version provides a webservice with version information.

func (Version) Install ¶

func (v Version) Install(c *mux.APIContainer)

Install registers the APIServer's `/version` handler.

Source Files ¶

doc.go index.go metrics.go openapi.go profiling.go swagger.go swaggerui.go version.go

Directories ¶