backend

Documentation

Index

• Constants
• Variables
• func DetectedMediaType(b []byte) types.MediaType
• func IsNotFound(err error) bool
• type Describer
• type Downloader
• type ErrNotFound
  • func NewErrNotFound(entity string) ErrNotFound
  • func (e ErrNotFound) Error() string
• type Provider
• type Providers
• type Uploader
• type UploaderDownloader

Constants

const (
	AuthorAnnotation = "chainloop.dev"
	// Default prefix for the blobmanager
	DefaultPrefix = "chainloop"
)

Variables

var ErrValidation = errors.New("credentials validation error")

Functions

func DetectedMediaType

func DetectedMediaType(b []byte) types.MediaType

Detect the media type based on the provided content

func IsNotFound

func IsNotFound(err error) bool

Types

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

func NewErrNotFound(entity string) ErrNotFound

func (ErrNotFound) Error

func (e ErrNotFound) 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 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
}