pack

Documentation

Index

• Constants
• Variables
• func PackImageMapper(src *DockerImage) *docker.Image
• type Builder
  • func (b *Builder) Build(ctx context.Context, ui terminal.UI, jobInfo *component.JobInfo, ...) (*DockerImage, error)
  • func (b *Builder) BuildFunc() interface{}
  • func (b *Builder) Config() (interface{}, error)
  • func (b *Builder) Documentation() (*docs.Documentation, error)
• type BuilderConfig
• type DockerImage
  • func (*DockerImage) Descriptor() ([]byte, []int)
  • func (x *DockerImage) GetBuildLabels() map[string]string
  • func (x *DockerImage) GetImage() string
  • func (x *DockerImage) GetTag() string
  • func (i *DockerImage) Labels() map[string]string
  • func (*DockerImage) ProtoMessage()
  • func (x *DockerImage) ProtoReflect() protoreflect.Message
  • func (x *DockerImage) Reset()
  • func (x *DockerImage) String() string

Constants

const DefaultBuilder = "heroku/buildpacks:18"

Variables

var File_waypoint_builtin_pack_plugin_proto protoreflect.FileDescriptor

var Options = []sdk.Option{
	sdk.WithComponents(&Builder{}),
	sdk.WithMappers(PackImageMapper),
}

Options are the SDK options to use for instantiation.

Functions

func PackImageMapper

func PackImageMapper(src *DockerImage) *docker.Image

PackImageMapper maps a pack.DockerImage to our Image structure.

NOTE(mitchellh): the pack builder can probably just reuse the image from here but at the time of writing I was still building all the mapper subsystems so I wanted to test it out.

Types

type Builder

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

Builder uses `pack` -- the frontend for CloudNative Buildpacks -- to build an artifact from source.

func (*Builder) Build

func (b *Builder) Build(
	ctx context.Context,
	ui terminal.UI,
	jobInfo *component.JobInfo,
	src *component.Source,
) (*DockerImage, error)

Build

func (*Builder) BuildFunc

func (b *Builder) BuildFunc() interface{}

BuildFunc implements component.Builder

func (*Builder) Config

func (b *Builder) Config() (interface{}, error)

Config implements Configurable

func (*Builder) Documentation

func (b *Builder) Documentation() (*docs.Documentation, error)

type BuilderConfig

type BuilderConfig struct {
	// Control whether or not to inject the entrypoint binary into the resulting image
	DisableCEB bool `hcl:"disable_entrypoint,optional"`

	// The Buildpack builder image to use, defaults to the standard heroku one.
	Builder string `hcl:"builder,optional"`

	// Environment variables that are meant to configure the application in a static
	// way. This might be control an image that has mulitple modes of operation,
	// selected via environment variable. Most configuration should use the waypoint
	// config commands.
	StaticEnvVars map[string]string `hcl:"static_environment,optional"`
}

Config is the configuration structure for the registry.

type DockerImage

type DockerImage struct {
	Image       string            `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	Tag         string            `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
	BuildLabels map[string]string `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

DockerImage is the artifact type for the builder.

func (*DockerImage) Descriptor

func (*DockerImage) Descriptor() ([]byte, []int)

Deprecated: Use DockerImage.ProtoReflect.Descriptor instead.

func (*DockerImage) GetBuildLabels

func (x *DockerImage) GetBuildLabels() map[string]string

func (*DockerImage) GetImage

func (x *DockerImage) GetImage() string

func (*DockerImage) GetTag

func (x *DockerImage) GetTag() string

func (*DockerImage) Labels

func (i *DockerImage) Labels() map[string]string

func (*DockerImage) ProtoMessage

func (*DockerImage) ProtoMessage()

func (*DockerImage) ProtoReflect

func (x *DockerImage) ProtoReflect() protoreflect.Message

func (*DockerImage) Reset

func (x *DockerImage) Reset()

func (*DockerImage) String

func (x *DockerImage) String() string