version

Documentation

Index

• func NewVersionNotification(timesSent notifications.TimesNotified, suggestedVersion version.SemVer, ...) (_ notifications.NewNotification)
• type Chore
  • func NewChore(log *zap.Logger, service *checker.Service, ...) *Chore
  • func (chore *Chore) Run(ctx context.Context) (err error)
  • func (chore *Chore) RunOnce(ctx context.Context) (err error)
  • func (chore *Chore) TestCheckVersion() (relevance Relevance)
  • func (chore *Chore) TestSetNow(now func() time.Time)
• type Config
• type Mode
  • func ParseCheckerMode(s string) (Mode, error)
  • func (m *Mode) Disabled() bool
  • func (m *Mode) Once() bool
  • func (m *Mode) Periodic() bool
  • func (m *Mode) Set(s string) error
  • func (m *Mode) String() string
  • func (m *Mode) Type() string
• type Relevance

Functions

func NewVersionNotification

func NewVersionNotification(timesSent notifications.TimesNotified, suggestedVersion version.SemVer, senderID storj.NodeID) (_ notifications.NewNotification)

NewVersionNotification - returns version update required notification.

Types

type Chore

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 for storagenode.

func NewChore

func NewChore(log *zap.Logger, service *checker.Service, notifications *notifications.Service, nodeID storj.NodeID, checkInterval time.Duration) *Chore

NewChore creates a Version Check Client with default configuration for storagenode.

func (*Chore) Run

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

Run logs the current version information and detects if software outdated, if so - sends notifications.

func (*Chore) RunOnce

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

RunOnce is like Run but only runs once.

func (*Chore) TestCheckVersion

func (chore *Chore) TestCheckVersion() (relevance Relevance)

TestCheckVersion returns chore.relevance, used for chore tests only.

func (*Chore) TestSetNow

func (chore *Chore) TestSetNow(now func() time.Time)

TestSetNow allows tests to have the Service act as if the current time is whatever they want. This avoids races and sleeping, making tests more reliable and efficient.

type Config

type Config struct {
	checker.Config

	RunMode Mode `help:"Define the run mode for the version checker. Options (once,periodic,disable)" default:"periodic"`
}

Config is the config for the Storagenode Version Checker.

type Mode

type Mode string

Mode is the mode to run the version checker in.

func ParseCheckerMode

func ParseCheckerMode(s string) (Mode, error)

ParseCheckerMode parses the string representation of the CheckerMode.

func (*Mode) Disabled

func (m *Mode) Disabled() bool

Disabled returns true if the checker is disabled.

func (*Mode) Once

func (m *Mode) Once() bool

Once returns true if the checker is once.

func (*Mode) Periodic

func (m *Mode) Periodic() bool

Periodic returns true if the checker is periodic.

func (*Mode) Set

func (m *Mode) Set(s string) error

Set implements pflag.Value.

func (*Mode) String

func (m *Mode) String() string

String implements pflag.Value.

func (*Mode) Type

func (m *Mode) Type() string

Type implements pflag.Value.

type Relevance

type Relevance struct {
	ExpectedVersion  version.SemVer
	IsOutdated       bool
	FirstTimeSpotted time.Time
	TimesNotified    notifications.TimesNotified
}

Relevance contains information about software being outdated.