http

package

v0.22.1 Latest Latest Go to latest Published: Jan 7, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tinkerbell/tinkerbell

Links

Open Source Insights

Documentation ¶

Overview ¶

package http handles serving HTTP(s) requests, HTTP middleware, and defines common handlers.

Index ¶

func LogRequest(next http.Handler, logger logr.Logger) http.Handler
type ConfigHTTP
- func (c *ConfigHTTP) ServeHTTP(ctx context.Context, addr string, handlers HandlerMapping) error
type ConfigHTTPS
- func (c *ConfigHTTPS) ServeHTTPS(ctx context.Context, addrPort string, handlers HandlerMapping) error
type HandlerMapping
type HealthCheck
- func (h HealthCheck) HandlerFunc(log logr.Logger) http.HandlerFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func LogRequest ¶

func LogRequest(next http.Handler, logger logr.Logger) http.Handler

Types ¶

type ConfigHTTP ¶

type ConfigHTTP struct {
	Logger         logr.Logger
	TrustedProxies []string
}

ConfigHTTP is the configuration for the http server.

func (*ConfigHTTP) ServeHTTP ¶

func (c *ConfigHTTP) ServeHTTP(ctx context.Context, addr string, handlers HandlerMapping) error

ServeHTTP sets up all the HTTP routes using a stdlib mux and starts the http server, which will block. App functionality is instrumented in Prometheus and OpenTelemetry.

type ConfigHTTPS ¶

type ConfigHTTPS struct {
	Logger         logr.Logger
	TrustedProxies []string
	TLSCerts       []tls.Certificate
}

ConfigHTTPS is the configuration for the HTTPS server.

func (*ConfigHTTPS) ServeHTTPS ¶

func (c *ConfigHTTPS) ServeHTTPS(ctx context.Context, addrPort string, handlers HandlerMapping) error

ServeHTTPS sets up all the HTTP routes using a stdlib mux and starts the https server, which will block. App functionality is instrumented in Prometheus and OpenTelemetry.

type HandlerMapping ¶

type HandlerMapping map[string]http.HandlerFunc

HandlerMapping is a map of routes to http.HandlerFuncs.

type HealthCheck ¶

type HealthCheck struct {
	StartTime time.Time
	GitRev    string
}

func (HealthCheck) HandlerFunc ¶

func (h HealthCheck) HandlerFunc(log logr.Logger) http.HandlerFunc

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL