spec

Documentation

Index

• Constants
• Variables
• func EnsureCurrentRenderedSpec(ctx context.Context, log *logrus.Logger, logPrefix string, ...) (v1alpha1.RenderedDeviceSpec, error)
• func EnsureDesiredRenderedSpec(ctx context.Context, log *logrus.Logger, logPrefix string, ...) (v1alpha1.RenderedDeviceSpec, error)
• func ReadRenderedSpecFromFile(reader *fileio.Reader, filePath string) (v1alpha1.RenderedDeviceSpec, error)
• func WriteRenderedSpecToFile(writer *fileio.Writer, rendered *v1alpha1.RenderedDeviceSpec, filePath string) error
• type Manager
  • func NewManager(deviceName string, currentRenderedFilePath string, ...) *Manager
  • func (s *Manager) GetRendered(ctx context.Context) (v1alpha1.RenderedDeviceSpec, v1alpha1.RenderedDeviceSpec, bool, error)
  • func (s *Manager) WriteCurrentRendered(rendered *v1alpha1.RenderedDeviceSpec) error

Constants

const (
	// name of the file which stores the current device spec
	CurrentFile = "current-spec.json"
	// name of the file which stores the desired device spec
	DesiredFile = "desired-spec.json"
)

Variables

var (
	ErrMissingRenderedSpec = fmt.Errorf("missing rendered spec")
	ErrNoContent           = fmt.Errorf("no content")
)

Functions

func EnsureCurrentRenderedSpec

func EnsureCurrentRenderedSpec(
	ctx context.Context,
	log *logrus.Logger,
	logPrefix string,
	writer *fileio.Writer,
	reader *fileio.Reader,
	filePath string,
) (v1alpha1.RenderedDeviceSpec, error)

EnsureCurrentRenderedSpec ensures the current rendered spec exists on disk or is initialized as empty.

func EnsureDesiredRenderedSpec

func EnsureDesiredRenderedSpec(
	ctx context.Context,
	log *logrus.Logger,
	logPrefix string,
	writer *fileio.Writer,
	reader *fileio.Reader,
	managementClient *client.Management,
	deviceName string,
	filePath string,
	backoff wait.Backoff,
) (v1alpha1.RenderedDeviceSpec, error)

EnsureDesiredRenderedSpec ensures the desired rendered spec exists on disk or is initialized from the management API.

func ReadRenderedSpecFromFile

func ReadRenderedSpecFromFile(
	reader *fileio.Reader,
	filePath string,
) (v1alpha1.RenderedDeviceSpec, error)

func WriteRenderedSpecToFile

func WriteRenderedSpecToFile(writer *fileio.Writer, rendered *v1alpha1.RenderedDeviceSpec, filePath string) error

Types

type Manager

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

Manager is responsible for managing the rendered device spec.

func NewManager

func NewManager(
	deviceName string,
	currentRenderedFilePath string,
	desiredRenderedFilePath string,
	deviceWriter *fileio.Writer,
	deviceReader *fileio.Reader,
	managementClient *client.Management,
	backoff wait.Backoff,
	log *logrus.Logger,
	logPrefix string,
) *Manager

NewManager creates a new device spec manager.

func (*Manager) GetRendered

func (s *Manager) GetRendered(ctx context.Context) (v1alpha1.RenderedDeviceSpec, v1alpha1.RenderedDeviceSpec, bool, error)

GetRendered returns the current and desired rendered device specs.

func (*Manager) WriteCurrentRendered

func (s *Manager) WriteCurrentRendered(rendered *v1alpha1.RenderedDeviceSpec) error

WriteCurrentRendered writes the rendered device spec to disk