extend

Documentation

Overview

Package extend contains extensions specific helpers

Index

• Constants
• func ValidateConfig(configPath string) error
• type Arg
• type BuildConfig
• type Config
• type ContextInfo
  • func FindContexts(extensionID string, extOutputDir string, logger log.Logger) ([]ContextInfo, error)
• type Dockerfile
• type Options

Constants

const (
	// BuildContextDir defines the context for build-image extensions
	BuildContextDir = "context.build"
	// RunContextDir defines the context for run-image extensions
	RunContextDir = "context.run"
	// SharedContextDir defines a shared context for build- and run-image extensions
	SharedContextDir = "context"
)

Functions

func ValidateConfig

func ValidateConfig(configPath string) error

Types

type Arg

type Arg struct {
	Name  string `toml:"name"`
	Value string `toml:"value"`
}

type BuildConfig

type BuildConfig struct {
	Args []Arg `toml:"args"`
}

type Config

type Config struct {
	Build BuildConfig `toml:"build"`
	Run   BuildConfig `toml:"run"`
}

type ContextInfo

type ContextInfo struct {
	ExtensionID string
	Path        string
}

ContextInfo captures info about the context used for build- and run-image extensions

func FindContexts

func FindContexts(extensionID string, extOutputDir string, logger log.Logger) ([]ContextInfo, error)

FindContexts returns paths to Build Context folders produced by an extension. If Shared Context is provided with Run or Build Contexts the error will be thrown.

type Dockerfile

type Dockerfile struct {
	ExtensionID string
	Path        string `toml:"path"`
	Args        []Arg
	ContextDir  string
}

type Options

type Options struct {
	BuildContext string
	IgnorePaths  []string
	CacheTTL     time.Duration
}