pack

README

pack - Buildpack CLI

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

pack makes it easy for...

• App Developers to use buildpacks to convert code into runnable images.
• Buildpack Authors to develop and package buildpacks for distribution.
• Operators to package buildpacks for distribution and maintain applications.

Usage

• Installing
• Getting Started

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 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) CreatePackage(ctx context.Context, opts CreatePackageOptions) error
  • func (c *Client) InspectBuilder(name string, daemon bool) (*BuilderInfo, error)
  • func (c *Client) InspectImage(name string, daemon bool) (*ImageInfo, error)
  • func (c *Client) Rebase(ctx context.Context, opts RebaseOptions) error
  • func (c *Client) Run(ctx context.Context, opts RunOptions) error
• type ClientOption
  • func WithCacheDir(path string) ClientOption
  • func WithDockerClient(docker *dockerClient.Client) ClientOption
  • func WithDownloader(d Downloader) ClientOption
  • func WithFetcher(f ImageFetcher) ClientOption
  • func WithImageFactory(f ImageFactory) ClientOption
  • func WithLogger(l logging.Logger) ClientOption
• type ContainerConfig
• type CreateBuilderOptions
• type CreatePackageOptions
• type DefaultImageFactory
  • func (f *DefaultImageFactory) NewImage(repoName string, local bool) (imgutil.Image, error)
• type Downloader
• type ImageFactory
• type ImageFetcher
• type ImageInfo
• type Lifecycle
• 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
	ContainerConfig   ContainerConfig
}

type BuilderInfo

type BuilderInfo struct {
	Description     string
	Stack           string
	RunImage        string
	RunImageMirrors []string
	Buildpacks      []builder.BuildpackMetadata
	Order           dist.Order
	Lifecycle       builder.LifecycleDescriptor
	CreatedBy       builder.CreatorMetadata
}

type BuildpackInfo

type BuildpackInfo struct {
	ID      string
	Version string
}

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) CreatePackage

func (c *Client) CreatePackage(ctx context.Context, opts CreatePackageOptions) error

func (*Client) InspectBuilder

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

func (*Client) InspectImage

func (c *Client) InspectImage(name string, daemon bool) (*ImageInfo, 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 WithCacheDir

func WithCacheDir(path string) ClientOption

WithCacheDir supply your own cache directory.

Deprecated: use WithDownloader instead.

func WithDockerClient

func WithDockerClient(docker *dockerClient.Client) ClientOption

WithDockerClient supply your own docker client.

func WithDownloader

func WithDownloader(d Downloader) ClientOption

WithDownloader supply your own downloader.

func WithFetcher

func WithFetcher(f ImageFetcher) ClientOption

WithFetcher supply your own fetcher.

func WithImageFactory

func WithImageFactory(f ImageFactory) ClientOption

WithImageFactory supply your own image factory.

func WithLogger

func WithLogger(l logging.Logger) ClientOption

WithLogger supply your own logger.

type ContainerConfig

type ContainerConfig struct {
	Network string
}

type CreateBuilderOptions

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

type CreatePackageOptions

type CreatePackageOptions struct {
	Name    string
	Config  buildpackage.Config
	Publish bool
}

type DefaultImageFactory

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

func (*DefaultImageFactory) NewImage

func (f *DefaultImageFactory) NewImage(repoName string, local bool) (imgutil.Image, error)

type Downloader

type Downloader interface {
	Download(ctx context.Context, pathOrURI string) (blob.Blob, error)
}

type ImageFactory

type ImageFactory interface {
	NewImage(repoName string, local bool) (imgutil.Image, error)
}

type ImageFetcher

type ImageFetcher interface {
	// Fetch fetches an image by resolving it both remotely and locally depending on provided parameters.
	// If daemon is true, it will look return a `local.Image`. Pull, applicable only when daemon is true, will
	// attempt to pull a remote image first.
	Fetch(ctx context.Context, name string, daemon, pull bool) (imgutil.Image, error)
}

type ImageInfo

type ImageInfo struct {
	StackID    string
	Buildpacks []metadata.BuildpackMetadata
	Base       metadata.RunImageMetadata
	BOM        interface{}
	Stack      metadata.StackMetadata
}

type Lifecycle

type Lifecycle interface {
	Execute(ctx context.Context, opts build.LifecycleOptions) 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
}