backend

Documentation

Index

• Constants
• type EdgeDeviceBackend
• type NotApproved
  • func NewNotApproved(err error) *NotApproved
  • func (e *NotApproved) Error() string
  • func (e *NotApproved) Unwrap() error
• type RegistrationStatus

Constants

const (
	// Registered describes edge device that is fully authorized to communicate with the control plane
	Registered = RegistrationStatus("registered")
	// Unregistered describes edge device that is not authorized to communicate with the control plane and will be
	// instructed to execute unregistration logic
	Unregistered = RegistrationStatus("unregistered")
	// Unknown signals that the status of the device can't be established (for example due to data retrieval errors)
	Unknown = RegistrationStatus("unknown")

	// RetryContextKey is a context key for a bool value describing whether the call is a retry call
	RetryContextKey = "retry"
)

Types

type EdgeDeviceBackend

type EdgeDeviceBackend interface {
	// GetRegistrationStatus responds with status of a device registration: {registered, unregistered, unknown}
	GetRegistrationStatus(ctx context.Context, name, namespace string) (RegistrationStatus, error)

	// GetConfiguration provides complete Edge Device configuration that should be applied to the device
	GetConfiguration(ctx context.Context, name, namespace string) (*models.DeviceConfigurationMessage, error)

	// Enrol records device willingness to be connected to the cluster.
	Enrol(ctx context.Context, name, namespace string, enrolmentInfo *models.EnrolmentInfo) (bool, error)

	// GetTargetNamespace returns the namespace the device should belong to. This method may return NotApproved error.
	GetTargetNamespace(ctx context.Context, name, namespace string, matchesCertificate bool) (string, error)

	// Register is called during device registration request handling, after mTLS certificate has
	// been correctly issued.
	// The responsibility of the method is to  record information that the device is finally registered and
	// what hardware configuration it has.
	Register(ctx context.Context, name, namespace string, registrationInfo *models.RegistrationInfo) error

	// UpdateStatus records current state of the device sent in a heartbeat message
	// (i.e. workload status, events reported by the device, OS upgrade status).
	// The context might contain value under RetryContextKey.
	UpdateStatus(ctx context.Context, name, namespace string, heartbeat *models.Heartbeat) (bool, error)
}

EdgeDeviceBackend represents API provided by data storage service to support edge device lifecycle.

type NotApproved

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

NotApproved is an error representing situation when edge device had been enrolled but hasn't been approved yet

func NewNotApproved

func NewNotApproved(err error) *NotApproved

NewNotApproved creates new NotApproved error with given detailed error cause.

func (*NotApproved) Error

func (e *NotApproved) Error() string

func (*NotApproved) Unwrap

func (e *NotApproved) Unwrap() error

type RegistrationStatus

type RegistrationStatus string