version

Documentation

Index

• Constants
• Variables
• func IsVersionUnreleased() bool
• type Alert
• type AuditChecker
  • func NewAuditChecker(checkURL, version, installationID string, latestReleases VersionSource) *AuditChecker
  • func NewDefaultAuditChecker(checkURL, installationID string, latestReleases VersionSource) *AuditChecker
  • func (a *AuditChecker) Check(ctx context.Context) (*AuditResponse, error)
  • func (a *AuditChecker) CheckAndLog(ctx context.Context, log logging.Logger)
  • func (a *AuditChecker) CheckLatestVersion() (*LatestVersionResponse, error)
  • func (a *AuditChecker) Close()
  • func (a *AuditChecker) LastCheck() (*AuditResponse, error)
  • func (a *AuditChecker) StartPeriodicCheck(ctx context.Context, interval time.Duration, log logging.Logger) bool
  • func (a *AuditChecker) StopPeriodicCheck()
• type AuditResponse
  • func (a *AuditResponse) UpgradeRecommendedURL() string
• type CachedVersionSource
  • func NewCachedSource(src VersionSource, cachePeriod time.Duration) *CachedVersionSource
  • func (cs *CachedVersionSource) FetchLatestVersion() (string, error)
• type GithubReleases
  • func NewGithubReleases(owner, repository string) *GithubReleases
  • func (gh *GithubReleases) FetchLatestVersion() (string, error)
• type LatestVersionResponse
  • func CheckLatestVersion(targetVersion string) (*LatestVersionResponse, error)
• type VersionSource
  • func NewDefaultVersionSource(cachePeriod time.Duration) VersionSource

Constants

const (

	// releases URL
	DefaultReleasesURL = "https://github.com/treeverse/lakeFS/releases"
	GithubRepoOwner    = "treeverse"
	GithubRepoName     = "lakeFS"
)

Variables

var (
	ErrAuditCheckFailed = errors.New("audit check request failed")
	ErrMissingCheckURL  = errors.New("missing audit check URL")
)

var (
	ErrInvalidConfig = errors.New("invalid configuration for version source")
	ErrHTTPStatus    = errors.New("unexpected HTTP status code")
)

var (
	UnreleasedVersion = "dev"
	// Version is the current git version of the code.  It is filled in by "make build".
	// Make sure to change that target in Makefile if you change its name or package.
	Version = "dev"
)

Functions

func IsVersionUnreleased

func IsVersionUnreleased() bool

Types

type Alert

type Alert struct {
	ID               string `json:"id"`
	AffectedVersions string `json:"affected_versions"`
	PatchedVersions  string `json:"patched_versions"`
	Description      string `json:"description"`
}

type AuditChecker

type AuditChecker struct {
	CheckURL       string
	Client         http.Client
	Version        string
	InstallationID string
	// contains filtered or unexported fields
}

func NewAuditChecker

func NewAuditChecker(checkURL, version, installationID string, latestReleases VersionSource) *AuditChecker

func NewDefaultAuditChecker

func NewDefaultAuditChecker(checkURL, installationID string, latestReleases VersionSource) *AuditChecker

func (*AuditChecker) Check

func (a *AuditChecker) Check(ctx context.Context) (*AuditResponse, error)

func (*AuditChecker) CheckAndLog

func (a *AuditChecker) CheckAndLog(ctx context.Context, log logging.Logger)

CheckAndLog performs an audit check, logs and keeps the last response

func (*AuditChecker) CheckLatestVersion

func (a *AuditChecker) CheckLatestVersion() (*LatestVersionResponse, error)

CheckLatestVersion will return the latest version of the current package compared to the current version

func (*AuditChecker) Close

func (a *AuditChecker) Close()

Close release resources used by audit checker - ex: periodic check

func (*AuditChecker) LastCheck

func (a *AuditChecker) LastCheck() (*AuditResponse, error)

func (*AuditChecker) StartPeriodicCheck

func (a *AuditChecker) StartPeriodicCheck(ctx context.Context, interval time.Duration, log logging.Logger) bool

StartPeriodicCheck performs one check and continues every 'interval' in the background check results will be found in the log and updated for 'LastCheck' Return false if periodic check already ran

func (*AuditChecker) StopPeriodicCheck

func (a *AuditChecker) StopPeriodicCheck()

type AuditResponse

type AuditResponse struct {
	UpgradeURL string  `json:"upgrade_url,omitempty"`
	Alerts     []Alert `json:"alerts"`
}

func (*AuditResponse) UpgradeRecommendedURL

func (a *AuditResponse) UpgradeRecommendedURL() string

type CachedVersionSource

type CachedVersionSource struct {
	Source VersionSource
	// contains filtered or unexported fields
}

func NewCachedSource

func NewCachedSource(src VersionSource, cachePeriod time.Duration) *CachedVersionSource

func (*CachedVersionSource) FetchLatestVersion

func (cs *CachedVersionSource) FetchLatestVersion() (string, error)

type GithubReleases

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

func NewGithubReleases

func NewGithubReleases(owner, repository string) *GithubReleases

func (*GithubReleases) FetchLatestVersion

func (gh *GithubReleases) FetchLatestVersion() (string, error)

type LatestVersionResponse

type LatestVersionResponse struct {
	CheckTime      time.Time `json:"check_time"`
	Outdated       bool      `json:"outdated"`
	LatestVersion  string    `json:"latest_version"`
	CurrentVersion string    `json:"current_version"`
}

func CheckLatestVersion

func CheckLatestVersion(targetVersion string) (*LatestVersionResponse, error)

type VersionSource

type VersionSource interface {
	FetchLatestVersion() (string, error)
}

func NewDefaultVersionSource

func NewDefaultVersionSource(cachePeriod time.Duration) VersionSource