config

Documentation

Index

• func InitConfigurationVariables(configs []ConfigurationVariables) error
• type ConfigurationVariables
• type Credentials
• type ManagerConfiguration
  • func (c *ManagerConfiguration) LoadFromEnvVars() error
• type Namespace
  • func (n Namespace) String() string
• type RESTControllerConfiguration
  • func (c *RESTControllerConfiguration) LoadFromEnvVars() error
• type ResourceKind
• type UID
• type UserID

Functions

func InitConfigurationVariables

func InitConfigurationVariables(configs []ConfigurationVariables) error

InitConfigurationVariables according to environment

Types

type ConfigurationVariables

type ConfigurationVariables interface {
	LoadFromEnvVars() error
}

ConfigurationVariables is an interface with LoadFromEnvVars method. The method is meant to be implemented as a struct method:

type StructWithVars struct {
	Var1 string        `envconfig:"VAR1"`
	Var2 string        `envconfig:"VAR2"`
}

func (swv *StructWithVars) LoadFromEnvVars() error {
  if err := envconfig.Process("", swv); err != nil {
		return err
	}
	return nil
}

type Credentials

type Credentials map[string]string

Credentials store the credentials from vault

type ManagerConfiguration

type ManagerConfiguration struct {
	EnableLeaderElection bool   `envconfig:"ENABLE_LEADER_ELECTION" required:"true"`
	LeaderElectionID     string `envconfig:"LEADER_ELECTION_ID" required:"true"`
	Port                 int    `envconfig:"MANAGER_PORT" default:"9443"`
	MetricsServerPort    int    `envconfig:"METRICS_SERVER_PORT" default:"8080"`
	HealthProbeAddress   string `envconfig:"HEALTH_PROBE_ADDRESS" default:":8081"`
}

ManagerConfiguration defines required variables to configure the environment

func (*ManagerConfiguration) LoadFromEnvVars

func (c *ManagerConfiguration) LoadFromEnvVars() error

LoadFromEnvVars from the Manager

type Namespace

type Namespace string

Namespace defines the namespace type that represents the cluster namespace

func (Namespace) String

func (n Namespace) String() string

type RESTControllerConfiguration

type RESTControllerConfiguration struct {
	UserID             string        `envconfig:"USER_ID" required:"true"`
	UserIDPrefix       string        `envconfig:"USER_ID_PREFIX" default:""`
	HTTPRequestTimeout time.Duration `envconfig:"HTTP_REQUEST_TIMEOUT" default:"30s"`
}

RESTControllerConfiguration defines a struct with required environment variables for rest controller

func (*RESTControllerConfiguration) LoadFromEnvVars

func (c *RESTControllerConfiguration) LoadFromEnvVars() error

LoadFromEnvVars reads all env vars required

type ResourceKind

type ResourceKind string

ResourceKind defines a resource kind type

type UID

type UID string

UID defines UID type represents a ID for a specific resource

type UserID

type UserID string

UserID defines the user id type