checker

type Chore ¶ added in v0.35.2

type Chore struct {
	Loop *sync2.Cycle
	// contains filtered or unexported fields
}

Chore contains the information and variables to ensure the Software is up to date.

func NewChore(service *Service, checkInterval time.Duration) *Chore

func (chore *Chore) Run(ctx context.Context) (err error)

type Client ¶

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

Client defines helper methods for using version control server response data.

architecture: Client

func New(config ClientConfig) *Client

func (client *Client) All(ctx context.Context) (ver version.AllowedVersions, err error)

func (client *Client) OldMinimum(ctx context.Context, serviceName string) (ver version.OldSemVer, err error)

func (client *Client) Process(ctx context.Context, processName string) (process version.Process, err error)

type ClientConfig ¶

type ClientConfig struct {
	ServerAddress  string        `help:"server address to check its version against" default:"https://version.storj.io"`
	RequestTimeout time.Duration `help:"Request timeout for version checks" default:"0h1m0s"`
}

ClientConfig is the config struct for the version control client.

type Config ¶

type Config struct {
	ClientConfig

	CheckInterval time.Duration `help:"Interval to check the version" default:"0h15m0s"`
}

Config contains the necessary Information to check the Software Version.

type Service ¶

type Service struct {
	Info version.Info
	// contains filtered or unexported fields
}

Service contains the information and variables to ensure the Software is up to date.

architecture: Service

func NewService(log *zap.Logger, config Config, info version.Info, service string) (client *Service)

func (service *Service) CheckVersion(ctx context.Context) (latest version.SemVer, err error)

func (service *Service) Checked() bool

func (service *Service) GetCursor(ctx context.Context) (_ version.RolloutBytes, err error)

func (service *Service) IsAllowed(ctx context.Context) (version.SemVer, bool)

func (service *Service) SetAcceptedVersion(version version.SemVer)