defaults

Documentation

Index

• func AuthFileKeyFilenameFor(platform string) values.String
• func ConfigFilenameFor(platform string) values.String
• func ListenAddressFor(platform string) values.SocketAddress
• type Defaults
  • func GetDefaultsFor(platform string) Defaults

Functions

func AuthFileKeyFilenameFor

func AuthFileKeyFilenameFor(platform string) values.String

AuthFileKeyFilenameFor queries the AuthFileKeyFilename of the current platform. This will be influenced by GOOS environment variable.

func ConfigFilenameFor

func ConfigFilenameFor(platform string) values.String

ConfigFilenameFor queries the ConfigFilename of the current platform. This will be influenced by GOOS environment variable.

func ListenAddressFor

func ListenAddressFor(platform string) values.SocketAddress

ListenAddressFor queries the ListenAddress of the current platform. This will be influenced by GOOS environment variable.

Types

type Defaults

type Defaults struct {
	// ListenAddress represents the default address caretakerd listens to.
	ListenAddress values.SocketAddress
	// AuthFileKeyFilename represents the default file name caretakerd uses to store
	// the key for the caretakerctl/control process.
	AuthFileKeyFilename values.String
	// ConfigFilename represents the default location where caretakerd searches for its config file (yaml).
	ConfigFilename values.String
}

Defaults holds default values for a specific platform.

func GetDefaultsFor

func GetDefaultsFor(platform string) Defaults

GetDefaultsFor queries the caretakerd default values of the given platform.