webadmin

Documentation

Index

• Constants
• func CheckIPACL(ipAccessList string) gin.HandlerFunc
• func GetRequestID(c *gin.Context) string
• func GetRole(c *gin.Context) string
• func GetUser(c *gin.Context) string
• func JSONMessage(c *gin.Context, statusCode int, errorMessage error)
• func JSONMessageAndAbort(c *gin.Context, statusCode int, errorMessage error)
• func LogHTTPRequest(logger *zap.Logger) gin.HandlerFunc
• func ReadinessProbe(c *gin.Context)
• func SetRequestID() gin.HandlerFunc
• func ShowAllRoutes(e *gin.Engine, applicationName string) gin.HandlerFunc
• func ShowStartupConfiguration(configObject interface{}) gin.HandlerFunc
• func StoreRole(c *gin.Context, role string)
• func StoreUser(c *gin.Context, user string)
• type Config
• type Webadmin
  • func New(config Config, applicationName string) *Webadmin
  • func (w *Webadmin) Start()

Constants

const (
	// Path to be used by k8s readiness check
	ReadinessCheckPath = "/readiness"

	// Prometheus metrics endpoint
	MetricsPath = "/metrics"

	// Path endpoint for showing running configuration
	ConfigDumpPath = "/config_dump"

	// Key of user's role in request context
	RoleContextKey = "Role"

	// Key of RequestID in request context
	RequestIDKey = "RequestId"

	// RequestID header
	RequestIDHeader = "request-id"
)

Functions

func CheckIPACL

func CheckIPACL(ipAccessList string) gin.HandlerFunc

CheckIPACL checks if requestor's ip address matches ACL

func GetRequestID

func GetRequestID(c *gin.Context) string

GetRequestID returns RequestID from request context

func GetRole

func GetRole(c *gin.Context) string

GetRole returns role of requestor

func GetUser

func GetUser(c *gin.Context) string

GetUser returns name of requestor

func JSONMessage

func JSONMessage(c *gin.Context, statusCode int, errorMessage error)

JSONMessage returns an error message

func JSONMessageAndAbort

func JSONMessageAndAbort(c *gin.Context, statusCode int, errorMessage error)

JSONMessageAndAbort returns an error message, and aborts request

func LogHTTPRequest

func LogHTTPRequest(logger *zap.Logger) gin.HandlerFunc

LogHTTPRequest logs details of an HTTP request

func ReadinessProbe

func ReadinessProbe(c *gin.Context)

ReadinessProbe answer with OK

func SetRequestID

func SetRequestID() gin.HandlerFunc

SetRequestID adds a Request-Id HTTP header for tracking purposes

func ShowAllRoutes

func ShowAllRoutes(e *gin.Engine, applicationName string) gin.HandlerFunc

ShowAllRoutes shows HTML page based with all registered routes

func ShowStartupConfiguration

func ShowStartupConfiguration(configObject interface{}) gin.HandlerFunc

ShowStartupConfiguration prints configuration object as yaml

func StoreRole

func StoreRole(c *gin.Context, role string)

StoreRole stores provided role in request context

func StoreUser

func StoreUser(c *gin.Context, user string)

StoreUser stores provided username in request context

Types

type Config

type Config struct {
	Logger shared.Logger // log configuration of webadmin accesslog
	Listen string        // Address and port to listen
	IPACL  string        // ip accesslist (e.g. "10.0.0.0/8,192.168.0.0/16")
	TLS    struct {
		CertFile string // TLS certifcate file
		KeyFile  string // TLS certifcate key file
	}
}

Config holds the configuration of a webadmin

type Webadmin

type Webadmin struct {
	Router *gin.Engine
	// contains filtered or unexported fields
}

Webadmin is an instance of our admin interface that provides operational information

func New

func New(config Config, applicationName string) *Webadmin

New returns a new webadmin

func (*Webadmin) Start

func (w *Webadmin) Start()

Start starts a web admin instance