umclient

Documentation

Index

• Constants
• type CertificateProvider
• type Client
  • func New(cfg *config.Config, messageHandler MessageHandler, ...) (client *Client, err error)
  • func (client *Client) Close() (err error)
• type ComponentStatus
  • func (status ComponentStatus) String() string
• type ComponentStatusInfo
• type ComponentUpdateInfo
• type MessageHandler
• type Status
• type UMState
  • func (state UMState) String() string

Constants

const (
	StateIdle = iota
	StatePrepared
	StateUpdated
	StateFailed
)

UM states.

const (
	StatusInstalled = iota
	StatusInstalling
	StatusError
)

Component statuses.

Types

type CertificateProvider

type CertificateProvider interface {
	GetNodeID() (string, error)
	GetCertificate(certType string) (certURL, ketURL string, err error)
}

CertificateProvider interface to get certificate.

type Client

type Client struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Client UM client instance.

func New

func New(cfg *config.Config, messageHandler MessageHandler, certProvider CertificateProvider,
	cryptocontext *cryptutils.CryptoContext, insecure bool,
) (client *Client, err error)

New creates new UM client.

func (*Client) Close

func (client *Client) Close() (err error)

Close closes UM client.

type ComponentStatus

type ComponentStatus int32

ComponentStatus component status.

func (ComponentStatus) String

func (status ComponentStatus) String() string

type ComponentStatusInfo

type ComponentStatusInfo struct {
	ID      string
	Type    string
	Version string
	Status  ComponentStatus
	Error   string
}

ComponentStatusInfo component status info.

type ComponentUpdateInfo

type ComponentUpdateInfo struct {
	ID          string
	Type        string
	Version     string
	Annotations json.RawMessage
	URL         string
	Sha256      []byte
	Size        uint64
}

ComponentUpdateInfo component update info.

type MessageHandler

type MessageHandler interface {
	// Registered indicates the client registered on the server
	Registered()
	// PrepareUpdate prepares update
	PrepareUpdate(components []ComponentUpdateInfo)
	// StartUpdate starts update
	StartUpdate()
	// ApplyUpdate applies update
	ApplyUpdate()
	// RevertUpdate reverts update
	RevertUpdate()
	// StatusChannel returns status channel
	StatusChannel() (channel <-chan Status)
}

MessageHandler incoming messages handler.

type Status

type Status struct {
	State      UMState
	Components []ComponentStatusInfo
	Error      string
}

Status update manager status.

type UMState

type UMState int32

UMState UM state.

func (UMState) String

func (state UMState) String() string