builder

Documentation

Index

• Constants
• func BuildImage(image string, handler string, functionName string, language string, ...) error
• func CopyFiles(src, dest string) error
• func GetImageTagValues(tagType schema.BuildFormat, contextPath string) (branch, version string, err error)
• func PublishImage(image string, handler string, functionName string, language string, ...) error
• type FunctionMetadataSource
  • func NewFunctionMetadataSourceLive() FunctionMetadataSource
• type FunctionMetadataSourceLive
  • func (FunctionMetadataSourceLive) Get(tagType schema.BuildFormat, contextPath string) (branch, version string, err error)

Constants

const AdditionalPackageBuildArg = "ADDITIONAL_PACKAGE"

AdditionalPackageBuildArg holds the special build-arg keyname for use with build-opts. Can also be passed as a build arg hence needs to be accessed from commands

const BuilderConfigFilename = "com.openfaas.docker.config"

Functions

func BuildImage

func BuildImage(image string, handler string, functionName string, language string, nocache bool, squash bool, shrinkwrap bool, buildArgMap map[string]string, buildOptions []string, tagFormat schema.BuildFormat, buildLabelMap map[string]string, quietBuild bool, copyExtraPaths []string, remoteBuilder, payloadSecretPath string, forcePull bool) error

BuildImage construct Docker image from function parameters TODO: refactor signature to a struct to simplify the length of the method header

func CopyFiles

func CopyFiles(src, dest string) error

CopyFiles copies files from src to destination.

func GetImageTagValues

func GetImageTagValues(tagType schema.BuildFormat, contextPath string) (branch, version string, err error)

GetImageTagValues returns the image tag format and component information determined via GIT

func PublishImage

func PublishImage(image string, handler string, functionName string, language string, nocache bool, squash bool, shrinkwrap bool, buildArgMap map[string]string,
	buildOptions []string, tagMode schema.BuildFormat, buildLabelMap map[string]string, quietBuild bool, copyExtraPaths []string, platforms string, extraTags []string, remoteBuilder, payloadSecretPath string, forcePull bool) error

PublishImage will publish images as multi-arch TODO: refactor signature to a struct to simplify the length of the method header

Types

type FunctionMetadataSource

type FunctionMetadataSource interface {
	Get(tagType schema.BuildFormat, contextPath string) (branch, version string, err error)
}

func NewFunctionMetadataSourceLive

func NewFunctionMetadataSourceLive() FunctionMetadataSource

type FunctionMetadataSourceLive

type FunctionMetadataSourceLive struct {
}

func (FunctionMetadataSourceLive) Get

func (FunctionMetadataSourceLive) Get(tagType schema.BuildFormat, contextPath string) (branch, version string, err error)