README
¶
pkg/server
Purpose
This package assembles the live compute HTTP server.
It is where the service-specific application layer is combined with the shared platform request pipeline:
- OpenTelemetry
- logging
- route resolution
- CORS
- remote authorization
- OpenAPI validation
- audit
The important point is that compute does not invent its own trust model here. It composes platform-defined middleware and then injects a compute-specific handler that depends on both identity and region clients.
Invariants And Guard Rails
- Middleware ordering is treated as an application-level invariant.
- Identity-backed authorization and OpenAPI validation are applied centrally, not route-by-route.
- The server always constructs both identity and region API clients before the compute handler comes alive, which reflects compute's role as a façade over both services.
- pprof is exposed on a separate listener, which is operationally relevant even though it is not part of the user-facing API contract.
Caveats
- This package is mostly composition, so it is easy to undersell. In practice it defines the live request pipeline that makes the handler model real.
- The pprof server is started opportunistically in a goroutine and logs errors
via
fmt.Println, which is operationally weaker than the structured logging used elsewhere. context.TODO()is still used when building downstream identity and region API clients, which suggests some context-propagation cleanup is still pending.
TODO
- Move OpenTelemetry-specific configuration into a dedicated options struct as the in-code TODO already suggests.
- Revisit pprof listener lifecycle and logging so it follows the same structured-operational conventions as the main server.
- Audit whether downstream client construction should inherit a more explicit
startup context than
context.TODO().
Cross-Package Context
- ./handler documents the compute application layer this package exposes over HTTP
identity/pkg/middleware/openapidocuments the authorization/validation middleware family this package composes
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
Namespace string
// ListenAddress tells the server what to listen on, you shouldn't
// need to change this, its already non-privileged and the default
// should be modified to avoid clashes with other services e.g prometheus.
ListenAddress string
// ReadTimeout defines how long before we give up on the client,
// this should be fairly short.
ReadTimeout time.Duration
// ReadHeaderTimeout defines how long before we give up on the client,
// this should be fairly short.
ReadHeaderTimeout time.Duration
// WriteTimeout defines how long we take to respond before we give up.
// Ideally we'd like this to be short, but Openstack in general sucks
// for performance. Some operations may still involve multiple dependent
// API calls before a response can be returned.
WriteTimeout time.Duration
// RequestTimeout places a hard limit on all requests lengths.
RequestTimeout time.Duration
}
Options allows server options to be overridden.
type Server ¶
type Server struct {
// CoreOptions are all common across everything e.g. namespace.
CoreOptions options.CoreOptions
// ServerOptions are server specific options e.g. listener address etc.
ServerOptions options.ServerOptions
// HandlerOptions sets options for the HTTP handler.
HandlerOptions handler.Options
// CORSOptions are for remote resource sharing.
CORSOptions cors.Options
// ClientOptions are for generic TLS client options e.g. certificates.
ClientOptions coreclient.HTTPClientOptions
// IdentityOptions are for a shared identity client.
IdentityOptions *identityclient.Options
// RegionOptions are for a shared region client.
RegionOptions *regionclient.Options
// OpenAPIOptions are for OpenAPI processing.
OpenAPIOptions openapimiddleware.Options
}
func (*Server) SetupLogging ¶
func (s *Server) SetupLogging()
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.