config

package

v0.0.0-...-22a1e08 Latest Latest Go to latest Published: Apr 9, 2024 License: BSD-3-Clause Imports: 16 Imported by: 7

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tsuru/go-tsuruclient

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CheckIfTargetLabelExists(label string) (bool, error)
func Filesystem() fs.Fs
func GetTarget() (string, error)
func GetTargetLabel() (string, error)
func GetURL(path string) (string, error)
func GetURLVersion(version, path string) (string, error)
func JoinWithUserDir(p ...string) string
func MergeFlagSet(fs1, fs2 *gnuflag.FlagSet) *gnuflag.FlagSet
func ReadTarget() (string, error)
func ReadTeamToken() string
func ReadTokenV1() (string, error)
func RemoveTokenV1() error
func RemoveTokenV2() error
func ResetFileSystem()
func SaveChangesNoPrint() error
func SaveChangesWithTimeout()
func SetFileSystem(f fs.Fs)
func WriteOnTargetList(label, target string) error
func WriteTarget(t string) error
func WriteTokenV1(token string) error
func WriteTokenV2(token TokenV2) error
type ClientSelfUpdater
type ConfigType
- func GetConfig() *ConfigType
type TargetAdd
- func (t *TargetAdd) Flags() *gnuflag.FlagSet
- func (t *TargetAdd) Info() *cmd.Info
- func (t *TargetAdd) Run(ctx *cmd.Context) error
type TargetList
- func (t *TargetList) Info() *cmd.Info
- func (t *TargetList) Run(ctx *cmd.Context) error
type TargetRemove
- func (t *TargetRemove) Info() *cmd.Info
- func (t *TargetRemove) Run(ctx *cmd.Context) error
type TargetSet
- func (t *TargetSet) Info() *cmd.Info
- func (t *TargetSet) Run(ctx *cmd.Context) error
type TokenProvider
- func TokenProviderV1() TokenProvider
type TokenV2
- func ReadTokenV2() (*TokenV2, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	SchemaVersion string = "0.1"
)

Functions ¶

func CheckIfTargetLabelExists ¶

func CheckIfTargetLabelExists(label string) (bool, error)

func Filesystem ¶

func Filesystem() fs.Fs

func GetTarget ¶

func GetTarget() (string, error)

func GetTargetLabel ¶

func GetTargetLabel() (string, error)

func GetURL ¶

func GetURL(path string) (string, error)

func GetURLVersion ¶

func GetURLVersion(version, path string) (string, error)

func JoinWithUserDir ¶

func JoinWithUserDir(p ...string) string

func MergeFlagSet ¶

func MergeFlagSet(fs1, fs2 *gnuflag.FlagSet) *gnuflag.FlagSet

func ReadTarget ¶

func ReadTarget() (string, error)

ReadTarget returns the current target, as defined in the TSURU_TARGET environment variable or in the target file.

func ReadTeamToken ¶

func ReadTeamToken() string

func ReadTokenV1 ¶

func ReadTokenV1() (string, error)

func RemoveTokenV1 ¶

func RemoveTokenV1() error

func RemoveTokenV2 ¶

func RemoveTokenV2() error

func ResetFileSystem ¶

func ResetFileSystem()

func SaveChangesNoPrint ¶

func SaveChangesNoPrint() error

func SaveChangesWithTimeout ¶

func SaveChangesWithTimeout()

SaveChangesWithTimeout will try to save changes on ~/.tsuru/config.json and it will timeout after 1s (default). Timeout is overridden from env TSURU_CLIENT_LOCAL_TIMEOUT

func SetFileSystem ¶

func SetFileSystem(f fs.Fs)

func WriteOnTargetList ¶

func WriteOnTargetList(label, target string) error

WriteOnTargetList writes the given target in the target list file.

func WriteTarget ¶

func WriteTarget(t string) error

WriteTarget writes the given endpoint to the target file.

func WriteTokenV1 ¶

func WriteTokenV1(token string) error

func WriteTokenV2 ¶

func WriteTokenV2(token TokenV2) error

Types ¶

type ClientSelfUpdater ¶

type ClientSelfUpdater struct {
	LatestManifestURL string
	LastCheck         time.Time
}

ClientSelfUpdater saves configuration regarding self updating the client

type ConfigType ¶

type ConfigType struct {
	SchemaVersion string
	LastUpdate    time.Time

	// ---- public confs ----
	ClientSelfUpdater ClientSelfUpdater
	// contains filtered or unexported fields
}

ConfigType is the main config, serialized to ~/.tsuru/config.json

func GetConfig ¶

func GetConfig() *ConfigType

GetConfig() returns a *ConfigType singleton.

type TargetAdd ¶

type TargetAdd struct {
	// contains filtered or unexported fields
}

func (*TargetAdd) Flags ¶

func (t *TargetAdd) Flags() *gnuflag.FlagSet

func (*TargetAdd) Info ¶

func (t *TargetAdd) Info() *cmd.Info

func (*TargetAdd) Run ¶

func (t *TargetAdd) Run(ctx *cmd.Context) error

type TargetList ¶

type TargetList struct{}

func (*TargetList) Info ¶

func (t *TargetList) Info() *cmd.Info

func (*TargetList) Run ¶

func (t *TargetList) Run(ctx *cmd.Context) error

type TargetRemove ¶

type TargetRemove struct{}

func (*TargetRemove) Info ¶

func (t *TargetRemove) Info() *cmd.Info

func (*TargetRemove) Run ¶

func (t *TargetRemove) Run(ctx *cmd.Context) error

type TargetSet ¶

type TargetSet struct{}

func (*TargetSet) Info ¶

func (t *TargetSet) Info() *cmd.Info

func (*TargetSet) Run ¶

func (t *TargetSet) Run(ctx *cmd.Context) error

type TokenProvider ¶

type TokenProvider interface {
	// Token returns the content of header authorization, useful to propagate token to third parties such as plugins and websocket
	Token() (string, error)
}

var DefaultTokenProvider TokenProvider = TokenProviderV1()

func TokenProviderV1 ¶

func TokenProviderV1() TokenProvider

type TokenV2 ¶

type TokenV2 struct {
	Scheme       string         `json:"scheme"`
	OAuth2Token  *oauth2.Token  `json:"oauth2_token,omitempty"`
	OAuth2Config *oauth2.Config `json:"oauth2_config,omitempty"`
}

func ReadTokenV2 ¶

func ReadTokenV2() (*TokenV2, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL