config

Documentation

Overview

Package config handles parsing YAML and environment variable input into a Custom Pod Autoscaler configuration file. Contains a set of defaults that can be overridden by provided YAML and env vars.

Index

• Constants
• type APIConfig
• type Config
  • func LoadConfig(configFileData []byte, envVars map[string]string) (*Config, error)
• type Method
• type Shell

Constants

const (
	// PerPodRunMode runs metric gathering per Pod, individually running the script for each Pod being managed
	// with the Pod information piped into the metric gathering script
	PerPodRunMode = "per-pod"
	// PerResourceRunMode runs metric gathering per Resource, running the script only once for the resource
	// being managed, with the resource information piped into the metric gathering script
	PerResourceRunMode = "per-resource"
)

Types

type APIConfig

type APIConfig struct {
	Enabled  bool   `json:"enabled"`
	UseHTTPS bool   `json:"useHTTPS"`
	Port     int    `json:"port"`
	Host     string `json:"host"`
	CertFile string `json:"certFile"`
	KeyFile  string `json:"keyFile"`
}

APIConfig is configuration options specifically for the API exposed by the CPA

type Config

type Config struct {
	ScaleTargetRef         *autoscaling.CrossVersionObjectReference `json:"scaleTargetRef"`
	PreMetric              *Method                                  `json:"preMetric"`
	PostMetric             *Method                                  `json:"postMetric"`
	PreEvaluate            *Method                                  `json:"preEvaluate"`
	PostEvaluate           *Method                                  `json:"postEvaluate"`
	PreScale               *Method                                  `json:"preScale"`
	PostScale              *Method                                  `json:"postScale"`
	Evaluate               *Method                                  `json:"evaluate"`
	Metric                 *Method                                  `json:"metric"`
	Interval               int                                      `json:"interval"`
	Namespace              string                                   `json:"namespace"`
	MinReplicas            int32                                    `json:"minReplicas"`
	MaxReplicas            int32                                    `json:"maxReplicas"`
	RunMode                string                                   `json:"runMode"`
	StartTime              int64                                    `json:"startTime"`
	LogVerbosity           int32                                    `json:"logVerbosity"`
	DownscaleStabilization int                                      `json:"downscaleStabilization"`
	APIConfig              *APIConfig                               `json:"apiConfig"`
}

Config is the configuration options for the CPA

func LoadConfig

func LoadConfig(configFileData []byte, envVars map[string]string) (*Config, error)

LoadConfig loads in the default configuration, then overrides it from the config file, then any env vars set.

type Method

type Method struct {
	Type    string `json:"type"`
	Timeout int    `json:"timeout"`
	Shell   *Shell `json:"shell"`
}

Method describes a method for passing data/triggerering logic, such as through a shell command

type Shell

type Shell struct {
	Command    []string `json:"command"`
	Entrypoint string   `json:"entrypoint"`
}

Shell describes configuration options for a shell command method