config

Documentation

Index

• Constants
• Variables
• func ConfigDir() string
• func ConfigFile() string
• func DataDir() string
• func HostsConfigFile() string
• func NewBlankRoot() *yaml.Node
• func StateDir() string
• func StubBackupConfig() func()
• func StubWriteConfig(wc io.Writer, wh io.Writer) func()
• func ValidateKey(key string) error
• func ValidateValue(key, value string) error
• type Config
  • func NewBlankConfig() Config
  • func NewConfig(root *yaml.Node) Config
  • func NewFromString(str string) Config
  • func ParseDefaultConfig() (Config, error)
• type ConfigEntry
• type ConfigMap
  • func (cm *ConfigMap) Empty() bool
  • func (cm *ConfigMap) FindEntry(key string) (ce *ConfigEntry, err error)
  • func (cm *ConfigMap) GetStringValue(key string) (string, error)
  • func (cm *ConfigMap) RemoveEntry(key string)
  • func (cm *ConfigMap) SetStringValue(key, value string) error
• type ConfigOption
  • func ConfigOptions() []ConfigOption
• type ConfigStub
  • func (c ConfigStub) CheckWriteable(host, key string) error
  • func (c ConfigStub) DefaultHost() (string, error)
  • func (c ConfigStub) DefaultHostWithSource() (string, string, error)
  • func (c ConfigStub) Get(host, key string) (string, error)
  • func (c ConfigStub) GetWithSource(host, key string) (string, string, error)
  • func (c ConfigStub) Hosts() ([]string, error)
  • func (c ConfigStub) Set(host, key, value string) error
  • func (c ConfigStub) UnsetHost(hostname string)
  • func (c ConfigStub) Write() error
• type HostConfig
• type InvalidValueError
  • func (e InvalidValueError) Error() string
• type NotFoundError

Constants

const (
	INSTILL_CONFIG_DIR = "INSTILL_CONFIG_DIR"
	XDG_CONFIG_HOME    = "XDG_CONFIG_HOME"
	XDG_STATE_HOME     = "XDG_STATE_HOME"
	XDG_DATA_HOME      = "XDG_DATA_HOME"
	APP_DATA           = "AppData"
	LOCAL_APP_DATA     = "LocalAppData"
)

Variables

var BackupConfigFile = func(filename string) error {
	return os.Rename(filename, filename+".bak")
}

var ReadConfigFile = func(filename string) ([]byte, error) {
	f, err := os.Open(filename)
	if err != nil {
		return nil, pathError(err)
	}
	defer f.Close()

	data, err := ioutil.ReadAll(f)
	if err != nil {
		return nil, err
	}

	return data, nil
}

var WriteConfigFile = func(filename string, data []byte) error {
	err := os.MkdirAll(filepath.Dir(filename), 0771)
	if err != nil {
		return pathError(err)
	}

	cfgFile, err := os.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
	if err != nil {
		return err
	}
	defer cfgFile.Close()

	_, err = cfgFile.Write(data)
	return err
}

Functions

func ConfigDir

func ConfigDir() string

ConfigDir returns config dirpath with precedence: 1. INSTILL_CONFIG_DIR 2. XDG_CONFIG_HOME 3. AppData (windows only) 4. HOME

func ConfigFile

func ConfigFile() string

func DataDir

func DataDir() string

DataDir returns data dirpath with precedence: 1. XDG_DATA_HOME 2. LocalAppData (windows only) 3. HOME

func HostsConfigFile

func HostsConfigFile() string

func NewBlankRoot

func NewBlankRoot() *yaml.Node

func StateDir

func StateDir() string

StateDir returns state dirpath with precedence: 1. XDG_CONFIG_HOME 2. LocalAppData (windows only) 3. HOME

func StubBackupConfig

func StubBackupConfig() func()

func StubWriteConfig

func StubWriteConfig(wc io.Writer, wh io.Writer) func()

func ValidateKey

func ValidateKey(key string) error

func ValidateValue

func ValidateValue(key, value string) error

Types

type Config

type Config interface {
	Get(string, string) (string, error)
	GetWithSource(string, string) (string, string, error)
	Set(string, string, string) error
	UnsetHost(string)
	Hosts() ([]string, error)
	DefaultHost() (string, error)
	DefaultHostWithSource() (string, string, error)
	CheckWriteable(string, string) error
	Write() error
}

This interface describes interacting with some persistent configuration for instill.

func NewBlankConfig

func NewBlankConfig() Config

NewBlankConfig initializes a config file pre-populated with comments and default values

func NewConfig

func NewConfig(root *yaml.Node) Config

func NewFromString

func NewFromString(str string) Config

NewFromString initializes a Config from a yaml string

func ParseDefaultConfig

func ParseDefaultConfig() (Config, error)

type ConfigEntry

type ConfigEntry struct {
	KeyNode   *yaml.Node
	ValueNode *yaml.Node
	Index     int
}

type ConfigMap

type ConfigMap struct {
	Root *yaml.Node
}

This type implements a low-level get/set config that is backed by an in-memory tree of Yaml nodes. It allows us to interact with a yaml-based config programmatically, preserving any comments that were present when the yaml was parsed.

func (*ConfigMap) Empty

func (cm *ConfigMap) Empty() bool

func (*ConfigMap) FindEntry

func (cm *ConfigMap) FindEntry(key string) (ce *ConfigEntry, err error)

func (*ConfigMap) GetStringValue

func (cm *ConfigMap) GetStringValue(key string) (string, error)

func (*ConfigMap) RemoveEntry

func (cm *ConfigMap) RemoveEntry(key string)

func (*ConfigMap) SetStringValue

func (cm *ConfigMap) SetStringValue(key, value string) error

type ConfigOption

type ConfigOption struct {
	Key           string
	Description   string
	DefaultValue  string
	AllowedValues []string
}

func ConfigOptions

func ConfigOptions() []ConfigOption

type ConfigStub

type ConfigStub map[string]string

func (ConfigStub) CheckWriteable

func (c ConfigStub) CheckWriteable(host, key string) error

func (ConfigStub) DefaultHost

func (c ConfigStub) DefaultHost() (string, error)

func (ConfigStub) DefaultHostWithSource

func (c ConfigStub) DefaultHostWithSource() (string, string, error)

func (ConfigStub) Get

func (c ConfigStub) Get(host, key string) (string, error)

func (ConfigStub) GetWithSource

func (c ConfigStub) GetWithSource(host, key string) (string, string, error)

func (ConfigStub) Hosts

func (c ConfigStub) Hosts() ([]string, error)

func (ConfigStub) Set

func (c ConfigStub) Set(host, key, value string) error

func (ConfigStub) UnsetHost

func (c ConfigStub) UnsetHost(hostname string)

func (ConfigStub) Write

func (c ConfigStub) Write() error

type HostConfig

type HostConfig struct {
	ConfigMap
	Host string
}

type InvalidValueError

type InvalidValueError struct {
	ValidValues []string
}

func (InvalidValueError) Error

func (e InvalidValueError) Error() string

type NotFoundError

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