artefacts

Documentation

Index

• type Artefact
• type ArtefactBlobs
• type ArtefactKey
• type ArtefactRepository
• type Metadata
• type OCIArtefactService
  • func NewForTesting() *OCIArtefactService
  • func NewOCIRegistryStorage(config RegistryConfig) (*OCIArtefactService, error)
  • func (s *OCIArtefactService) Download(ctx context.Context, dg sha256.SHA256) (io.ReadCloser, error)
  • func (s *OCIArtefactService) GetDigestsKeys(ctx context.Context, digests []sha256.SHA256) (keys []ArtefactKey, missing []sha256.SHA256, err error)
  • func (s *OCIArtefactService) Upload(ctx context.Context, artefact Artefact) (sha256.SHA256, error)
• type RegistryConfig
• type ReleaseArtefact
• type Service

Types

type Artefact

type Artefact struct {
	Digest   sha256.SHA256
	Metadata Metadata
	Content  []byte
}

Artefact container for an artefact's payload and metadata

type ArtefactBlobs

type ArtefactBlobs struct {
	Digest    sha256.SHA256
	MediaType string
	Size      int64
}

type ArtefactKey

type ArtefactKey struct {
	Digest sha256.SHA256
}

type ArtefactRepository

type ArtefactRepository struct {
	ModuleDigest     sha256.SHA256
	MediaType        string
	ArtefactType     string
	RepositoryDigest digest.Digest
	Size             int64
}

type Metadata

type Metadata struct {
	Executable bool
	Path       string
}

Metadata container for an artefact's metadata

type OCIArtefactService

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

func NewForTesting

func NewForTesting() *OCIArtefactService

func NewOCIRegistryStorage

func NewOCIRegistryStorage(config RegistryConfig) (*OCIArtefactService, error)

func (*OCIArtefactService) Download

func (s *OCIArtefactService) Download(ctx context.Context, dg sha256.SHA256) (io.ReadCloser, error)

func (*OCIArtefactService) GetDigestsKeys

func (s *OCIArtefactService) GetDigestsKeys(ctx context.Context, digests []sha256.SHA256) (keys []ArtefactKey, missing []sha256.SHA256, err error)

func (*OCIArtefactService) Upload

func (s *OCIArtefactService) Upload(ctx context.Context, artefact Artefact) (sha256.SHA256, error)

Upload uploads the specific artifact as a raw blob and links it to a manifest to prevent GC

type RegistryConfig

type RegistryConfig struct {
	Registry      string `help:"OCI container registry, in the form host[:port]/repository" env:"FTL_ARTEFACT_REGISTRY" required:""`
	Username      string `help:"OCI container registry username" env:"FTL_ARTEFACT_REGISTRY_USERNAME"`
	Password      string `help:"OCI container registry password" env:"FTL_ARTEFACT_REGISTRY_PASSWORD"`
	AllowInsecure bool   `help:"Allows the use of insecure HTTP based registries." env:"FTL_ARTEFACT_REGISTRY_ALLOW_INSECURE"`
}

type ReleaseArtefact

type ReleaseArtefact struct {
	Artefact   ArtefactKey
	Path       string
	Executable bool
}

type Service

type Service interface {

	// GetDigestsKeys locates the `digests` corresponding `ArtefactKey`s and identifies the missing ones
	GetDigestsKeys(ctx context.Context, digests []sha256.SHA256) (keys []ArtefactKey, missing []sha256.SHA256, err error)

	// Upload pushes the specified media, and metadata, to the registry and returns the computed digest
	Upload(context context.Context, artefact Artefact) (sha256.SHA256, error)

	// Download performs a streaming download of the artefact identified by the supplied digest
	Download(context context.Context, digest sha256.SHA256) (io.ReadCloser, error)
}