config

Documentation

Index

• Variables
• func Auth() (*scalingo.User, string, error)
• func Display()
• func GetRegion(c Config, name string, opts GetRegionOpts) (scalingo.Region, error)
• func HomeDir() string
• func ScalingoAuthClient() (*scalingo.Client, error)
• func ScalingoAuthClientFromToken(token string) (*scalingo.Client, error)
• func ScalingoClient() (*scalingo.Client, error)
• func ScalingoClientForRegion(region string) (*scalingo.Client, error)
• func ScalingoClientFromToken(token string) (*scalingo.Client, error)
• func ScalingoUnauthenticatedAuthClient() (*scalingo.Client, error)
• func SetCurrentUser(user *scalingo.User, token string) error
• func SetRegion(regionName string) error
• type CliAuthenticator
  • func (a *CliAuthenticator) LoadAuth() (*scalingo.User, *auth.UserToken, error)
  • func (a *CliAuthenticator) RemoveAuth() error
  • func (a *CliAuthenticator) StoreAuth(user *scalingo.User, token string) error
• type ClientConfigOpts
• type Config
  • func (config Config) CurrentUser() (*scalingo.User, error)
• type ConfigFile
• type GetRegionOpts
• type RegionsCache
  • func EnsureRegionsCache(c Config, opts GetRegionOpts) (RegionsCache, error)

Variables

var (
	ErrAuthenticationFailed = errors.New("authentication failed")
)

var (
	ErrUnauthenticated = errgo.New("user unauthenticated")
)

var Version = "1.16.6"

Functions

func Auth

func Auth() (*scalingo.User, string, error)

func Display

func Display()

func GetRegion

func GetRegion(c Config, name string, opts GetRegionOpts) (scalingo.Region, error)

GetRegion returns the requested region configuration, use local file system cache if any. In case of cache fault, save on disk for 10 minutes the available regions

func HomeDir

func HomeDir() string

func ScalingoAuthClient

func ScalingoAuthClient() (*scalingo.Client, error)

func ScalingoAuthClientFromToken

func ScalingoAuthClientFromToken(token string) (*scalingo.Client, error)

func ScalingoClient

func ScalingoClient() (*scalingo.Client, error)

func ScalingoClientForRegion

func ScalingoClientForRegion(region string) (*scalingo.Client, error)

func ScalingoClientFromToken

func ScalingoClientFromToken(token string) (*scalingo.Client, error)

func ScalingoUnauthenticatedAuthClient

func ScalingoUnauthenticatedAuthClient() (*scalingo.Client, error)

func SetCurrentUser

func SetCurrentUser(user *scalingo.User, token string) error

func SetRegion

func SetRegion(regionName string) error

Types

type CliAuthenticator

type CliAuthenticator struct{}

func (*CliAuthenticator) LoadAuth

func (a *CliAuthenticator) LoadAuth() (*scalingo.User, *auth.UserToken, error)

func (*CliAuthenticator) RemoveAuth

func (a *CliAuthenticator) RemoveAuth() error

func (*CliAuthenticator) StoreAuth

func (a *CliAuthenticator) StoreAuth(user *scalingo.User, token string) error

type ClientConfigOpts

type ClientConfigOpts struct {
	Region   string
	APIToken string
	AuthOnly bool
}

type Config

type Config struct {
	ApiVersion           string
	DisableInteractive   bool
	DisableUpdateChecker bool
	UnsecureSsl          bool
	RollbarToken         string

	// Override region configuration
	ScalingoApiUrl  string
	ScalingoAuthUrl string
	ScalingoDbUrl   string
	ScalingoRegion  string
	ScalingoSshHost string

	// Configuration files
	ConfigDir      string
	AuthFile       string
	LogFile        string
	ConfigFilePath string
	ConfigFile     ConfigFile

	// Cache related files
	CacheDir         string
	RegionsCachePath string

	Logger *log.Logger
	// contains filtered or unexported fields
}

var (
	C         Config
	TlsConfig *tls.Config
)

func (Config) CurrentUser

func (config Config) CurrentUser() (*scalingo.User, error)

type ConfigFile

type ConfigFile struct {
	Region string `json:"region"`
}

type GetRegionOpts

type GetRegionOpts struct {
	Token string
}

GetRegionOpts allows the caller to use a custom API token instead of the default one of the authentication used

type RegionsCache

type RegionsCache struct {
	ExpireAt time.Time         `json:"expire_at"`
	Regions  []scalingo.Region `json:"regions"`
}

func EnsureRegionsCache

func EnsureRegionsCache(c Config, opts GetRegionOpts) (RegionsCache, error)