ociartifact

README

Access Method ociArtifact and ociRegistry - OCI Artifact Access

Synopsis

type: ociArtifact/v1

Provided blobs use the following media type:

• application/vnd.oci.image.manifest.v1+tar+gzip: OCI image manifests
• application/vnd.oci.image.index.v1+tar.gzip: OCI index manifests

Depending on the repository appropriate docker legacy types might be used.

The artifact content is provided in the Artifact Set Format. The tag is provided as annotation.

Description

This method implements the access of an OCI artifact stored in an OCI registry.

Supported specification version is v1

Specification Versions

Version v1

The type specific specification fields are:

• imageReference string

  OCI image/artifact reference following the possible docker schemes:

  • <repo>/<artifact>:<tag>@<digest>
  • <host>[<port>]/<repo path>/<artifact>:<tag>@<digest>

Go Bindings

The go binding can be found here

Documentation

Index

• Constants
• Variables
• func AddConfig(opts flagsets.ConfigOptions, config flagsets.Config) error
• func ConfigHandler() flagsets.ConfigOptionTypeSetHandler
• func GetOCIArtifactReference(ctx cpi.Context, spec cpi.AccessSpec, cv cpi.ComponentVersionAccess) (string, error)
• func Hint(nv common.NameVersion, locator, repo, version string) string
• func Is(spec accspeccpi.AccessSpec) bool
• func Logger(c ContextProvider, keyValuePairs ...interface{}) logging.Logger
• func NewMethod(ctx accspeccpi.ContextProvider, a accspeccpi.AccessSpec, ref string, ...) (accspeccpi.AccessMethod, error)
• type AccessMethodImpl
• type AccessSpec
  • func New(ref string) *AccessSpec
  • func (a *AccessSpec) AccessMethod(c accspeccpi.ComponentVersionAccess) (accspeccpi.AccessMethod, error)
  • func (a *AccessSpec) Describe(ctx accspeccpi.Context) string
  • func (a *AccessSpec) Digest() digest.Digest
  • func (a *AccessSpec) GetInexpensiveContentVersionIdentity(cv accspeccpi.ComponentVersionAccess) string
  • func (a *AccessSpec) GetOCIReference(cv accspeccpi.ComponentVersionAccess) (string, error)
  • func (a *AccessSpec) GetReferenceHint(cv accspeccpi.ComponentVersionAccess) string
  • func (_ *AccessSpec) GetType() string
  • func (a *AccessSpec) GlobalAccessSpec(ctx accspeccpi.Context) accspeccpi.AccessSpec
  • func (_ *AccessSpec) IsLocal(accspeccpi.Context) bool
• type ContextProvider
  • func WrapContextProvider(ctx cpi.ContextProvider) ContextProvider
• type OCIArtifactReferenceProvider

Constants

const (
	Type   = "ociArtifact"
	TypeV1 = Type + runtime.VersionSeparator + "v1"
)

Type is the access type of a oci registry.

const (
	LegacyType   = "ociRegistry"
	LegacyTypeV1 = LegacyType + runtime.VersionSeparator + "v1"
)

Variables

var REALM = ocmlog.DefineSubRealm("access method ociArtifact", "accessmethod/ociartifact")

Functions

func AddConfig

func AddConfig(opts flagsets.ConfigOptions, config flagsets.Config) error

func ConfigHandler

func ConfigHandler() flagsets.ConfigOptionTypeSetHandler

func GetOCIArtifactReference

func GetOCIArtifactReference(ctx cpi.Context, spec cpi.AccessSpec, cv cpi.ComponentVersionAccess) (string, error)

func Hint

func Hint(nv common.NameVersion, locator, repo, version string) string

func Is

func Is(spec accspeccpi.AccessSpec) bool

func Logger

func Logger(c ContextProvider, keyValuePairs ...interface{}) logging.Logger

func NewMethod

func NewMethod(ctx accspeccpi.ContextProvider, a accspeccpi.AccessSpec, ref string, repo ...oci.Repository) (accspeccpi.AccessMethod, error)

Types

type AccessMethodImpl

type AccessMethodImpl = *accessMethod

type AccessSpec

type AccessSpec struct {
	runtime.ObjectVersionedType `json:",inline"`

	// ImageReference is the actual reference to the oci image repository and tag.
	ImageReference string `json:"imageReference"`
}

AccessSpec describes the access for a oci registry.

func New

func New(ref string) *AccessSpec

New creates a new oci registry access spec version v1.

func (*AccessSpec) AccessMethod

func (a *AccessSpec) AccessMethod(c accspeccpi.ComponentVersionAccess) (accspeccpi.AccessMethod, error)

func (*AccessSpec) Describe

func (a *AccessSpec) Describe(ctx accspeccpi.Context) string

func (*AccessSpec) Digest

func (a *AccessSpec) Digest() digest.Digest

func (*AccessSpec) GetInexpensiveContentVersionIdentity

func (a *AccessSpec) GetInexpensiveContentVersionIdentity(cv accspeccpi.ComponentVersionAccess) string

func (*AccessSpec) GetOCIReference

func (a *AccessSpec) GetOCIReference(cv accspeccpi.ComponentVersionAccess) (string, error)

func (*AccessSpec) GetReferenceHint

func (a *AccessSpec) GetReferenceHint(cv accspeccpi.ComponentVersionAccess) string

func (*AccessSpec) GetType

func (_ *AccessSpec) GetType() string

func (*AccessSpec) GlobalAccessSpec

func (a *AccessSpec) GlobalAccessSpec(ctx accspeccpi.Context) accspeccpi.AccessSpec

func (*AccessSpec) IsLocal

func (_ *AccessSpec) IsLocal(accspeccpi.Context) bool

type ContextProvider

type ContextProvider interface {
	GetContext() cpi.Context
}

func WrapContextProvider

func WrapContextProvider(ctx cpi.ContextProvider) ContextProvider

type OCIArtifactReferenceProvider

type OCIArtifactReferenceProvider interface {
	// GetOCIReference returns the externally usable OCI reference.
	// The component version miggt be nil. If it is required to
	// determine the ref, an appropriate error has to be returned.
	GetOCIReference(cv cpi.ComponentVersionAccess) (string, error)
}

OCIArtifactReferenceProvider should be implemented by access specs providing access to globally retrievable OCI artifacts.