builder

Documentation

Index

• Constants
• type Builder
  • func New(opts ...env.Option) *Builder
  • func NewBuilder(opts ...env.Option) *Builder
  • func (b *Builder) Access(acc compdesc.AccessSpec)
  • func (b *Builder) Annotation(name, value string)
  • func (b *Builder) Artifact(desc *artdesc.Descriptor)
  • func (b *Builder) ArtifactSet(path string, fmt accessio.FileFormat, f ...func())
  • func (b *Builder) BlobData(mime string, data []byte)
  • func (b *Builder) BlobFromDirTree(path string, opts ...dirtree.Option)
  • func (b *Builder) BlobFromFile(mime string, path string)
  • func (b *Builder) BlobStringData(mime string, data string)
  • func (b *Builder) Build(funcs ...func(*Builder)) (err error)
  • func (b *Builder) ClearExtraIdentities()
  • func (b *Builder) ClearLabels()
  • func (b *Builder) Component(name string, f ...func())
  • func (b *Builder) ComponentArchive(path string, fmt accessio.FileFormat, name, vers string, f ...func())
  • func (b *Builder) ComponentVersion(name, version string, f ...func())
  • func (b *Builder) Config(f ...func())
  • func (b *Builder) Configure(funcs ...func())
  • func (b *Builder) Digest(value, algo, norm string)
  • func (b *Builder) ExtraIdentity(name string, value string)
  • func (b *Builder) GeneralOCIRepository(spec oci.RepositorySpec, f ...func())
  • func (b *Builder) Hint(hint string)
  • func (b *Builder) Index(tag string, f ...func()) *artdesc.Descriptor
  • func (b *Builder) Label(name string, value interface{}, opts ...metav1.LabelOption)
  • func (b *Builder) Layer(f ...func()) *artdesc.Descriptor
  • func (b *Builder) Manifest(tag string, f ...func()) *artdesc.Descriptor
  • func (b *Builder) ModificationOptions(opts ...ocm.ModificationOption)
  • func (b *Builder) ModifyResource(id metav1.Identity, f ...func())
  • func (b *Builder) Namespace(name string, f ...func())
  • func (b *Builder) OCIBasedOCMRepository(url string, path string, f ...func())
  • func (b *Builder) OCICommonTransport(path string, fmt accessio.FileFormat, f ...func())
  • func (b *Builder) OCIRegistry(url string, path string, f ...func())
  • func (b *Builder) OCMCommonTransport(path string, fmt accessio.FileFormat, f ...func())
  • func (b *Builder) OCMCompositionRepository(name string, f ...func())
  • func (b *Builder) OCMRepository(spec ocm.RepositorySpec, f ...func())
  • func (b *Builder) Platform(os string, arch string)
  • func (b *Builder) PropagateError(errp *error, matchers ...exception.Matcher)
  • func (b *Builder) Provider(name string, f ...func())
  • func (b *Builder) RSAKeyPair(name ...string)
  • func (b *Builder) ReadRSAKeyPair(name, path string)
  • func (b *Builder) Reference(name, comp, vers string, f ...func())
  • func (b *Builder) RemoveExtraIdentity(name string)
  • func (b *Builder) RemoveLabel(name string)
  • func (b *Builder) Resource(name, vers, typ string, relation metav1.ResourceRelation, f ...func())
  • func (b *Builder) SetFailhandler(h ...env.FailHandler) *Builder
  • func (b *Builder) Source(name, vers, typ string, f ...func())
  • func (b *Builder) Tags(tags ...string)
  • func (b *Builder) Version(name string, f ...func())
• type State

Constants

const (
	T_OCIARTIFACT = "artifact"
	T_OCIINDEX    = "index"
	T_OCIMANIFEST = "manifest"
)

const T_BLOBACCESS = "blob access"

const T_COMPARCH = "component archive"

const T_OCIARTIFACTSET = "artifact set"

const T_OCICONFIG = "oci config"

const T_OCILAYER = "oci layer"

const T_OCINAMESPACE = "oci namespace"

const T_OCIPLATFORM = "platform consumer"

const T_OCIREPOSITORY = "oci repository"

const T_OCI_CTF = "oci common transport format"

const T_OCMACCESS = "access"

const T_OCMCOMPONENT = "component"

const T_OCMLABELS = "element with labels"

const T_OCMMETA = "element with metadata"

const T_OCMPROVIDER = "provider"

const T_OCMREF = "reference"

const T_OCMREPOSITORY = "ocm repository"

const T_OCMRESOURCE = "resource"

const T_OCMSOURCE = "source"

const T_OCMVERSION = "component version"

const T_OCM_COMPOSITION = "ocm composition repositoryt"

const T_OCM_CTF = "ocm common transport format"

Types

type Builder

type Builder struct {
	*env.Environment
	// contains filtered or unexported fields
}

func New

func New(opts ...env.Option) *Builder

New creates a new composition environment including an own OCM context and a private filesystem, which can be used to compose OCM/OCI repositories and their content. It can be configured to work with dedicated settings, also.

func NewBuilder

func NewBuilder(opts ...env.Option) *Builder

