configuration

Documentation

Index

• func GetWantConfig(opts ...wantConfigOption) *configuration.Configuration
• func ParseEnvironment(configString string, envs []string) (config *configuration.Configuration, err error)
• func WithHTTP(http HTTP) wantConfigOption
• func WithHeaders(headers http.Header) wantConfigOption
• func WithStorage(storage configuration.Storage) wantConfigOption
• type HTTP
• type Parser
  • func GetParser(envs []string) *Parser
  • func NewParser(prefix string, envs []string, parseInfos []configuration.VersionedParseInfo) *Parser
  • func (p *Parser) Parse(in []byte, v interface{}) error

Functions

func GetWantConfig

func GetWantConfig(opts ...wantConfigOption) *configuration.Configuration

func ParseEnvironment

func ParseEnvironment(configString string, envs []string) (config *configuration.Configuration, err error)

Get configuration given array of strings as environment variables and current configuration object a modification from Parse https://github.com/distribution/distribution/blob/32ccbf193d5016bd0908d2eb636333d3cca22534/configuration/configuration.go#L649-L695

func WithHTTP

func WithHTTP(http HTTP) wantConfigOption

func WithHeaders

func WithHeaders(headers http.Header) wantConfigOption

func WithStorage

func WithStorage(storage configuration.Storage) wantConfigOption

Types

type HTTP

type HTTP struct {
	// Addr specifies the bind address for the registry instance.
	Addr string `yaml:"addr,omitempty"`

	// Net specifies the net portion of the bind address. A default empty value means tcp.
	Net string `yaml:"net,omitempty"`

	// Host specifies an externally-reachable address for the registry, as a fully
	// qualified URL.
	Host string `yaml:"host,omitempty"`

	Prefix string `yaml:"prefix,omitempty"`

	// Secret specifies the secret key which HMAC tokens are created with.
	Secret string `yaml:"secret,omitempty"`

	// RelativeURLs specifies that relative URLs should be returned in
	// Location headers
	RelativeURLs bool `yaml:"relativeurls,omitempty"`

	// Amount of time to wait for connection to drain before shutting down when registry
	// receives a stop signal
	DrainTimeout time.Duration `yaml:"draintimeout,omitempty"`

	// TLS instructs the http server to listen with a TLS configuration.
	// This only support simple tls configuration with a cert and key.
	// Mostly, this is useful for testing situations or simple deployments
	// that require tls. If more complex configurations are required, use
	// a proxy or make a proposal to add support here.
	TLS struct {
		// Certificate specifies the path to an x509 certificate file to
		// be used for TLS.
		Certificate string `yaml:"certificate,omitempty"`

		// Key specifies the path to the x509 key file, which should
		// contain the private portion for the file specified in
		// Certificate.
		Key string `yaml:"key,omitempty"`

		// Specifies the CA certs for client authentication
		// A file may contain multiple CA certificates encoded as PEM
		ClientCAs []string `yaml:"clientcas,omitempty"`

		// Specifies the lowest TLS version allowed
		MinimumTLS string `yaml:"minimumtls,omitempty"`

		// Specifies a list of cipher suites allowed
		CipherSuites []string `yaml:"ciphersuites,omitempty"`

		// LetsEncrypt is used to configuration setting up TLS through
		// Let's Encrypt instead of manually specifying certificate and
		// key. If a TLS certificate is specified, the Let's Encrypt
		// section will not be used.
		LetsEncrypt struct {
			// CacheFile specifies cache file to use for lets encrypt
			// certificates and keys.
			CacheFile string `yaml:"cachefile,omitempty"`

			// Email is the email to use during Let's Encrypt registration
			Email string `yaml:"email,omitempty"`

			// Hosts specifies the hosts which are allowed to obtain Let's
			// Encrypt certificates.
			Hosts []string `yaml:"hosts,omitempty"`
		} `yaml:"letsencrypt,omitempty"`
	} `yaml:"tls,omitempty"`

	// Headers is a set of headers to include in HTTP responses. A common
	// use case for this would be security headers such as
	// Strict-Transport-Security. The map keys are the header names, and
	// the values are the associated header payloads.
	Headers http.Header `yaml:"headers,omitempty"`

	// Debug configures the http debug interface, if specified. This can
	// include services such as pprof, expvar and other data that should
	// not be exposed externally. Left disabled by default.
	Debug struct {
		// Addr specifies the bind address for the debug server.
		Addr string `yaml:"addr,omitempty"`
		// Prometheus configures the Prometheus telemetry endpoint.
		Prometheus struct {
			Enabled bool   `yaml:"enabled,omitempty"`
			Path    string `yaml:"path,omitempty"`
		} `yaml:"prometheus,omitempty"`
	} `yaml:"debug,omitempty"`

	// HTTP2 configuration options
	HTTP2 struct {
		// Specifies whether the registry should disallow clients attempting
		// to connect via http2. If set to true, only http/1.1 is supported.
		Disabled bool `yaml:"disabled,omitempty"`
	} `yaml:"http2,omitempty"`
}

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

Parser can be used to parse a configuration file and environment of a defined version into a unified output structure

func GetParser

func GetParser(envs []string) *Parser

func NewParser

func NewParser(prefix string, envs []string, parseInfos []configuration.VersionedParseInfo) *Parser

NewParser returns a *Parser with the given environment prefix which handles versioned configurations which match the given parseInfos

func (*Parser) Parse

func (p *Parser) Parse(in []byte, v interface{}) error

Parse reads in the given []byte and environment and writes the resulting configuration into the input v

Environment variables may be used to override configuration parameters other than version, following the scheme below: v.Abc may be replaced by the value of PREFIX_ABC, v.Abc.Xyz may be replaced by the value of PREFIX_ABC_XYZ, and so forth