build

Documentation

Index

• type Assertion
  • func RequireGroupFile(optional bool) Assertion
  • func RequirePasswdFile(optional bool) Assertion
• type Context
  • func New(workDir string, opts ...Option) (*Context, error)
  • func (bc *Context) BuildImage() error
  • func (bc *Context) BuildLayer() (string, error)
  • func (bc *Context) BuildTarball() (string, error)
  • func (bc *Context) GenerateImageSBOM(arch types.Architecture, img coci.SignedImage) error
  • func (bc *Context) GenerateIndexSBOM(indexDigest name.Digest, imgs map[types.Architecture]coci.SignedImage) error
  • func (bc *Context) GenerateSBOM() error
  • func (bc *Context) Logger() *logrus.Entry
  • func (bc *Context) Refresh() error
  • func (bc *Context) SetImplementation(i buildImplementation)
  • func (bc *Context) Summarize()
• type Option
  • func WithAnnotations(annotations map[string]string) Option
  • func WithArch(arch types.Architecture) Option
  • func WithAssertions(a ...Assertion) Option
  • func WithBuildDate(s string) Option
  • func WithConfig(configFile string) Option
  • func WithDebugLogging(enable bool) Option
  • func WithDockerMediatypes(useDockerMediaTypes bool) Option
  • func WithExtraKeys(keys []string) Option
  • func WithExtraRepos(repos []string) Option
  • func WithImageConfiguration(ic types.ImageConfiguration) Option
  • func WithProot(enable bool) Option
  • func WithSBOM(path string) Option
  • func WithSBOMFormats(formats []string) Option
  • func WithTags(tags ...string) Option
  • func WithTarball(path string) Option
  • func WithVCS(enable bool) Option
• type PathMutator

Types

type Assertion

type Assertion func(*Context) error

func RequireGroupFile

func RequireGroupFile(optional bool) Assertion

func RequirePasswdFile

func RequirePasswdFile(optional bool) Assertion

type Context

type Context struct {
	ImageConfiguration types.ImageConfiguration
	ImageConfigFile    string

	Assertions []Assertion
	Options    options.Options
	// contains filtered or unexported fields
}

func New

func New(workDir string, opts ...Option) (*Context, error)

New creates a build context. The SOURCE_DATE_EPOCH env variable is supported and will overwrite the provided timestamp if present.

func (*Context) BuildImage

func (bc *Context) BuildImage() error

func (*Context) BuildLayer

func (bc *Context) BuildLayer() (string, error)

func (*Context) BuildTarball

func (bc *Context) BuildTarball() (string, error)

func (*Context) GenerateImageSBOM

func (bc *Context) GenerateImageSBOM(arch types.Architecture, img coci.SignedImage) error

func (*Context) GenerateIndexSBOM

func (bc *Context) GenerateIndexSBOM(indexDigest name.Digest, imgs map[types.Architecture]coci.SignedImage) error

func (*Context) GenerateSBOM

func (bc *Context) GenerateSBOM() error

func (*Context) Logger

func (bc *Context) Logger() *logrus.Entry

func (*Context) Refresh

func (bc *Context) Refresh() error

func (*Context) SetImplementation

func (bc *Context) SetImplementation(i buildImplementation)

func (*Context) Summarize

func (bc *Context) Summarize()

type Option

type Option func(*Context) error

Option is an option for the build context.

func WithAnnotations

func WithAnnotations(annotations map[string]string) Option

WithAnnotations parses and populates the annotations in the ImageConfiguration

func WithArch

func WithArch(arch types.Architecture) Option

WithArch sets the architecture for the build context.

func WithAssertions

func WithAssertions(a ...Assertion) Option

WithAssertions adds assertions to validate the result of this build context. Assertions are checked in parallel at the end of the build process.

func WithBuildDate

func WithBuildDate(s string) Option

WithBuildDate sets the timestamps for the build context. The string is parsed according to RFC3339. An empty string is a special case and will default to the unix epoch.

func WithConfig

func WithConfig(configFile string) Option

WithConfig sets the image configuration for the build context. The image configuration is parsed from given config file.

func WithDebugLogging

func WithDebugLogging(enable bool) Option

WithDebugLogging sets the debug log level for the build context.

func WithDockerMediatypes

func WithDockerMediatypes(useDockerMediaTypes bool) Option

WithDockerMediatypes determine whether to use Docker mediatypes for the build context.

func WithExtraKeys

func WithExtraKeys(keys []string) Option

func WithExtraRepos

func WithExtraRepos(repos []string) Option

func WithImageConfiguration

func WithImageConfiguration(ic types.ImageConfiguration) Option

WithImageConfiguration sets the ImageConfiguration object to use when building.

func WithProot

func WithProot(enable bool) Option

WithProot enables proot for rootless image builds.

func WithSBOM

func WithSBOM(path string) Option

func WithSBOMFormats

func WithSBOMFormats(formats []string) Option

func WithTags

func WithTags(tags ...string) Option

WithTags sets the tags for the build context.

func WithTarball

func WithTarball(path string) Option

WithTarball sets the output path of the layer tarball.

func WithVCS

func WithVCS(enable bool) Option

WithVCS enables VCS URL probing for the build context.

type PathMutator

type PathMutator func(*options.Options, types.PathMutation) error