oci

Documentation

Overview

Package oci contains OCI registry related helpers for the registries offered by the various cloud providers. It can be used to perform various operations like pushing, pulling and tagging artifacts, auto-login using the native authentication mechanism of the platform, etc. +kubebuilder:object:generate=false

Index

• Constants
• Variables
• type Provider

Constants

const (
	ClientCert = "certFile"
	ClientKey  = "keyFile"
	CACert     = "caFile"
)

Registry TLS transport config.

const (
	// SourceAnnotation is the OpenContainers annotation for specifying
	// the upstream source of an OCI artifact.
	SourceAnnotation = "org.opencontainers.image.source"

	// RevisionAnnotation is the OpenContainers annotation for specifying
	// the upstream source revision of an OCI artifact.
	RevisionAnnotation = "org.opencontainers.image.revision"

	// CreatedAnnotation is the OpenContainers annotation for specifying
	// the date and time on which the OCI artifact was built (RFC 3339).
	CreatedAnnotation = "org.opencontainers.image.created"

	// OCIRepositoryPrefix is the prefix used for OCIRepository URLs.
	OCIRepositoryPrefix = "oci://"
)

Variables

var (
	// CanonicalConfigMediaType is the OCI media type for the config layer.
	CanonicalConfigMediaType types.MediaType = "application/vnd.cncf.flux.config.v1+json"

	// CanonicalMediaTypePrefix is the suffix for OCI media type for the content layer.
	CanonicalMediaTypePrefix types.MediaType = "application/vnd.cncf.flux.content.v1"

	// CanonicalContentMediaType is the OCI media type for the content layer.
	CanonicalContentMediaType = types.MediaType(fmt.Sprintf("%s.tar+gzip", CanonicalMediaTypePrefix))

	// UserAgent string used for OCI calls.
	UserAgent = "flux/v2"
)

var (
	// ErrUnconfiguredProvider is returned when the OCI registry provider is
	// not configured.
	ErrUnconfiguredProvider = errors.New("registry provider not configured")
)

Types

type Provider

type Provider int

Provider is used to categorize the OCI registry providers.

const (
	// ProviderGeneric is used to categorize registry provider that we don't
	// support.
	ProviderGeneric Provider = iota
	ProviderAWS
	ProviderGCP
	ProviderAzure
)

Registry providers.