common

Documentation

Index

• Constants
• func BindCommandlineArguments()
• func ConfigureCommandLineLogging()
• func ConfigureLogging()
• func ContextWithDefaultTimeout() (*armadacontext.Context, context.CancelFunc)
• func LoadConfig(config any, defaultPath string, overrideConfigs []string) *viper.Viper
• func PodName(jobId string) string
• func ServeHttp(port uint16, mux http.Handler) (shutdown func())
• func ServeHttps(port uint16, mux http.Handler, certFile, keyFile string) (shutdown func())
• func ServeMetrics(port uint16) (shutdown func())
• func ServeMetricsFor(port uint16, gatherer prometheus.Gatherer) (shutdown func())
• func UnmarshalKey(v *viper.Viper, key string, item interface{}) error
• type LoginCredentials
  • func (c *LoginCredentials) GetRequestMetadata(context.Context, ...string) (map[string]string, error)
  • func (c *LoginCredentials) RequireTransportSecurity() bool

Constants

const PodNamePrefix string = "armada-"

Functions

func BindCommandlineArguments

func BindCommandlineArguments()

func ConfigureCommandLineLogging

func ConfigureCommandLineLogging()

TODO Move logging-related code out of common into a new package internal/logging

func ConfigureLogging

func ConfigureLogging()

func ContextWithDefaultTimeout

func ContextWithDefaultTimeout() (*armadacontext.Context, context.CancelFunc)

func LoadConfig

func LoadConfig(config any, defaultPath string, overrideConfigs []string) *viper.Viper

TODO Move code relating to config out of common into a new package internal/serverconfig

func PodName

func PodName(jobId string) string

func ServeHttp

func ServeHttp(port uint16, mux http.Handler) (shutdown func())

ServeHttp starts an HTTP server listening on the given port. TODO: Make block until a context passed in is cancelled.

func ServeHttps

func ServeHttps(port uint16, mux http.Handler, certFile, keyFile string) (shutdown func())

func ServeMetrics

func ServeMetrics(port uint16) (shutdown func())

func ServeMetricsFor

func ServeMetricsFor(port uint16, gatherer prometheus.Gatherer) (shutdown func())

func UnmarshalKey

func UnmarshalKey(v *viper.Viper, key string, item interface{}) error

Types

type LoginCredentials

type LoginCredentials struct {
	Username string
	Password string
}

func (*LoginCredentials) GetRequestMetadata

func (c *LoginCredentials) GetRequestMetadata(context.Context, ...string) (map[string]string, error)

func (*LoginCredentials) RequireTransportSecurity

func (c *LoginCredentials) RequireTransportSecurity() bool