storage

Documentation

Index

• Variables
• type Backend
  • func ByConfig(ctx context.Context, dir string, storage v1alpha1.StorageConfig) (Backend, error)
  • func NewLocalBackend(dir string) (Backend, error)
  • func NewRegistryBackend(ctx context.Context, cfg *v1alpha1.RegistryConfig, dir string) (Backend, error)
• type Committer

Variables

var (
	// ErrMetadataNotExist should be returned by ReadMetadata() when no metadata is found.
	// Callers should check for this error, since in certain conditions no metadata is desired.
	ErrMetadataNotExist = errors.New("metadata does not exist")
)

Types

type Backend

type Backend interface {
	ReadMetadata(context.Context, *v1alpha1.Metadata, string) error
	WriteMetadata(context.Context, *v1alpha1.Metadata, string) error
	ReadObject(context.Context, string, interface{}) error
	WriteObject(context.Context, string, interface{}) error
	GetWriter(context.Context, string) (io.Writer, error)
	CheckConfig(v1alpha1.StorageConfig) error
}

func ByConfig

func ByConfig(ctx context.Context, dir string, storage v1alpha1.StorageConfig) (Backend, error)

ByConfig returns backend interface based on provided config

func NewLocalBackend

func NewLocalBackend(dir string) (Backend, error)

func NewRegistryBackend

func NewRegistryBackend(ctx context.Context, cfg *v1alpha1.RegistryConfig, dir string) (Backend, error)

type Committer

type Committer interface {
	// Commit the set of writes to the Backend for persistence.
	// Commit is NOT guaranteed to be threadsafe, see implementer comments for details.
	Commit(context.Context) error
}

Committer is a Backend that collects a set of write operations into a transaction then commits them atomically. The technologies underlying these Backends are typically transactional by nature (like git); this interface exposes that nature.