variable

Documentation

Index

• Variables
• func Empty(s string) (string, bool)
• func Env(key string) (string, bool)
• func EnvPresent(key string) (string, bool)
• func Expand(s string, fns ...KeyFunc) string
• func ExpandStrict(s string, fns ...KeyFunc) (string, error)
• func Identity(key string) (string, bool)
• func Versions(key string) (string, bool)
• type ImageTemplate
  • func NewDefaultImageTemplate() ImageTemplate
  • func (t *ImageTemplate) Expand(component string) (string, error)
  • func (t *ImageTemplate) ExpandOrDie(component string) string
• type KeyFunc

Variables

var OverrideVersion = version.Get()

OverrideVersion is the latest version, exposed for testing.

Functions

func Empty

func Empty(s string) (string, bool)

Empty is a KeyFunc which always returns true and the empty string.

func Env

func Env(key string) (string, bool)

Env is a KeyFunc which always returns a string

func EnvPresent

func EnvPresent(key string) (string, bool)

EnvPresent is a KeyFunc which returns an environment variable if it is present.

func Expand

func Expand(s string, fns ...KeyFunc) string

Expand expands a string and ignores any errors that occur - keys that are not recognized are replaced with the empty string.

func ExpandStrict

func ExpandStrict(s string, fns ...KeyFunc) (string, error)

ExpandStrict expands a string using a series of common format functions

func Identity

func Identity(key string) (string, bool)

Identity is a KeyFunc that returns the same format rules.

func Versions

func Versions(key string) (string, bool)

Versions is a KeyFunc for retrieving information about the current version.

Types

type ImageTemplate

type ImageTemplate struct {
	// Required, set to the image template to pull
	Format string
	Latest bool
	// Optional, if set will substitute the value of ${component} with any env
	// var that matches this format. Is a printf format string accepting a single
	// string parameter.
	EnvFormat string
}

ImageTemplate is a class to assist in expanding parameterized Docker image references from configuration or a file

func NewDefaultImageTemplate

func NewDefaultImageTemplate() ImageTemplate

func (*ImageTemplate) Expand

func (t *ImageTemplate) Expand(component string) (string, error)

func (*ImageTemplate) ExpandOrDie

func (t *ImageTemplate) ExpandOrDie(component string) string

type KeyFunc

type KeyFunc func(key string) (string, bool)

KeyFunc returns the value associated with the provided key or false if no such key exists.