config

Documentation

Overview

Package config implements the config file logic.

Index

• Constants
• Variables
• type Auth
• type Config
  • func Current() (*Config, error)
  • func Init(path string, create bool) (*Config, error)
  • func (c *Config) GetContext(name string) (*Context, error)
  • func (c *Config) Merge(additionalConfigPath string) ([]Rename, error)
  • func (c *Config) Save() error
• type Context
• type Rename
  • func (r *Rename) String() string
• type SideroV1

Constants

const (
	// OmniConfigEnvVar is the environment variable to override the default config path.
	OmniConfigEnvVar = "OMNICONFIG"
)

const PlaceholderURL = "<placeholder_url>"

PlaceholderURL is a placeholder url.

Variables

var (
	// DefaultContext is the context with the default values.
	DefaultContext = Context{
		URL: "grpc://127.0.0.1:8080",
	}
)

Types

type Auth

type Auth struct {
	// Deprecated: basic auth is not supported, and setting this field has no effect.
	Basic    string   `yaml:"basic,omitempty"`
	SideroV1 SideroV1 `yaml:"siderov1,omitempty"`
}

Auth contains the authentication configuration for a context.

type Config

type Config struct {
	Contexts map[string]*Context `yaml:"contexts"`
	Context  string              `yaml:"context"`
	Path     string              `yaml:"-"`
}

Config represents the omni configuration.

func Current

func Current() (*Config, error)

Current returns the currently targeted config.

func Init

func Init(path string, create bool) (*Config, error)

Init initializes the Current config and returns it.

func (*Config) GetContext

func (c *Config) GetContext(name string) (*Context, error)

GetContext returns the context with the given name. If empty, it will return the selected context in the config file.

func (*Config) Merge

func (c *Config) Merge(additionalConfigPath string) ([]Rename, error)

Merge in additional contexts from another Config.

Current context is overridden from passed in config.

func (*Config) Save

func (c *Config) Save() error

Save saves the config to the path it is configured to, or defaults to the known default config paths. It modifies the Path to point to the saved file.

type Context

type Context struct {
	URL  string `yaml:"url"`
	Auth Auth   `yaml:"auth,omitempty"`
}

Context represents a context in the config.

type Rename

type Rename struct {
	From string
	To   string
}

Rename describes context rename during merge.

func (*Rename) String

func (r *Rename) String() string

String converts to "from" -> "to".

type SideroV1

type SideroV1 struct {
	Identity string `yaml:"identity,omitempty"`
}

SideroV1 is the auth configuration v1.