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) FixateApkWorld() error
  • func (bc *Context) GenerateSBOM() error
  • func (bc *Context) InitApkDB() error
  • func (bc *Context) InitApkKeyring() (err error)
  • func (bc *Context) InitApkRepositories() error
  • func (bc *Context) InitApkWorld() error
  • func (bc *Context) InstallBusyboxSymlinks() error
  • func (bc *Context) MutateAccounts() error
  • func (bc *Context) Refresh() error
  • func (bc *Context) Summarize()
  • func (bc *Context) UpdatePrefix()
• type Option
  • func WithArch(arch types.Architecture) Option
  • func WithAssertions(a ...Assertion) Option
  • func WithBuildDate(s string) Option
  • func WithConfig(configFile string) 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

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
	WorkDir            string
	TarballPath        string
	UseProot           bool
	Tags               []string
	SourceDateEpoch    time.Time
	Assertions         []Assertion
	WantSBOM           bool
	SBOMPath           string
	SBOMFormats        []string
	ExtraKeyFiles      []string
	ExtraRepos         []string
	Arch               types.Architecture

	Log *log.Logger
	// 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

Builds the image in Context.WorkDir.

func (*Context) BuildLayer

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

func (*Context) BuildTarball

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

func (*Context) FixateApkWorld

func (bc *Context) FixateApkWorld() error

Force apk's resolver to re-resolve the requested dependencies in /etc/apk/world.

func (*Context) GenerateSBOM

func (bc *Context) GenerateSBOM() error

GenerateSBOM runs the sbom generation

func (*Context) InitApkDB

func (bc *Context) InitApkDB() error

Initialize the APK database for a given build context. It is assumed that the build context itself is properly set up, and that `bc.WorkDir` is set to the path of a working directory.

func (*Context) InitApkKeyring

func (bc *Context) InitApkKeyring() (err error)

Installs the specified keys into the APK keyring inside the build context.

func (*Context) InitApkRepositories

func (bc *Context) InitApkRepositories() error

Generates a specified /etc/apk/repositories file in the build context.

func (*Context) InitApkWorld

func (bc *Context) InitApkWorld() error

Generates a specified /etc/apk/world file in the build context.

func (*Context) InstallBusyboxSymlinks

func (bc *Context) InstallBusyboxSymlinks() error

Installs the BusyBox symlinks, if appropriate.

func (*Context) MutateAccounts

func (bc *Context) MutateAccounts() error

func (*Context) Refresh

func (bc *Context) Refresh() error

func (*Context) Summarize

func (bc *Context) Summarize()

func (*Context) UpdatePrefix

func (bc *Context) UpdatePrefix()

type Option

type Option func(*Context) error

Option is an option for the build context.

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 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.