environment

Documentation

Index

• Constants
• Variables
• func Mirror() string
• func ParseCompVersion(spec string) (string, pkgver.Version)
• func SetGlobalEnv(env *Environment)
• type Environment
  • func GlobalEnv() *Environment
  • func InitEnv(options repository.Options) (*Environment, error)
  • func NewV0(profile *localdata.Profile, repo *repository.Repository) *Environment
  • func (env *Environment) BinaryPath(component string, ver pkgver.Version) (string, error)
  • func (env *Environment) Close() error
  • func (env *Environment) DownloadComponentIfMissing(component string, ver pkgver.Version) (pkgver.Version, error)
  • func (env *Environment) GetComponentInstalledVersion(component string, version pkgver.Version) (pkgver.Version, error)
  • func (env *Environment) IsSupportedComponent(component string) bool
  • func (env *Environment) LocalPath(path ...string) string
  • func (env *Environment) PlatformString() string
  • func (env *Environment) Profile() *localdata.Profile
  • func (env *Environment) Repository() *repository.Repository
  • func (env *Environment) SelectInstalledVersion(component string, ver pkgver.Version) (pkgver.Version, error)
  • func (env *Environment) SelfUpdate() error
  • func (env *Environment) SetProfile(p *localdata.Profile)
  • func (env *Environment) UpdateComponents(specs []string, nightly, force bool) error
  • func (env *Environment) V1Repository() *repository.V1Repository

Constants

const EnvNameV0 = "TIUP_USE_V0"

EnvNameV0 is the name of the env var used to direct TiUP to use old manifests.

const (
	TiUPName = "tiup"
)

Name of components

Variables

var (
	// ErrInstallFirst indicates that a component/version is not installed
	ErrInstallFirst = errors.New("component not installed")
)

Functions

func Mirror

func Mirror() string

Mirror return mirror of tiup. If it's not defined, it will use "https://tiup-mirrors.pingcap.com/".

func ParseCompVersion

func ParseCompVersion(spec string) (string, pkgver.Version)

ParseCompVersion parses component part from <component>[:version] specification

func SetGlobalEnv

func SetGlobalEnv(env *Environment)

SetGlobalEnv the global env used.

Types

type Environment

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

Environment is the user's fundamental configuration including local and remote parts.

func GlobalEnv

func GlobalEnv() *Environment

GlobalEnv Get the global env used.

func InitEnv

func InitEnv(options repository.Options) (*Environment, error)

InitEnv creates a new Environment object configured using env vars and defaults. Uses the EnvNameV0 env var to determine whether to use v0 or v1 manifests.

func NewV0

func NewV0(profile *localdata.Profile, repo *repository.Repository) *Environment

NewV0 creates a new Environment with the provided data. Note that environments created with this function do not support v1 repositories.

func (*Environment) BinaryPath

func (env *Environment) BinaryPath(component string, ver pkgver.Version) (string, error)

BinaryPath return the installed binary path.

func (*Environment) Close

func (env *Environment) Close() error

Close release resource of env.

func (*Environment) DownloadComponentIfMissing

func (env *Environment) DownloadComponentIfMissing(component string, ver pkgver.Version) (pkgver.Version, error)

DownloadComponentIfMissing downloads the specific version of a component if it is missing

func (*Environment) GetComponentInstalledVersion

func (env *Environment) GetComponentInstalledVersion(component string, version pkgver.Version) (pkgver.Version, error)

GetComponentInstalledVersion return the installed version of component.

func (*Environment) IsSupportedComponent

func (env *Environment) IsSupportedComponent(component string) bool

IsSupportedComponent return true if support if platform support the component.

func (*Environment) LocalPath

func (env *Environment) LocalPath(path ...string) string

LocalPath returns the local path absolute path

func (*Environment) PlatformString

func (env *Environment) PlatformString() string

PlatformString returns a string identifying the current system.

func (*Environment) Profile

func (env *Environment) Profile() *localdata.Profile

Profile returns the profile of local data

func (*Environment) Repository

func (env *Environment) Repository() *repository.Repository

Repository returns the initialized repository

func (*Environment) SelectInstalledVersion

func (env *Environment) SelectInstalledVersion(component string, ver pkgver.Version) (pkgver.Version, error)

SelectInstalledVersion selects the installed versions and the latest release version will be chosen if there is an empty version

func (*Environment) SelfUpdate

func (env *Environment) SelfUpdate() error

SelfUpdate updates TiUP.

func (*Environment) SetProfile

func (env *Environment) SetProfile(p *localdata.Profile)

SetProfile exports for test

func (*Environment) UpdateComponents

func (env *Environment) UpdateComponents(specs []string, nightly, force bool) error

UpdateComponents updates or installs all components described by specs.

func (*Environment) V1Repository

func (env *Environment) V1Repository() *repository.V1Repository

V1Repository returns the initialized v1 repository