config

Documentation

Index

• func GetProviders() []string
• type BlockingStrategy
• type Config
  • func NewConfig() Config
• type DynamicStrategy
• type Kubernetes
• type Logging
  • func NewLoggingConfig() Logging
• type Provider
  • func NewProviderConfig() Provider
  • func (provider Provider) IsValid() error
• type Server
  • func NewServerConfig() Server
• type Sessions
  • func NewSessionsConfig() Sessions
• type Storage
  • func NewStorageConfig() Storage
• type Strategy
  • func NewStrategyConfig() Strategy

Functions

func GetProviders

func GetProviders() []string

Types

type BlockingStrategy

type BlockingStrategy struct {
	DefaultTimeout time.Duration `mapstructure:"DEFAULT_TIMEOUT" yaml:"defaultTimeout" default:"1m"`
}

type Config

type Config struct {
	Server   Server
	Storage  Storage
	Provider Provider
	Sessions Sessions
	Logging  Logging
	Strategy Strategy
}

func NewConfig

func NewConfig() Config

type DynamicStrategy

type DynamicStrategy struct {
	CustomThemesPath        string        `mapstructure:"CUSTOM_THEMES_PATH" yaml:"customThemesPath"`
	ShowDetailsByDefault    bool          `mapstructure:"SHOW_DETAILS_BY_DEFAULT" yaml:"showDetailsByDefault"`
	DefaultTheme            string        `mapstructure:"DEFAULT_THEME" yaml:"defaultTheme" default:"hacker-terminal"`
	DefaultRefreshFrequency time.Duration `mapstructure:"DEFAULT_REFRESH_FREQUENCY" yaml:"defaultRefreshFrequency" default:"5s"`
}

type Kubernetes

type Kubernetes struct {
	//QPS limit for  K8S API access client-side throttle
	QPS float32 `mapstructure:"QPS" yaml:"QPS" default:"5"`
	//Maximum burst for client-side throttle
	Burst int `mapstructure:"BURST" yaml:"Burst" default:"10"`
	//Delimiter used for namespace/resource type/name resolution. Defaults to "_" for backward compatibility. But you should use "/" or ".".
	Delimiter string `mapstructure:"DELIMITER" yaml:"Delimiter" default:"_"`
}

type Logging

type Logging struct {
	Level string `mapstructure:"LEVEL" yaml:"level" default:"info"`
}

func NewLoggingConfig

func NewLoggingConfig() Logging

type Provider

type Provider struct {
	// The provider name to use
	// It can be either docker, swarm or kubernetes. Defaults to "docker"
	Name              string `mapstructure:"NAME" yaml:"name,omitempty" default:"docker"`
	AutoStopOnStartup bool   `yaml:"auto-stop-on-startup,omitempty" default:"true"`
	Kubernetes        Kubernetes
}

Provider holds the provider configurations

func NewProviderConfig

func NewProviderConfig() Provider

func (Provider) IsValid

func (provider Provider) IsValid() error

type Server

type Server struct {
	Port     int    `mapstructure:"PORT" yaml:"port" default:"10000"`
	BasePath string `mapstructure:"BASE_PATH" yaml:"basePath" default:"/"`
}

func NewServerConfig

func NewServerConfig() Server

type Sessions

type Sessions struct {
	DefaultDuration    time.Duration `mapstructure:"DEFAULT_DURATION" yaml:"defaultDuration" default:"5m"`
	ExpirationInterval time.Duration `mapstructure:"EXPIRATION_INTERVAL" yaml:"expirationInterval" default:"20s"`
}

func NewSessionsConfig

func NewSessionsConfig() Sessions

type Storage

type Storage struct {
	File string `mapstructure:"FILE" yaml:"file" default:""`
}

func NewStorageConfig

func NewStorageConfig() Storage

type Strategy

type Strategy struct {
	Dynamic  DynamicStrategy
	Blocking BlockingStrategy
}

func NewStrategyConfig

func NewStrategyConfig() Strategy