NewBuilder creates a new composition environment including an own OCM context and a private filesystem, which can be used to compose OCM/OCI repositories and their content. By default, a private environment is created based on a ginko fail handling intended to be used for test cases. But it can be configured to work as library with dedicated settings, also.

func (*Builder) Access

func (b *Builder) Access(acc compdesc.AccessSpec)

func (*Builder) Annotation

func (b *Builder) Annotation(name, value string)

func (*Builder) Artifact

func (b *Builder) Artifact(desc *artdesc.Descriptor)

func (*Builder) ArtifactSet

func (b *Builder) ArtifactSet(path string, fmt accessio.FileFormat, f ...func())

func (*Builder) BlobData

func (b *Builder) BlobData(mime string, data []byte)

func (*Builder) BlobFromDirTree

func (b *Builder) BlobFromDirTree(path string, opts ...dirtree.Option)

func (*Builder) BlobFromFile

func (b *Builder) BlobFromFile(mime string, path string)

func (*Builder) BlobStringData

func (b *Builder) BlobStringData(mime string, data string)

func (*Builder) Build

func (b *Builder) Build(funcs ...func(*Builder)) (err error)

Build executes the given functions and returns a potential configuration error, instead of using the builder's env.FailHandler. Additionally, a build can always throw an exception using the exception.Throw function.

func (*Builder) ClearExtraIdentities

func (b *Builder) ClearExtraIdentities()

func (*Builder) ClearLabels

func (b *Builder) ClearLabels()

func (*Builder) Component

func (b *Builder) Component(name string, f ...func())

func (*Builder) ComponentArchive

func (b *Builder) ComponentArchive(path string, fmt accessio.FileFormat, name, vers string, f ...func())

func (*Builder) ComponentVersion

func (b *Builder) ComponentVersion(name, version string, f ...func())

func (*Builder) Config

func (b *Builder) Config(f ...func())

func (*Builder) Configure

func (b *Builder) Configure(funcs ...func())

func (*Builder) Digest

func (b *Builder) Digest(value, algo, norm string)

func (*Builder) ExtraIdentity

func (b *Builder) ExtraIdentity(name string, value string)

func (*Builder) GeneralOCIRepository

func (b *Builder) GeneralOCIRepository(spec oci.RepositorySpec, f ...func())

func (*Builder) Hint

func (b *Builder) Hint(hint string)

func (*Builder) Index

func (b *Builder) Index(tag string, f ...func()) *artdesc.Descriptor

func (*Builder) Label

func (b *Builder) Label(name string, value interface{}, opts ...metav1.LabelOption)

func (*Builder) Layer

func (b *Builder) Layer(f ...func()) *artdesc.Descriptor

func (*Builder) Manifest

func (b *Builder) Manifest(tag string, f ...func()) *artdesc.Descriptor

func (*Builder) ModificationOptions

func (b *Builder) ModificationOptions(opts ...ocm.ModificationOption)

func (*Builder) ModifyResource

func (b *Builder) ModifyResource(id metav1.Identity, f ...func())

func (*Builder) Namespace

func (b *Builder) Namespace(name string, f ...func())

func (*Builder) OCIBasedOCMRepository

func (b *Builder) OCIBasedOCMRepository(url string, path string, f ...func())

func (*Builder) OCICommonTransport

func (b *Builder) OCICommonTransport(path string, fmt accessio.FileFormat, f ...func())

func (*Builder) OCIRegistry

func (b *Builder) OCIRegistry(url string, path string, f ...func())

func (*Builder) OCMCommonTransport

func (b *Builder) OCMCommonTransport(path string, fmt accessio.FileFormat, f ...func())

func (*Builder) OCMCompositionRepository

func (b *Builder) OCMCompositionRepository(name string, f ...func())

func (*Builder) OCMRepository

func (b *Builder) OCMRepository(spec ocm.RepositorySpec, f ...func())

func (*Builder) Platform

func (b *Builder) Platform(os string, arch string)

func (*Builder) PropagateError

func (b *Builder) PropagateError(errp *error, matchers ...exception.Matcher)

PropagateError can be used in defer to convert an composition error into an error return.

func (*Builder) Provider

func (b *Builder) Provider(name string, f ...func())

func (*Builder) RSAKeyPair

func (b *Builder) RSAKeyPair(name ...string)

TODO: switch to context local setting.

func (*Builder) ReadRSAKeyPair

func (b *Builder) ReadRSAKeyPair(name, path string)

func (*Builder) Reference

func (b *Builder) Reference(name, comp, vers string, f ...func())

func (*Builder) RemoveExtraIdentity

func (b *Builder) RemoveExtraIdentity(name string)

func (*Builder) RemoveLabel

func (b *Builder) RemoveLabel(name string)

func (*Builder) Resource

func (b *Builder) Resource(name, vers, typ string, relation metav1.ResourceRelation, f ...func())

func (*Builder) SetFailhandler

func (b *Builder) SetFailhandler(h ...env.FailHandler) *Builder

func (*Builder) Source

func (b *Builder) Source(name, vers, typ string, f ...func())

func (*Builder) Tags

func (b *Builder) Tags(tags ...string)

func (*Builder) Version

func (b *Builder) Version(name string, f ...func())

type State

type State struct{}