config

Documentation

Index

• Constants
• type Config
  • func DefaultConfig() Config
  • func EC2MetadataConfig() Config
  • func EnvironmentConfig() Config
  • func FileConfig() Config
  • func NewConfig() (*Config, error)
  • func (cfg *Config) CheckMissing()
  • func (cfg *Config) Complete() bool
  • func (lhs *Config) Merge(rhs Config) *Config
• type ConfigReader

Constants

const (
	// http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=docker
	DOCKER_RESERVED_PORT     = 2375
	DOCKER_RESERVED_SSL_PORT = 2376

	SSH_PORT = 22

	AGENT_INTROSPECTION_PORT = 51678
)

Types

type Config

type Config struct {
	ClusterArn     string
	APIEndpoint    string
	APIPort        uint16
	DockerEndpoint string
	AWSRegion      string `missing:"warn"`
	ReservedPorts  []uint16
}

func DefaultConfig

func DefaultConfig() Config

func EC2MetadataConfig

func EC2MetadataConfig() Config

func EnvironmentConfig

func EnvironmentConfig() Config

EnvironmentConfig reads the given configs from the environment and attempts to convert them to the given type

func FileConfig

func FileConfig() Config

func NewConfig

func NewConfig() (*Config, error)

func (*Config) CheckMissing

func (cfg *Config) CheckMissing()

CheckMissing checks all zero-valued fields for tags of the form missing:STRING and acts based on that string. Current options are: fatal, warn. Fatal will result in a fatal error, warn will result in a warning that the field is missing being logged

func (*Config) Complete

func (cfg *Config) Complete() bool

Complete returns true if all fields of the config are populated / nonzero

func (*Config) Merge

func (lhs *Config) Merge(rhs Config) *Config

Merge merges two config files, preferring the ones on the left. Any nil or zero values present in the left that are not present in the right will be overridden

type ConfigReader

type ConfigReader interface {
	ReadConfig() *Config
}