oci

Documentation

Index

• Constants
• func AsTags(tag string) []string
• func DefaultContext() internal.Context
• func IsErrBlobNotFound(err error) bool
• func IsIntermediate(spec RepositorySpec) bool
• func StandardOCIRef(host, repository, version string) string
• func WithContext(ctx context.Context) internal.Builder
• func WithCredentials(ctx credentials.Context) internal.Builder
• func WithRepositorySpecHandlers(reg RepositorySpecHandlers) internal.Builder
• func WithRepositoyTypeScheme(scheme RepositoryTypeScheme) internal.Builder
• type ArtSpec
  • func ParseArt(art string) (ArtSpec, error)
  • func (r *ArtSpec) IsVersion() bool
  • func (r *ArtSpec) Reference() string
  • func (r *ArtSpec) String() string
• type ArtefactAccess
• type ArtefactContainer
• type BlobAccess
• type Context
  • func DefinedForContext(ctx context.Context) (Context, bool)
  • func ForContext(ctx context.Context) Context
  • func New(mode ...datacontext.BuilderMode) Context
• type ContextProvider
• type DataAccess
• type EvaluationResult
• type GenericRepositorySpec
  • func ToGenericRepositorySpec(spec RepositorySpec) (*GenericRepositorySpec, error)
• type IndexAccess
• type IntermediateRepositorySpecAspect
• type ManifestAccess
• type NamespaceAccess
• type NamespaceContainer
• type NamespaceLister
• type RefSpec
  • func ParseRef(ref string) (RefSpec, error)
  • func (r *RefSpec) CredHost() string
  • func (r RefSpec) DeepCopy() RefSpec
  • func (r *RefSpec) IsRegistry() bool
  • func (r *RefSpec) IsTagged() bool
  • func (r *RefSpec) IsVersion() bool
  • func (r *RefSpec) Name() string
  • func (r *RefSpec) String() string
  • func (r *RefSpec) Version() string
• type Repository
• type RepositorySpec
• type RepositorySpecHandler
• type RepositorySpecHandlers
• type RepositoryTypeScheme
• type Session
  • func NewSession(s datacontext.Session) Session
• type UniformRepositorySpec
  • func ParseRepo(ref string) (UniformRepositorySpec, error)

Constants

const (
	KIND_OCIARTEFACT = internal.KIND_OCIARTEFACT
	KIND_MEDIATYPE   = accessio.KIND_MEDIATYPE
	KIND_BLOB        = accessio.KIND_BLOB
)

const (
	KIND_OCI_REFERENCE       = "oci reference"
	KIND_ARETEFACT_REFERENCE = "artefact reference"
)

to find a suitable secret for images on Docker Hub, we need its two domains to do matching.

const CONTEXT_TYPE = internal.CONTEXT_TYPE

const CommonTransportFormat = internal.CommonTransportFormat

Functions

func AsTags

func AsTags(tag string) []string

func DefaultContext

func DefaultContext() internal.Context

func IsErrBlobNotFound

func IsErrBlobNotFound(err error) bool

func IsIntermediate

func IsIntermediate(spec RepositorySpec) bool

func StandardOCIRef

func StandardOCIRef(host, repository, version string) string

func WithContext

func WithContext(ctx context.Context) internal.Builder

func WithCredentials

func WithCredentials(ctx credentials.Context) internal.Builder

func WithRepositorySpecHandlers

func WithRepositorySpecHandlers(reg RepositorySpecHandlers) internal.Builder

func WithRepositoyTypeScheme

func WithRepositoyTypeScheme(scheme RepositoryTypeScheme) internal.Builder

Types

type ArtSpec

type ArtSpec struct {
	// Repository is the part of a reference without its hostname
	Repository string
	// +optional
	Tag *string
	// +optional
	Digest *digest.Digest
}

ArtSpec is a go internal representation of a oci reference.

func ParseArt

func ParseArt(art string) (ArtSpec, error)

func (*ArtSpec) IsVersion

func (r *ArtSpec) IsVersion() bool

func (*ArtSpec) Reference

func (r *ArtSpec) Reference() string

func (*ArtSpec) String

func (r *ArtSpec) String() string

