builder

Documentation

Index

• Variables
• func DefaultImageName(buildContext string) (string, error)
• func GetDirFromBuildContext(ctx string) string
• func IsDirContext(ctx string) bool
• func IsGitContext(ctx string) bool
• type ArgInterface
• type BuildArg
  • func (b *BuildArg) GetKey() string
  • func (b *BuildArg) GetValue() string
• type Builder
• type BuilderOptions
• type CacheOptions
  • func (c *CacheOptions) Default(buildContext string) (*CacheOptions, error)
• type CustomArg
  • func (c *CustomArg) GetKey() string
  • func (c *CustomArg) GetValue() string
• type DirContext
  • func (d DirContext) BuildContext() string
• type Error
• type GitContext
  • func (g *GitContext) BuildContext() (string, error)

Variables

var (
	ErrBuildContextEmpty = errors.New("BuildContextEmpty", "build context cannot be empty")
)

Functions

func DefaultImageName

func DefaultImageName(buildContext string) (string, error)

func GetDirFromBuildContext

func GetDirFromBuildContext(ctx string) string

func IsDirContext

func IsDirContext(ctx string) bool

func IsGitContext

func IsGitContext(ctx string) bool

Types

type ArgInterface

type ArgInterface interface {
	GetKey() string
	GetValue() string
}

type BuildArg

type BuildArg struct {
	Value string
}

BuildArg is a build argument that can be passed to the builder.

func (*BuildArg) GetKey

func (b *BuildArg) GetKey() string

func (*BuildArg) GetValue

func (b *BuildArg) GetValue() string

type Builder

type Builder interface {
	Build(ctx context.Context, b *BuilderOptions) (logs string, err error)
}

type BuilderOptions

type BuilderOptions struct {
	ImageName    string
	BuildContext string
	Args         []ArgInterface
	Destination  string
	Cache        *CacheOptions
}

type CacheOptions

type CacheOptions struct {
	Enabled bool
	Dir     string
	Repo    string
}

func (*CacheOptions) Default

func (c *CacheOptions) Default(buildContext string) (*CacheOptions, error)

type CustomArg

type CustomArg struct {
	Key   string
	Value string
}

CustomArg is a custom argument that can be passed to the builder.

func (*CustomArg) GetKey

func (c *CustomArg) GetKey() string

func (*CustomArg) GetValue

func (c *CustomArg) GetValue() string

type DirContext

type DirContext struct {
	Path string // This path must be an absolute path
}

func (DirContext) BuildContext

func (d DirContext) BuildContext() string

type Error

type Error = errors.Error

type GitContext

type GitContext struct {
	Repo     string
	Branch   string
	Commit   string
	Username string
	Password string
}

func (*GitContext) BuildContext

func (g *GitContext) BuildContext() (string, error)

This build context follows Kaniko build context pattern ref: https://github.com/GoogleContainerTools/kaniko#kaniko-build-contexts