config

Documentation

Index

• Constants
• type Config
  • func FromJson(from string) (*Config, error)
  • func New() *Config
  • func NewConfig(loadGlobalConfig, loadUserConfig bool, configName, configType string) *Config
  • func (c *Config) Copy() (*Config, error)
  • func (c *Config) EnvVars() []string
  • func (c *Config) JsonMarshalStrategy() JsonMarshalStrategy
  • func (c *Config) MarshalJSON() ([]byte, error)
  • func (c *Config) ReadConfig(in io.Reader) error
  • func (c *Config) ReadConfigFile(filePath string) error
  • func (c *Config) SetJsonMarshalStrategy(s JsonMarshalStrategy)
  • func (c *Config) Sync()
  • func (c *Config) ToJson() (string, error)
  • func (c *Config) ToSecureJson() (string, error)
• type ConfigKey
• type ConfigKeyMap
• type JsonMarshalStrategy
• type SetVapFun

Constants

const AwsAccessKey = "awsAccessKey"

const AwsRegion = "awsRegion"

const AwsSecretKey = "awsSecretKey"

const DockerAvailabilityZone = "dockerAvailabilityZone"

const DockerIops = "dockerIops"

const DockerSize = "dockerSize"

const DockerVolumeType = "dockerVolumeType"

const Host = "host"

const LogLevel = "logLevel"

const MinVolSize = "minVolSize"

const OsDrivers = "osDrivers"

const RackspaceAuthUrl = "rackspaceAuthUrl"

const RackspaceDomainId = "rackspaceDomainId"

const RackspaceDomainName = "rackspaceDomainName"

const RackspacePassword = "rackspacePassword"

const RackspaceTenantId = "rackspaceTenantId"

const RackspaceTenantName = "rackspaceTenantName"

const RackspaceUserId = "rackspaceUserId"

const RackspaceUserName = "rackspaceUserName"

const RemoteManagement = "remoteManagement"

const ScaleIoEndpoint = "scaleIoEndpoint"

const ScaleIoInsecure = "scaleIoInsecure"

const ScaleIoPassword = "scaleIoPassword"

const ScaleIoProtectionDomainId = "scaleIoProtectionDomainId"

const ScaleIoProtectionDomainName = "scaleIoProtectionDomainName"

const ScaleIoStoragePoolId = "scaleIoStoragePoolId"

const ScaleIoStoragePoolName = "scaleIoStoragePoolName"

const ScaleIoSystemId = "scaleIoSystemId"

const ScaleIoSystemName = "scaleIoSystemName"

const ScaleIoUseCerts = "scaleIoUseCerts"

const ScaleIoUserName = "scaleIoUserName"

const StorageDrivers = "storageDrivers"

const VolumeDrivers = "volumeDrivers"

const XtremIoDeviceMapper = "xtremIoDeviceMapper"

const XtremIoEndpoint = "xtremIoEndpoint"

const XtremIoInsecure = "xtremIoInsecure"

const XtremIoMultipath = "xtremIoMultipath"

const XtremIoPassword = "xtremIoPassword"

const XtremIoRemoteManagement = "xtremIoRemoteManagement"

const XtremIoUserName = "xtremIoUserName"

Types

type Config

type Config struct {
	GlobalFlags     *flag.FlagSet `json:"-"`
	AdditionalFlags *flag.FlagSet `json:"-"`
	Viper           *viper.Viper  `json:"-"`
	Host            string        `json:"-"`
	// contains filtered or unexported fields
}

Config contains the configuration information

func FromJson

func FromJson(from string) (*Config, error)

func New

func New() *Config

New initializes a new instance of a Config struct

func NewConfig

func NewConfig(
	loadGlobalConfig, loadUserConfig bool,
	configName, configType string) *Config

func (*Config) Copy

func (c *Config) Copy() (*Config, error)

func (*Config) EnvVars

func (c *Config) EnvVars() []string

func (*Config) JsonMarshalStrategy

func (c *Config) JsonMarshalStrategy() JsonMarshalStrategy

func (*Config) MarshalJSON

func (c *Config) MarshalJSON() ([]byte, error)

The implementation of the encoding/json.Marshaller interface. It allows this type to provide its own marshalling routine.

func (*Config) ReadConfig

func (c *Config) ReadConfig(in io.Reader) error

func (*Config) ReadConfigFile

func (c *Config) ReadConfigFile(filePath string) error

func (*Config) SetJsonMarshalStrategy

func (c *Config) SetJsonMarshalStrategy(s JsonMarshalStrategy)

func (*Config) Sync

func (c *Config) Sync()

func (*Config) ToJson

func (c *Config) ToJson() (string, error)

func (*Config) ToSecureJson

func (c *Config) ToSecureJson() (string, error)

type ConfigKey

type ConfigKey struct {
	Shorthand    string
	EnvVar       string
	DefaultValue interface{}
	Description  string
}

type ConfigKeyMap

type ConfigKeyMap map[string]*ConfigKey

type JsonMarshalStrategy

type JsonMarshalStrategy int

const (
	JsonMarshalSecure JsonMarshalStrategy = iota
	JsonMarshalPlainText
)

type SetVapFun

type SetVapFun func(name string, aof *interface{}) *flag.Flag