type ArtefactAccess

type ArtefactAccess = internal.ArtefactAccess

type ArtefactContainer

type ArtefactContainer interface {
	GetArtefact(version string) (ArtefactAccess, error)
}

type BlobAccess

type BlobAccess = internal.BlobAccess

type Context

type Context = internal.Context

func DefinedForContext

func DefinedForContext(ctx context.Context) (Context, bool)

func ForContext

func ForContext(ctx context.Context) Context

func New

func New(mode ...datacontext.BuilderMode) Context

type ContextProvider

type ContextProvider = internal.ContextProvider

type DataAccess

type DataAccess = internal.DataAccess

type EvaluationResult

type EvaluationResult struct {
	Ref        RefSpec
	Repository Repository
	Namespace  NamespaceAccess
	Artefact   ArtefactAccess
}

type GenericRepositorySpec

type GenericRepositorySpec = internal.GenericRepositorySpec

func ToGenericRepositorySpec

func ToGenericRepositorySpec(spec RepositorySpec) (*GenericRepositorySpec, error)

type IndexAccess

type IndexAccess = internal.IndexAccess

type IntermediateRepositorySpecAspect

type IntermediateRepositorySpecAspect = internal.IntermediateRepositorySpecAspect

type ManifestAccess

type ManifestAccess = internal.ManifestAccess

type NamespaceAccess

type NamespaceAccess = internal.NamespaceAccess

type NamespaceContainer

type NamespaceContainer interface {
	LookupNamespace(name string) (NamespaceAccess, error)
}

type NamespaceLister

type NamespaceLister = internal.NamespaceLister

type RefSpec

type RefSpec struct {
	UniformRepositorySpec
	// Repository is the part of a reference without its hostname
	Repository string `json:"repository"`
	// +optional
	Tag *string `json:"tag,omitempty"`
	// +optional
	Digest *digest.Digest `json:"digest,omitempty"`
}

RefSpec is a go internal representation of a oci reference.

func ParseRef

func ParseRef(ref string) (RefSpec, error)

ParseRef parses a oci reference into a internal representation.

func (*RefSpec) CredHost

func (r *RefSpec) CredHost() string

CredHost fallback to legacy docker domain if applicable this is how containerd translates the old domain for DockerHub to the new one, taken from containerd/reference/docker/reference.go:674.

func (RefSpec) DeepCopy

func (r RefSpec) DeepCopy() RefSpec

func (*RefSpec) IsRegistry

func (r *RefSpec) IsRegistry() bool

func (*RefSpec) IsTagged

func (r *RefSpec) IsTagged() bool

func (*RefSpec) IsVersion

func (r *RefSpec) IsVersion() bool

func (*RefSpec) Name

func (r *RefSpec) Name() string

func (*RefSpec) String

func (r *RefSpec) String() string

func (*RefSpec) Version

func (r *RefSpec) Version() string

type Repository

type Repository = internal.Repository

type RepositorySpec

type RepositorySpec = internal.RepositorySpec

type RepositorySpecHandler

type RepositorySpecHandler = internal.RepositorySpecHandler

type RepositorySpecHandlers

type RepositorySpecHandlers = internal.RepositorySpecHandlers

type RepositoryTypeScheme

type RepositoryTypeScheme = internal.RepositoryTypeScheme

type Session

type Session interface {
	datacontext.Session

	LookupRepository(Context, RepositorySpec) (Repository, error)
	LookupNamespace(NamespaceContainer, string) (NamespaceAccess, error)
	GetArtefact(ArtefactContainer, string) (ArtefactAccess, error)
	EvaluateRef(ctx Context, ref string) (*EvaluationResult, error)
	DetermineRepository(ctx Context, ref string) (Repository, UniformRepositorySpec, error)
	DetermineRepositoryBySpec(ctx Context, spec *UniformRepositorySpec) (Repository, error)
}

func NewSession

func NewSession(s datacontext.Session) Session

type UniformRepositorySpec

type UniformRepositorySpec = internal.UniformRepositorySpec

func ParseRepo

func ParseRepo(ref string) (UniformRepositorySpec, error)

ParseRepo parses a standard oci repository reference into a internal representation.