flyctl

Documentation

Index

• Constants
• Variables
• func CheckForUpdate(noskip bool, silent bool) string
• func ConfigDir() string
• func ConfigFileExistsAtPath(p string) (bool, error)
• func GetAPIToken() string
• func InitConfig()
• func ResolveConfigFileFromPath(p string) (string, error)
• func SaveConfig() error
• type AppConfig
  • func LoadAppConfig(configFile string) (*AppConfig, error)
  • func NewAppConfig() *AppConfig
  • func (ac *AppConfig) GetInternalPort() (int, error)
  • func (ac *AppConfig) HasBuilder() bool
  • func (ac *AppConfig) HasBuiltin() bool
  • func (ac *AppConfig) HasDefinition() bool
  • func (ac *AppConfig) SetInternalPort(port int) bool
  • func (ac *AppConfig) WriteTo(w io.Writer, format ConfigFormat) error
  • func (ac *AppConfig) WriteToFile(filename string) error
• type Build
• type Config
  • func ConfigNS(ns string) Config
• type ConfigFormat
  • func ConfigFormatFromPath(p string) ConfigFormat

Constants

const (
	ConfigAPIToken        = "access_token"
	ConfigAPIBaseURL      = "api_base_url"
	ConfigAppName         = "app"
	ConfigVerboseOutput   = "verbose"
	ConfigJSONOutput      = "json"
	ConfigBuiltinsfile    = "builtins_file"
	ConfigGQLErrorLogging = "gqlerrorlogging"
	ConfigInstaller       = "installer"

	ConfigRegistryHost             = "registry_host"
	ConfigUpdateCheck              = "update_check"
	ConfigUpdateCheckLatestVersion = ConfigUpdateCheck + ".latest_version"
	ConfigUpdateCheckTimestamp     = ConfigUpdateCheck + ".timestamp"
	ConfigUpdateCheckOptOut        = ConfigUpdateCheck + ".opt_out"
)

const NSRoot = "flyctl"

Variables

var BackgroundTaskWG = &sync.WaitGroup{}

var BuildDate = time.Now().String()

var Commit = "<commit>"

var Environment = "development"

var Version = "<version>"

Functions

func CheckForUpdate

func CheckForUpdate(noskip bool, silent bool) string

CheckForUpdate - Test for available updates and emit a message if one is available

func ConfigDir

func ConfigDir() string

ConfigDir - Returns Directory holding the Config file

func ConfigFileExistsAtPath

func ConfigFileExistsAtPath(p string) (bool, error)

func GetAPIToken

func GetAPIToken() string

GetAPIToken - returns the current API Token, env vars take precedence. Avoids pulling in env vars into the config.

func InitConfig

func InitConfig()

InitConfig - Initialises config file for Viper

func ResolveConfigFileFromPath

func ResolveConfigFileFromPath(p string) (string, error)

func SaveConfig

func SaveConfig() error

Types

type AppConfig

type AppConfig struct {
	AppName string
	Build   *Build

	Definition map[string]interface{}
}

func LoadAppConfig

func LoadAppConfig(configFile string) (*AppConfig, error)

func NewAppConfig

func NewAppConfig() *AppConfig

func (*AppConfig) GetInternalPort

func (ac *AppConfig) GetInternalPort() (int, error)

func (*AppConfig) HasBuilder

func (ac *AppConfig) HasBuilder() bool

func (*AppConfig) HasBuiltin

func (ac *AppConfig) HasBuiltin() bool

func (*AppConfig) HasDefinition

func (ac *AppConfig) HasDefinition() bool

func (*AppConfig) SetInternalPort

func (ac *AppConfig) SetInternalPort(port int) bool

func (*AppConfig) WriteTo

func (ac *AppConfig) WriteTo(w io.Writer, format ConfigFormat) error

func (*AppConfig) WriteToFile

func (ac *AppConfig) WriteToFile(filename string) error

type Build

type Build struct {
	Builder    string
	Args       map[string]string
	Buildpacks []string
	// Or...
	Builtin  string
	Settings map[string]interface{}
	// Or...
	Image string
}

type Config

type Config interface {
	GetString(key string) (string, error)
	GetBool(key string) bool
	GetStringSlice(key string) []string
	GetInt(key string) int
	IsSet(key string) bool
}

var FlyConfig Config = ConfigNS(NSRoot)

func ConfigNS

func ConfigNS(ns string) Config

type ConfigFormat

type ConfigFormat string

const (
	TOMLFormat        ConfigFormat = ".toml"
	UnsupportedFormat              = ""
)

func ConfigFormatFromPath

func ConfigFormatFromPath(p string) ConfigFormat