checker

Documentation

Index

• Variables
• func CheckProcessVersion(ctx context.Context, log *zap.Logger, config Config, info version.Info, ...) (err error)
• type 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 Config
• type DebugHandler
  • func NewDebugHandler(log *zap.Logger) *DebugHandler
  • func (server *DebugHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Service
  • func NewService(log *zap.Logger, config Config, info version.Info, service string) (client *Service)
  • func (srv *Service) CheckVersion(ctx context.Context) (err error)
  • func (srv *Service) IsAllowed(ctx context.Context) (version.SemVer, bool)
  • func (srv *Service) Run(ctx context.Context) (err error)

Variables

var (

	// Error is the error class for version control client errors.
	Error = errs.Class("version control client error")
)

Functions

func CheckProcessVersion

func CheckProcessVersion(ctx context.Context, log *zap.Logger, config Config, info version.Info, service string) (err error)

CheckProcessVersion is not meant to be used for peers but is meant to be used for other utilities

Types

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

func New(config ClientConfig) *Client

New constructs a new verson control server client.

func (*Client) All

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

All handles the HTTP request to gather the latest version information.

func (*Client) OldMinimum

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

OldMinimum returns the version with the given name at the root-level of the version control response. NB: This will be deprecated eventually in favor of what is currently the `processes` root-level object.

func (*Client) Process

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

Process returns the version info for the named process from the version control server response.

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 DebugHandler

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

DebugHandler implements version info endpoint.

func NewDebugHandler

func NewDebugHandler(log *zap.Logger) *DebugHandler

NewDebugHandler returns new debug handler.

func (*DebugHandler) ServeHTTP

func (server *DebugHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP returns a json representation of the current version information for the binary.

type Service

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

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

architecture: Service

func NewService

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

NewService creates a Version Check Client with default configuration

func (*Service) CheckVersion

func (srv *Service) CheckVersion(ctx context.Context) (err error)

CheckVersion checks to make sure the version is still okay, returning an error if not

func (*Service) IsAllowed

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

IsAllowed returns whether if the Service is allowed to operate or not

func (*Service) Run

func (srv *Service) Run(ctx context.Context) (err error)

Run logs the current version information