common

Documentation

Overview

Package common provides basic interfaces and utility function used to build OCI image with buildah api in go.

Index

• func BuildMain(builderFile BuilderFile) (err error)
• type BuilderFile

Functions

func BuildMain

func BuildMain(builderFile BuilderFile) (err error)

Main function that build the images using buildah go API

Types

type BuilderFile

type BuilderFile interface {
	// NewStorage function used to obtain the buildah storage, requied to
	// build a OCI image
	NewStorage() (store storage.Store, err error)
	// NewBuildOpts function used to obtain the build options for the specific
	// image
	NewBuildOpts() (opts buildah.BuilderOptions, err error)
	// Compose function used to run all the instruction tha compose the whole
	// images, like all the instructions in a dockerfile
	Compose(b *buildah.Builder) (err error)
	// Image name
	Name() (name string)
}

Interface that wraps all the methods needed to build an OCI image