version

Documentation

Index

• Variables
• func CheckForUpdatesInBackground(currentVersion string, homebrewFormula string)
• func ClearUpdateCache()
• func PerformUpgrade() error
• func Print()
• func PrintIfUpgradeAvailable()
• func Refresh()
• func SaveUpdateCache(currentVersion string, updateInfo *UpdateInfo)
• func SetDebugMode(debug bool)
• func SetUpdateInfo(updateInfo *UpdateInfo)
• func VerifyCanUpgrade() error
• func Version() string
• type Build
  • func GetBuild() Build
• type ClientVersions
• type Option
• type PingResponse
• type UpdateCache
  • func LoadUpdateCache() (*UpdateCache, error)
• type UpdateChecker
  • func NewUpdateChecker(version string, homebrewFormula string) (*UpdateChecker, error)
  • func (s UpdateChecker) CanSupportUpgrade() (bool, error)
  • func (s UpdateChecker) ExternalUpgradeCommand() string
  • func (s UpdateChecker) GetUpdateInfo() (*UpdateInfo, error)
  • func (s UpdateChecker) Upgrade() error
• type UpdateInfo
  • func UpdateInfoFromVersions(currentVersion string, latestVersion *VersionInfo) (*UpdateInfo, error)
• type VersionInfo

Variables

var (
	ErrUnknownArchiveType        = errors.New("unknown archive type")
	ErrNoMatchingArchitectures   = errors.New("no matching architectures")
	ErrNoAssets                  = errors.New("no assets")
	ErrChecksumMismatch          = errors.New("checksum mismatch")
	ErrUnsupportedChecksumFormat = errors.New("unsupported checksum format")
)

var (
	ErrReleaseNotFound = errors.New("release not found")
)

var RunAt time.Time

var RunAtEpoch string

Functions

func CheckForUpdatesInBackground

func CheckForUpdatesInBackground(currentVersion string, homebrewFormula string)

CheckForUpdatesInBackground starts a goroutine to check for updates and save the results to the cache file. It never blocks and silently handles all errors.

func ClearUpdateCache

func ClearUpdateCache()

ClearUpdateCache removes the update cache file Silently fails - no errors are returned

func PerformUpgrade

func PerformUpgrade() error

func Print

func Print()

func PrintIfUpgradeAvailable

func PrintIfUpgradeAvailable()

PrintToStdErrIfUpgradeAvailable prints the update info to stderr if available

func Refresh

func Refresh()

func SaveUpdateCache

func SaveUpdateCache(currentVersion string, updateInfo *UpdateInfo)

SaveUpdateCache saves the update information to the cache file Silently fails - no errors are returned

func SetDebugMode

func SetDebugMode(debug bool)

SetDebugMode enables or disables debug mode

func SetUpdateInfo

func SetUpdateInfo(updateInfo *UpdateInfo)

SetUpdateInfo updates the current build's update info

func VerifyCanUpgrade

func VerifyCanUpgrade() error

func Version

func Version() string

Types

type Build

type Build struct {
	Version    string      `json:"version,omitempty"`
	UpdateInfo *UpdateInfo `json:"updateInfo,omitempty"`
}

Build holds details about this build of the replicated cli binary

func GetBuild

func GetBuild() Build

type ClientVersions

type ClientVersions struct {
	ReplicatedCLI string `json:"replicated_cli"`
	ReplicatedSDK string `json:"replicated_sdk"`
	KOTS          string `json:"kots"`
}

type Option

type Option func(*UpdateChecker) error

type PingResponse

type PingResponse struct {
	ClientIP       string         `json:"client_ip"`
	ClientVersions ClientVersions `json:"client_versions"`
}

type UpdateCache

type UpdateCache struct {
	Version       string     `json:"cachedVersion"`
	UpdateInfo    UpdateInfo `json:"updateCheckerInfo"`
	LastCheckedAt time.Time  `json:"lastCheckedAt"`
}

UpdateCache represents the cached update information

func LoadUpdateCache

func LoadUpdateCache() (*UpdateCache, error)

LoadUpdateCache loads the update information from the cache file Returns nil without error if the cache doesn't exist or is invalid

type UpdateChecker

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

func NewUpdateChecker

func NewUpdateChecker(version string, homebrewFormula string) (*UpdateChecker, error)

func (UpdateChecker) CanSupportUpgrade

func (s UpdateChecker) CanSupportUpgrade() (bool, error)

func (UpdateChecker) ExternalUpgradeCommand

func (s UpdateChecker) ExternalUpgradeCommand() string

func (UpdateChecker) GetUpdateInfo

func (s UpdateChecker) GetUpdateInfo() (*UpdateInfo, error)

GetUpdateInfo will return the latest version

func (UpdateChecker) Upgrade

func (s UpdateChecker) Upgrade() error

type UpdateInfo

type UpdateInfo struct {
	LatestVersion   string     `json:"latestVersion"`
	LatestReleaseAt *time.Time `json:"latestReleaseAt"`

	CheckedAt *time.Time `json:"checkedAt"`

	CanUpgradeInPlace      bool   `json:"canUpgradeInPlace"`
	ExternalUpgradeCommand string `json:"externalUpgradeCommand"`
}

func UpdateInfoFromVersions

func UpdateInfoFromVersions(currentVersion string, latestVersion *VersionInfo) (*UpdateInfo, error)

type VersionInfo

type VersionInfo struct {
	Version string `json:"version"`
}