pack

README

pack - Buildpack CLI

pack is a tool to create runnable images from applications using buildpacks.

For information on buildpacks: buildpacks.io

Example Usage

./pack build packs/myimage:mytag --path ./myapp

The above will create images on your local daemon. If you wish to export images directly to a docker registry, use the --publish flag.

./pack build packs/myimage:mytag --path ./myapp --publish

Documentation

Index

• func Build(appDir, buildImage, runImage, repoName string, publish bool) error
• type BuildConfig
  • func (b *BuildConfig) Analyze() error
  • func (b *BuildConfig) Build() error
  • func (b *BuildConfig) Detect() (*lifecycle.BuildpackGroup, error)
  • func (b *BuildConfig) Export(group *lifecycle.BuildpackGroup) error
  • func (b *BuildConfig) Run() error
• type BuildFactory
  • func DefaultBuildFactory() (*BuildFactory, error)
  • func (bf *BuildFactory) BuildConfigFromFlags(f *BuildFlags) (*BuildConfig, error)
• type BuildFlags
• type BuilderConfig
• type BuilderFactory
  • func (f *BuilderFactory) BuilderConfigFromFlags(flags CreateBuilderFlags) (BuilderConfig, error)
  • func (f *BuilderFactory) Create(config BuilderConfig) error
• type Buildpack
• type CreateBuilderFlags
• type Docker
• type FS
• type Images

Functions

func Build

func Build(appDir, buildImage, runImage, repoName string, publish bool) error

Types

type BuildConfig

type BuildConfig struct {
	AppDir   string
	Builder  string
	RunImage string
	RepoName string
	Publish  bool
	// Above are copied from BuildFlags are set by init
	Cli    Docker
	Stdout io.Writer
	Stderr io.Writer
	Log    *log.Logger
	FS     FS
	Config *config.Config
	Images Images
	// Above are copied from BuildFactory
	WorkspaceVolume string
	CacheVolume     string
}

func (*BuildConfig) Analyze

func (b *BuildConfig) Analyze() error

func (*BuildConfig) Build

func (b *BuildConfig) Build() error

func (*BuildConfig) Detect

func (b *BuildConfig) Detect() (*lifecycle.BuildpackGroup, error)

func (*BuildConfig) Export

func (b *BuildConfig) Export(group *lifecycle.BuildpackGroup) error

func (*BuildConfig) Run

func (b *BuildConfig) Run() error

type BuildFactory

type BuildFactory struct {
	Cli    Docker
	Stdout io.Writer
	Stderr io.Writer
	Log    *log.Logger
	FS     FS
	Config *config.Config
	Images Images
}

func DefaultBuildFactory

func DefaultBuildFactory() (*BuildFactory, error)

func (*BuildFactory) BuildConfigFromFlags

func (bf *BuildFactory) BuildConfigFromFlags(f *BuildFlags) (*BuildConfig, error)

type BuildFlags

type BuildFlags struct {
	AppDir   string
	Builder  string
	RunImage string
	RepoName string
	Publish  bool
	NoPull   bool
}

type BuilderConfig

type BuilderConfig struct {
	RepoName   string
	Repo       img.Store
	Buildpacks []Buildpack                `toml:"buildpacks"`
	Groups     []lifecycle.BuildpackGroup `toml:"groups"`
	BaseImage  v1.Image
	BuilderDir string //original location of builder.toml, used for interpreting relative paths in buildpack URIs
}

type BuilderFactory

type BuilderFactory struct {
	Log    *log.Logger
	Docker Docker
	FS     FS
	Config *config.Config
	Images Images
}

func (*BuilderFactory) BuilderConfigFromFlags

func (f *BuilderFactory) BuilderConfigFromFlags(flags CreateBuilderFlags) (BuilderConfig, error)

func (*BuilderFactory) Create

func (f *BuilderFactory) Create(config BuilderConfig) error

type Buildpack

type Buildpack struct {
	ID  string
	URI string
}

type CreateBuilderFlags

type CreateBuilderFlags struct {
	RepoName        string
	BuilderTomlPath string
	StackID         string
	Publish         bool
	NoPull          bool
}

type Docker

type Docker interface {
	PullImage(ref string) error
	RunContainer(ctx context.Context, id string, stdout io.Writer, stderr io.Writer) error
	VolumeRemove(ctx context.Context, volumeID string, force bool) error
	ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, containerName string) (container.ContainerCreateCreatedBody, error)
	ContainerRemove(ctx context.Context, containerID string, options types.ContainerRemoveOptions) error
	CopyToContainer(ctx context.Context, containerID, dstPath string, content io.Reader, options types.CopyToContainerOptions) error
	CopyFromContainer(ctx context.Context, containerID, srcPath string) (io.ReadCloser, types.ContainerPathStat, error)
	ImageBuild(ctx context.Context, buildContext io.Reader, options types.ImageBuildOptions) (types.ImageBuildResponse, error)
	ImageInspectWithRaw(ctx context.Context, imageID string) (types.ImageInspect, []byte, error)
}

type FS

type FS interface {
	CreateTGZFile(tarFile, srcDir, tarDir string, uid, gid int) error
	CreateTarReader(srcDir, tarDir string, uid, gid int) (io.Reader, chan error)
	Untar(r io.Reader, dest string) error
	CreateSingleFileTar(path, txt string) (io.Reader, error)
}

type Images

type Images interface {
	ReadImage(repoName string, useDaemon bool) (v1.Image, error)
	RepoStore(repoName string, useDaemon bool) (img.Store, error)
}