build

Documentation

Index

• Constants
• type BuildApplication
• type Dispatcher
• type Handler
  • func NewHandler(p PlanFactorier, a BuildApplication) *Handler
  • func (h *Handler) Handler(ctx context.Context, imageName string, options *Options) error
• type Options
• type PlanFactorier

Constants

const AssignmentTokenSymbol = '='

Types

type BuildApplication

type BuildApplication interface {
	Build(ctx context.Context, buildPlan build.Planner, name string, version []string, options *build.Options, optionsFunc ...build.OptionsFunc) error
}

BuildApplication is the service for build commands

type Dispatcher

type Dispatcher interface {
	Start(ctx context.Context, opts ...dispatch.OptionsFunc) error
	Enqueue(scheduler.Jobber)
}

Dispatcher is a dispatcher for build commands

type Handler

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

Handler is a handler for build commands

func NewHandler

func NewHandler(p PlanFactorier, a BuildApplication) *Handler

NewHandler creates a new handler for build commands

func (*Handler) Handler

func (h *Handler) Handler(ctx context.Context, imageName string, options *Options) error

Handler handles build commands

type Options

type Options struct {
	// AnsibleConnectionLocal if is true ansible driver uses local connection
	AnsibleConnectionLocal bool
	// AnsibleIntermediateContainerName is the name of an intermediate container that can be used during ansible build process
	AnsibleIntermediateContainerName string
	// AnsibleInventoryPath is the path to the ansible inventory file ??
	AnsibleInventoryPath string
	// AnsibleLimit is the ansible limit ??
	AnsibleLimit string
	// BuildOnCascade if is true the build should be cascaded: ???
	BuildOnCascade bool
	// CascadeDepth is the number of levels to build when build on cascade is executed: ???
	CascadeDepth int
	// EnableSemanticVersionTags if is true semantic version tags are generated
	EnableSemanticVersionTags bool
	// ImageFromName is the name of the image to use as source
	ImageFromName string
	// ImageFromRegistryHost is the host of the registry to use as source
	ImageFromRegistryHost string
	// ImageFromRegistryNamespace is the namespace of the registry to use as source
	ImageFromRegistryNamespace string
	// ImageFromVersion is the version of the image to use as source
	ImageFromVersion string
	// ImageName is the name of the image to build
	ImageName string
	// ImageRegistryHost is the host of the registry to use
	ImageRegistryHost string
	// ImageRegistryNamespace is the namespace of the registry to use
	ImageRegistryNamespace string
	// Labels is the list of labes to assign to the image
	Labels []string
	// PersistentLabels is the list of persistent labels to use
	PersistentLabels []string
	// PersistentVars is the list of persistent vars to use
	PersistentVars []string
	// PullParentImage if is true the parent image is pull
	PullParentImage bool
	// PushImagesAfterBuild if is true the image is pushed after build
	PushImagesAfterBuild bool
	// RemoveImagesAfterPush if is true the images are removed from local after push
	RemoveImagesAfterPush bool
	// SemanticVersionTagsTemplates is the list of semantic version tags templates
	SemanticVersionTagsTemplates []string
	// Tags is the list of tags to generate
	Tags []string
	// Vars is the list of vars to use
	Vars []string
	// Versions is the list of versions to generate
	Versions []string
}

Options is the options for the build command

type PlanFactorier

type PlanFactorier interface {
	NewPlan(id string, parameters map[string]interface{}) (plan.Planner, error)
}

PlanFactorier interface defines the execution plan