config

Documentation

Index

• Constants
• type Config
  • func ReadConfig(getEnv GetEnv) (*Config, error)
• type GetEnv

Constants

const (
	// EnvKubeconfig is used to configure the internal K8s client
	EnvKubeconfig = "KUBECONFIG"

	// EnvNamespace defines the K8s namespace that is used to keep the state of the service broker.
	EnvNamespace = "OSB_NAMESPACE"

	// EnvServiceIDs is a comma-separated list (no whitespace after comma!) of service ids available in the cluster
	EnvServiceIDs = "OSB_SERVICE_IDS"

	// EnvUsername defines the username to use when connecting to this service broker
	// when no JWT Bearer Token is presented.
	EnvUsername = "OSB_USERNAME"

	// EnvPassword defines the password to use when connecting to this service broker
	// when no JWT Bearer Token is presented.
	EnvPassword = "OSB_PASSWORD"

	// EnvUsernameClaim defines the name of the claim which is considered to be the username of the request principal
	// whenever a JWT Bearer Token is presented.
	EnvUsernameClaim = "OSB_USERNAME_CLAIM"

	// EnvHTTPListenAddr defines which port to listen on for HTTP requests.
	EnvHTTPListenAddr = "OSB_HTTP_LISTEN_ADDR"

	// EnvHTTPReadTimeout sets a read timeout for HTTP requests.
	EnvHTTPReadTimeout = "OSB_HTTP_READ_TIMEOUT"

	// EnvHTTPWriteTimeout sets a write timeout for HTTP requests.
	EnvHTTPWriteTimeout = "OSB_HTTP_WRITE_TIMEOUT"

	// EnvHTTPMaxHeaderBytes sets the maximum header size for HTTP requests.
	EnvHTTPMaxHeaderBytes = "OSB_HTTP_MAX_HEADER_BYTES"

	// EnvJWTKeyJWKURL sets the URL of a JWK file, which is used to validate the signatures of the JWT Bearer Tokens.
	EnvJWTKeyJWKURL = "OSB_JWT_KEYS_JWK_URL"

	// EnvJWTKeyPEMURL sets the URL of a PEM file, which is used to validate the signatures of the JWT Bearer Tokens.
	EnvJWTKeyPEMURL = "OSB_JWT_KEYS_PEM_URL"

	// EnvPlanUpdateSLA is a set of `|` seprated white-list rules for SLA changes
	EnvPlanUpdateSLA = "OSB_PLAN_UPDATE_SLA_RULES"
	// EnvPlanUpdateSize is a set of `|` seprated white-list rules for plan size changes
	EnvPlanUpdateSize = "OSB_PLAN_UPDATE_SIZE_RULES"

	// EnvEnableMetrics defines if metrics endpoints are returned.
	EnvEnableMetrics = "ENABLE_METRICS"
	// EnvMetricsDomain sets domain name for the metrics endpoints.
	EnvMetricsDomain = "METRICS_DOMAIN"
)

Types

type Config

type Config struct {
	Kubeconfig         string
	ServiceIDs         []string
	ListenAddr         string
	Username           string
	Password           string
	UsernameClaim      string
	JWKeyRegister      *jwt.KeyRegister
	Namespace          string
	ReadTimeout        time.Duration
	WriteTimeout       time.Duration
	MaxHeaderBytes     int
	PlanUpdateSizeRule string
	PlanUpdateSLARule  string
	EnableMetrics      bool
	MetricsDomain      string
}

Config contains all configuration values.

func ReadConfig

func ReadConfig(getEnv GetEnv) (*Config, error)

ReadConfig reads env variables using the passed function.

type GetEnv

type GetEnv func(string) string

GetEnv is an interface that allows to get variables from the environment