Documentation
¶
Index ¶
Constants ¶
const RegSvcMetricsPort = 8083
Variables ¶
This section is empty.
Functions ¶
func NewInClusterApplication ¶
func NewInClusterApplication(client namespaced.Client) application.Application
NewInClusterApplication creates a new in-cluster application.
func StartMetricsServer ¶
return a new Gin server exposing the `/metrics` endpoint associated with the given Prometheus registry
Types ¶
type InClusterApplication ¶
type InClusterApplication struct {
// contains filtered or unexported fields
}
func (InClusterApplication) SignupService ¶
func (r InClusterApplication) SignupService() service.SignupService
func (InClusterApplication) VerificationService ¶
func (r InClusterApplication) VerificationService() service.VerificationService
type RegistrationServer ¶
type RegistrationServer struct {
// contains filtered or unexported fields
}
RegistrationServer bundles configuration, and HTTP server objects in a single location.
func New ¶
func New(application application.Application) *RegistrationServer
New creates a new RegistrationServer object with reasonable defaults.
func (*RegistrationServer) Engine ¶
func (srv *RegistrationServer) Engine() *gin.Engine
Engine returns the app server's HTTP router.
func (*RegistrationServer) GetRegisteredRoutes ¶
func (srv *RegistrationServer) GetRegisteredRoutes() string
GetRegisteredRoutes returns all registered routes formatted with their methods, paths, queries and names. It is a good idea to print this information on server start to give you an idea of what routes are available in the system.
func (*RegistrationServer) HTTPServer ¶
func (srv *RegistrationServer) HTTPServer() *http.Server
HTTPServer returns the app server's HTTP server.
func (*RegistrationServer) SetupRoutes ¶
func (srv *RegistrationServer) SetupRoutes(proxyPort string, reg *prometheus.Registry, nsClient namespaced.Client) error
SetupRoutes registers handlers for various URL paths. proxyPort is the API Proxy Server port to be used to setup a route for the health checker for the proxy.
type ServerOption ¶
type ServerOption = func(server *RegistrationServer) // nolint:revive