backend

type Describer ¶

type Describer interface {
	Describe(ctx context.Context, digest string) (*v1.CASResource, error)
}

type Downloader ¶

type Downloader interface {
	Download(ctx context.Context, w io.Writer, digest string) error
}

type ErrNotFound ¶

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

func NewErrNotFound(entity string) ErrNotFound

func (e ErrNotFound) Error() string

type ErrUploadSizeExceeded ¶ added in v1.79.0

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

func NewErrUploadSizeExceeded(want, maxSize int64) ErrUploadSizeExceeded

func (e ErrUploadSizeExceeded) Error() string

type Provider ¶

type Provider interface {
	// Provider identifier
	ID() string
	// retrieve a downloader/uploader from a secret
	FromCredentials(ctx context.Context, secretName string) (UploaderDownloader, error)
	// validate and extract credentials from raw json
	ValidateAndExtractCredentials(location string, credsJSON []byte) (any, error)
}

Provider is an interface that allows to create a backend from a secret

type Providers ¶

type Providers map[string]Provider

type StreamingUploader ¶ added in v1.106.0

type StreamingUploader interface {
	// SupportsStreaming reports whether Upload can be fed a streaming reader
	// without the caller buffering the full artifact in memory first.
	SupportsStreaming() bool
}

StreamingUploader is an optional interface implemented by backends whose Upload can consume the artifact directly from a streaming io.Reader without requiring the whole blob to be buffered in memory first.

The Artifact CAS service type-asserts uploaders against this interface: when a backend reports SupportsStreaming()==true the upload is piped straight from the client stream to the backend, bounding CAS memory usage independently of artifact size (PFM-6923). Backends that do not implement it (e.g. the OCI backend, whose push path needs the full layer content up front) keep the buffered code path.

type Uploader ¶

type Uploader interface {
	Upload(ctx context.Context, r io.Reader, resource *v1.CASResource) error
	Exists(ctx context.Context, digest string) (bool, error)
	CheckWritePermissions(ctx context.Context) error
}

type UploaderDownloader ¶

type UploaderDownloader interface {
	Uploader
	Downloader
	Describer
}