config

Documentation

Index

• Constants
• func ConfigPath() (string, error)
• func DefaultConfigDirectory() (string, error)
• func HelpTemplate() string
• type Config
  • func (c *Config) ContextListCompletion(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
  • func (c *Config) GetApiURL() string
  • func (c *Config) GetContexts() (*Contexts, error)
  • func (c *Config) GetProject() string
  • func (c *Config) GetTenant() (string, error)
  • func (c *Config) GetToken() string
  • func (c *Config) MustDefaultContext() Context
  • func (c *Config) NewRequestContext() (context.Context, context.CancelFunc)
  • func (c *Config) WriteContexts(ctxs *Contexts) error
• type Context
• type Contexts
  • func (cs *Contexts) Delete(name string)
  • func (cs *Contexts) Get(name string) (*Context, bool)
  • func (cs *Contexts) List() []*Context
  • func (cs *Contexts) Validate() error

Constants

const (
	// BinaryName is the name of the cli in all help texts
	BinaryName = "metal"
	// ConfigDir is the directory in either the homedir or in /etc where the cli searches for a file config.yaml
	// also used as prefix for environment based configuration, e.g. METAL_STACK_CLOUD_ will be the variable prefix.
	ConfigDir = "metal-stack-cloud"
)

Functions

func ConfigPath

func ConfigPath() (string, error)

func DefaultConfigDirectory

func DefaultConfigDirectory() (string, error)

func HelpTemplate

func HelpTemplate() string

Types

type Config

type Config struct {
	Fs              afero.Fs
	In              io.Reader
	Out             io.Writer
	PromptOut       io.Writer
	Client          client.Client
	ListPrinter     printers.Printer
	DescribePrinter printers.Printer
	Completion      *completion.Completion
	Context         Context
}

func (*Config) ContextListCompletion

func (c *Config) ContextListCompletion(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

func (*Config) GetApiURL

func (c *Config) GetApiURL() string

func (*Config) GetContexts

func (c *Config) GetContexts() (*Contexts, error)

func (*Config) GetProject

func (c *Config) GetProject() string

func (*Config) GetTenant

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

func (*Config) GetToken

func (c *Config) GetToken() string

func (*Config) MustDefaultContext

func (c *Config) MustDefaultContext() Context

func (*Config) NewRequestContext

func (c *Config) NewRequestContext() (context.Context, context.CancelFunc)

func (*Config) WriteContexts

func (c *Config) WriteContexts(ctxs *Contexts) error

type Context

type Context struct {
	Name           string         `json:"name"`
	ApiURL         *string        `json:"api-url,omitempty"`
	Token          string         `json:"api-token"`
	DefaultProject string         `json:"default-project"`
	Timeout        *time.Duration `json:"timeout,omitempty"`
}

Context configure

type Contexts

type Contexts struct {
	CurrentContext  string     `json:"current-context"`
	PreviousContext string     `json:"previous-context"`
	Contexts        []*Context `json:"contexts"`
}

Contexts contains all configuration contexts

func (*Contexts) Delete

func (cs *Contexts) Delete(name string)

func (*Contexts) Get

func (cs *Contexts) Get(name string) (*Context, bool)

func (*Contexts) List

func (cs *Contexts) List() []*Context

func (*Contexts) Validate

func (cs *Contexts) Validate() error