builders

Documentation

Overview

Package builders provides constants for builder implementation short names, shared error types and convienience functions.

Index

• Constants
• func Image(f fn.Function, builder string, defaults map[string]string) (string, error)
• type ErrBuilderNotSupported
  • func (e ErrBuilderNotSupported) Error() string
• type ErrNoDefaultImage
  • func (e ErrNoDefaultImage) Error() string
• type ErrRuntimeRequired
  • func (e ErrRuntimeRequired) Error() string
• type ErrUnknownBuilder
  • func (e ErrUnknownBuilder) Error() string
• type Known
  • func All() Known
  • func (k Known) String() string

Constants

const (
	Host    = "host"
	Pack    = "pack"
	S2I     = "s2i"
	Default = Pack
)

Functions

func Image

func Image(f fn.Function, builder string, defaults map[string]string) (string, error)

Image is a convenience function for choosing the correct builder image given a function, a builder, and defaults grouped by runtime.

• ErrRuntimeRequired if no runtime was provided on the given function
• ErrNoDefaultImage if the function has no builder image already defined for the given runtime and there is no default in the provided map.

Types

type ErrBuilderNotSupported

type ErrBuilderNotSupported struct {
	Builder string
}

ErrBuilderNotSupported

func (ErrBuilderNotSupported) Error

func (e ErrBuilderNotSupported) Error() string

type ErrNoDefaultImage

type ErrNoDefaultImage struct {
	Builder string
	Runtime string
}

ErrNoDefaultImage

func (ErrNoDefaultImage) Error

func (e ErrNoDefaultImage) Error() string

type ErrRuntimeRequired

type ErrRuntimeRequired struct {
	Builder string
}

ErrRuntimeRequired

func (ErrRuntimeRequired) Error

func (e ErrRuntimeRequired) Error() string

type ErrUnknownBuilder

type ErrUnknownBuilder struct {
	Name  string
	Known Known
}

ErrUnknownBuilder may be used by whomever is choosing a concrete implementation of a builder to invoke based on potentially invalid input.

func (ErrUnknownBuilder) Error

func (e ErrUnknownBuilder) Error() string

type Known

type Known []string

Known builder names with a pretty-printed string representation

func All

func All() Known

func (Known) String

func (k Known) String() string