config

Documentation

Index

• Variables
• func CreateConfig(v *viper.Viper, path, file string) error
• func CreateProjectConfig(projectPath string)
• func InitConfig(fs afero.Fs)
• func IsProjectDir(path string) (bool, error)
• func PrintCurrentContext(out io.Writer) error
• func ProjectConfigExists() bool
• func ProjectRoot() (string, error)
• type Context
  • func GetCurrentContext() (Context, error)
  • func (c Context) ContextExists() bool
  • func (c Context) GetAPIURL() string
  • func (c Context) GetAppURL() string
  • func (c Context) GetContext() (Context, error)
  • func (c Context) GetContextKey() (string, error)
  • func (c Context) GetWebsocketURL() string
  • func (c Context) PrintContext(out io.Writer) error
  • func (c Context) SetContext() error
  • func (c Context) SetContextKey(key, value string) error
  • func (c Context) SwitchContext() error
• type Contexts
  • func (c Contexts) GetContexts() (Contexts, error)

Variables

var (
	// ConfigFileName is the name of the config files (home / project)
	ConfigFileName = "config"
	// ConfigFileType is the config file extension
	ConfigFileType = "yaml"
	// ConfigFileNameWithExt is the config filename with extension
	ConfigFileNameWithExt = fmt.Sprintf("%s.%s", ConfigFileName, ConfigFileType)
	// ConfigDir is the directory for astro files
	ConfigDir = ".astro"

	// HomePath is the path to a users home directory
	HomePath, _ = fileutil.GetHomeDir()
	// HomeConfigPath is the path to the users global config directory
	HomeConfigPath = filepath.Join(HomePath, ConfigDir)
	// HomeConfigFile is the global config file
	HomeConfigFile = filepath.Join(HomeConfigPath, ConfigFileNameWithExt)

	// WorkingPath is the path to the working directory
	WorkingPath, _ = fileutil.GetWorkingDir()

	// CFGStrMap maintains string to cfg mapping
	CFGStrMap = make(map[string]cfg)

	// CFG Houses configuration meta
	CFG = cfgs{
		CloudAPIProtocol:  newCfg("cloud.api.protocol", "https"),
		CloudAPIPort:      newCfg("cloud.api.port", "443"),
		CloudWSProtocol:   newCfg("cloud.api.ws_protocol", "wss"),
		CloudAPIToken:     newCfg("cloud.api.token", ""),
		Context:           newCfg("context", ""),
		Contexts:          newCfg("contexts", ""),
		LocalHouston:      newCfg("local.houston", ""),
		LocalOrbit:        newCfg("local.orbit", ""),
		PostgresUser:      newCfg("postgres.user", "postgres"),
		PostgresPassword:  newCfg("postgres.password", "postgres"),
		PostgresHost:      newCfg("postgres.host", "postgres"),
		PostgresPort:      newCfg("postgres.port", "5432"),
		ProjectDeployment: newCfg("project.deployment", ""),
		ProjectName:       newCfg("project.name", ""),
		ProjectWorkspace:  newCfg("project.workspace", ""),
		WebserverPort:     newCfg("webserver.port", "8080"),
		ShowWarnings:      newCfg("show_warnings", "true"),
	}
)

Functions

func CreateConfig

func CreateConfig(v *viper.Viper, path, file string) error

CreateConfig creates a config file in the given directory

func CreateProjectConfig

func CreateProjectConfig(projectPath string)

CreateProjectConfig creates a project config file

func InitConfig

func InitConfig(fs afero.Fs)

InitConfig initializes the config files

func IsProjectDir

func IsProjectDir(path string) (bool, error)

IsProjectDir returns a boolean depending on if path is a valid project dir

func PrintCurrentContext

func PrintCurrentContext(out io.Writer) error

PrintCurrentContext prints the current config context

func ProjectConfigExists

func ProjectConfigExists() bool

ProjectConfigExists returns a boolean indicating if a project config file exists

func ProjectRoot

func ProjectRoot() (string, error)

ProjectRoot returns the path to the nearest project root TODO Deprecate if remains unused, removed due to https://github.com/astronomer/astro-cli/issues/103

Types

type Context

type Context struct {
	Domain            string `mapstructure:"domain"`
	Workspace         string `mapstructure:"workspace"`
	LastUsedWorkspace string `mapstructure:"last_used_workspace"`
	Token             string `mapstructure:"token"`
}

Context represents a single cluster context

func GetCurrentContext

func GetCurrentContext() (Context, error)

GetCurrentContext looks up current context and gets corresponding Context struct

func (Context) ContextExists

func (c Context) ContextExists() bool

ContextExists checks if a cluster struct exists in config based on Cluster.Domain Returns a boolean indicating whether or not cluster exists

func (Context) GetAPIURL

func (c Context) GetAPIURL() string

GetAPIURL returns full Houston API Url for the provided Context

func (Context) GetAppURL

func (c Context) GetAppURL() string

GetAppURL returns full Houston API Url for the provided Context

func (Context) GetContext

func (c Context) GetContext() (Context, error)

GetContext gets the full context from the specified Context receiver struct Returns based on Domain prop

func (Context) GetContextKey

func (c Context) GetContextKey() (string, error)

GetContextKey allows a cluster domain to be used without interfering with viper's dot (.) notation for fetching configs by replacing with underscores (_)

func (Context) GetWebsocketURL

func (c Context) GetWebsocketURL() string

GetWebsocketURL returns full Houston websocket Url for the provided Context

func (Context) PrintContext

func (c Context) PrintContext(out io.Writer) error

PrintContext prints current context to stdOut

func (Context) SetContext

func (c Context) SetContext() error

SetContext saves Context to the config

func (Context) SetContextKey

func (c Context) SetContextKey(key, value string) error

SetContextKey saves a single context key value pair

func (Context) SwitchContext

func (c Context) SwitchContext() error

SwitchContext sets the current config context to the one matching the provided Context struct

type Contexts

type Contexts struct {
	Contexts map[string]Context `mapstructure:"contexts"`
}

Contexts holds all available Context structs in a map

func (Contexts) GetContexts

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

GetContexts gets all contexts currently configured in the global config Returns a Contexts struct containing a map of all Context structs