checkpoint

Documentation

Index

• func EqualRemoteConfigSources(a, b RemoteConfigSource) bool
• type Payload
  • func NewConfigMapPayload(cm *apiv1.ConfigMap) (Payload, error)
• type RemoteConfigSource
  • func DecodeRemoteConfigSource(data []byte) (RemoteConfigSource, error)
  • func NewRemoteConfigSource(source *apiv1.NodeConfigSource) (RemoteConfigSource, string, error)

Functions

func EqualRemoteConfigSources

func EqualRemoteConfigSources(a, b RemoteConfigSource) bool

EqualRemoteConfigSources is a helper for comparing remote config sources by comparing the underlying API objects for semantic equality.

Types

type Payload

type Payload interface {
	// UID returns a globally unique (space and time) identifier for the payload.
	UID() string

	// Files returns a map of filenames to file contents.
	Files() map[string]string
	// contains filtered or unexported methods
}

Payload represents a local copy of a config source (payload) object

func NewConfigMapPayload

func NewConfigMapPayload(cm *apiv1.ConfigMap) (Payload, error)

NewConfigMapPayload constructs a Payload backed by a ConfigMap, which must have a non-empty UID

type RemoteConfigSource

type RemoteConfigSource interface {
	// UID returns a globally unique identifier of the source described by the remote config source object
	UID() string
	// APIPath returns the API path to the remote resource, e.g. its SelfLink
	APIPath() string
	// Download downloads the remote config source object returns a Payload backed by the object,
	// or a sanitized failure reason and error if the download fails
	Download(client clientset.Interface) (Payload, string, error)
	// Encode returns a []byte representation of the object behind the RemoteConfigSource
	Encode() ([]byte, error)
	// contains filtered or unexported methods
}

RemoteConfigSource represents a remote config source object that can be downloaded as a Checkpoint

func DecodeRemoteConfigSource

func DecodeRemoteConfigSource(data []byte) (RemoteConfigSource, error)

DecodeRemoteConfigSource is a helper for using the apimachinery to decode serialized RemoteConfigSources; e.g. the metadata stored by checkpoint/store/fsstore.go

func NewRemoteConfigSource

func NewRemoteConfigSource(source *apiv1.NodeConfigSource) (RemoteConfigSource, string, error)

NewRemoteConfigSource constructs a RemoteConfigSource from a v1/NodeConfigSource object, or returns a sanitized failure reason and an error if the `source` is blatantly invalid. You should only call this with a non-nil config source.