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

Currently we recommend using the development detect image

./pack build <REPONAME> [-p <PATH to APP>] --detect-image packsdev/v3:detect

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

./pack build myorg/myapp -p fixtures/node_app --detect-image packsdev/v3:detect --publish

Documentation

Index

• func Build(appDir, buildImage, runImage, repoName string, publish bool) error
• type BuildFlags
  • func (b *BuildFlags) Analyze() error
  • func (b *BuildFlags) Build() error
  • func (b *BuildFlags) Close() error
  • func (b *BuildFlags) Detect() (*lifecycle.BuildpackGroup, error)
  • func (b *BuildFlags) Export(group *lifecycle.BuildpackGroup) error
  • func (b *BuildFlags) Init() error
  • func (b *BuildFlags) Run() error
• type BuilderConfig
• type BuilderFactory
  • func (f *BuilderFactory) Create(config BuilderConfig) error
• type Buildpack
• type FS
• type Stack
  • func DefaultStack(noPull bool) (Stack, error)

Functions

func Build

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

Types

type BuildFlags

type BuildFlags struct {
	AppDir   string
	Builder  string
	RunImage string
	RepoName string
	Publish  bool
	NoPull   bool
	// Below are set by init
	Cli             *docker.Docker
	WorkspaceVolume string
	CacheVolume     string
	Stdout          io.Writer
	Stderr          io.Writer
	Log             *log.Logger
	FS              FS
}

func (*BuildFlags) Analyze

func (b *BuildFlags) Analyze() error

func (*BuildFlags) Build

func (b *BuildFlags) Build() error

func (*BuildFlags) Close

func (b *BuildFlags) Close() error

func (*BuildFlags) Detect

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

func (*BuildFlags) Export

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

func (*BuildFlags) Init

func (b *BuildFlags) Init() error

func (*BuildFlags) Run

func (b *BuildFlags) Run() error

type BuilderConfig

type BuilderConfig struct {
	RepoName   string
	Buildpacks []Buildpack                `toml:"buildpacks"`
	Groups     []lifecycle.BuildpackGroup `toml:"groups"`
	Stack      Stack
	NoPull     bool
}

type BuilderFactory

type BuilderFactory struct {
	FS FS
}

func (*BuilderFactory) Create

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

type Buildpack

type Buildpack struct {
	ID  string
	URI string
}

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 Stack

type Stack struct {
	BuildImage v1.Image
}

func DefaultStack

func DefaultStack(noPull bool) (Stack, error)