pack

README

pack - Buildpack CLI

pack is a CLI implementation of the Platform Interface Specification for Cloud Native Buildpacks.

pack makes it easy for...

• Application developers to use Cloud Native Buildpacks to convert code into runnable images.
• Buildpack authors to develop and package buildpacks for distribution.

Usage

• Installing
• Getting Started
• Documentation

Contributing

For information on how to contribute to this project including its development process see CONTRIBUTING.md.

Resources

• Buildpack Specification
• Platform Specification

Documentation

Index

• type BuildOptions
• type BuilderInfo
• type BuildpackFetcher
• type BuildpackInfo
• type Client
  • func NewClient(opts ...ClientOption) (*Client, error)
  • func (c *Client) Build(ctx context.Context, opts BuildOptions) error
  • func (c *Client) CreateBuilder(ctx context.Context, opts CreateBuilderOptions) error
  • func (c *Client) InspectBuilder(name string, daemon bool) (*BuilderInfo, error)
  • func (c *Client) Rebase(ctx context.Context, opts RebaseOptions) error
  • func (c *Client) Run(ctx context.Context, opts RunOptions) error
• type ClientOption
  • func WithDockerClient(docker *dockerClient.Client) ClientOption
  • func WithLogger(l logging.Logger) ClientOption
• type CreateBuilderOptions
• type Downloader
  • func NewDownloader(logger logging.Logger, baseCacheDir string) *Downloader
  • func (d *Downloader) Download(pathOrUri string) (string, error)
• type ImageFetcher
• type Lifecycle
• type LifecycleFetcher
• type ProxyConfig
• type RebaseOptions
• type RunOptions

Types

type BuildOptions

type BuildOptions struct {
	Image             string              // required
	Builder           string              // required
	AppPath           string              // defaults to current working directory
	RunImage          string              // defaults to the best mirror from the builder metadata or AdditionalMirrors
	AdditionalMirrors map[string][]string // only considered if RunImage is not provided
	Env               map[string]string
	Publish           bool
	NoPull            bool
	ClearCache        bool
	Buildpacks        []string
	ProxyConfig       *ProxyConfig // defaults to  environment proxy vars
}

type BuilderInfo

type BuilderInfo struct {
	Description      string
	Stack            string
	RunImage         string
	RunImageMirrors  []string
	Buildpacks       []builder.BuildpackMetadata
	Groups           []builder.GroupMetadata
	LifecycleVersion string
}

type BuildpackFetcher

type BuildpackFetcher interface {
	FetchBuildpack(uri string) (buildpack.Buildpack, error)
}

type BuildpackInfo

type BuildpackInfo struct {
	ID      string
	Version string
	Latest  bool
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts ...ClientOption) (*Client, error)

func (*Client) Build

func (c *Client) Build(ctx context.Context, opts BuildOptions) error

func (*Client) CreateBuilder

func (c *Client) CreateBuilder(ctx context.Context, opts CreateBuilderOptions) error

func (*Client) InspectBuilder

func (c *Client) InspectBuilder(name string, daemon bool) (*BuilderInfo, error)

func (*Client) Rebase

func (c *Client) Rebase(ctx context.Context, opts RebaseOptions) error

func (*Client) Run

func (c *Client) Run(ctx context.Context, opts RunOptions) error

type ClientOption

type ClientOption func(c *Client)

func WithDockerClient

func WithDockerClient(docker *dockerClient.Client) ClientOption

WithDockerClient supply your own docker client.

func WithLogger

func WithLogger(l logging.Logger) ClientOption

WithLogger supply your own logger.

type CreateBuilderOptions

type CreateBuilderOptions struct {
	BuilderName   string
	BuilderConfig builder.Config
	Publish       bool
	NoPull        bool
}

type Downloader

type Downloader struct {
	// contains filtered or unexported fields
}

func NewDownloader

func NewDownloader(logger logging.Logger, baseCacheDir string) *Downloader

func (*Downloader) Download

func (d *Downloader) Download(pathOrUri string) (string, error)

type ImageFetcher

type ImageFetcher interface {
	Fetch(ctx context.Context, name string, daemon, pull bool) (imgutil.Image, error)
}

type Lifecycle

type Lifecycle interface {
	Execute(ctx context.Context, opts build.LifecycleOptions) error
}

type LifecycleFetcher

type LifecycleFetcher interface {
	Fetch(version *semver.Version, uri string) (lifecycle.Metadata, error)
}

type ProxyConfig

type ProxyConfig struct {
	HTTPProxy  string
	HTTPSProxy string
	NoProxy    string
}

type RebaseOptions

type RebaseOptions struct {
	RepoName          string
	Publish           bool
	SkipPull          bool
	RunImage          string
	AdditionalMirrors map[string][]string
}

type RunOptions

type RunOptions struct {
	AppPath    string // defaults to current working directory
	Builder    string // defaults to default builder on the client config
	RunImage   string // defaults to the best mirror from the builder image
	Env        map[string]string
	NoPull     bool
	ClearCache bool
	Buildpacks []string
	Ports      []string
}