buildcontrol

package
v0.20.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 4, 2021 License: Apache-2.0 Imports: 33 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var AllUpdateModes = []UpdateMode{
	UpdateModeAuto,
	UpdateModeImage,
	UpdateModeContainer,
	UpdateModeKubectlExec,
}
View Source 
var BaseWireSet = wire.NewSet(wire.Value(dockerfile.Labels{}), k8s.ProvideMinikubeClient, build.DefaultDockerBuilder, build.NewDockerImageBuilder, build.NewExecCustomBuilder, wire.Bind(new(build.CustomBuilder), new(*build.ExecCustomBuilder)), NewDockerComposeBuildAndDeployer,
	NewImageBuildAndDeployer,
	NewLiveUpdateBuildAndDeployer,
	NewLocalTargetBuildAndDeployer, containerupdate.NewDockerUpdater, containerupdate.NewExecUpdater, NewImageBuilder, tracer.InitOpenTelemetry, ProvideUpdateMode,
)
View Source 
var ImageBuildCount = &view.View{
	Name:        "image_build_count",
	Measure:     ImageBuildDuration,
	Aggregation: view.Count(),
	Description: "Image build count",
	TagKeys:     []tag.Key{KeyImageRef, KeyBuildError},
}
View Source 
var ImageBuildDuration = stats.Float64(
	"image_build_duration",
	"Image build duration",
	stats.UnitMilliseconds)

Loosely adapted from how opencensus does HTTP aggregations: https://github.com/census-instrumentation/opencensus-specs/blob/master/stats/HTTP.md#http-stats https://pkg.go.dev/go.opencensus.io/plugin/ochttp

View Source 
var ImageBuildDurationDistribution = view.Distribution(
	10, 100, 500, 1000, 2000, 5000,
	10000, 15000, 20000, 30000, 45000, 60000, 120000,
	240000, 480000, 1000000, 2000000, 5000000)
View Source 
var ImageBuildDurationView = &view.View{
	Name:        "image_build_duration_dist",
	Measure:     ImageBuildDuration,
	Aggregation: ImageBuildDurationDistribution,
	Description: "Image build time, by image ref",
	TagKeys:     []tag.Key{KeyImageRef, KeyBuildError},
}
View Source 
var K8sDeployCount = &view.View{
	Name:        "k8s_deploy_count",
	Measure:     K8sDeployDuration,
	Aggregation: view.Count(),
	Description: "K8s deploy count",
	TagKeys:     []octag.Key{keyResourceName, keyHasError},
}
View Source 
var K8sDeployDuration = stats.Float64(
	"k8s_deploy_duration",
	"K8s Deploy duration",
	stats.UnitMilliseconds)
View Source 
var K8sDeployDurationDistribution = view.Distribution(
	10, 100, 500, 1000, 2000, 5000,
	10000, 15000, 20000, 30000, 45000, 60000)
View Source 
var K8sDeployDurationView = &view.View{
	Name:        "k8s_deploy_duration_dist",
	Measure:     K8sDeployDuration,
	Aggregation: K8sDeployDurationDistribution,
	Description: "K8s Deploy time",
	TagKeys:     []octag.Key{keyResourceName, keyHasError},
}
View Source 
var K8sDeployObjects = stats.Int64("objects", "The number of objects deployed", "1")
View Source 
var K8sDeployObjectsCount = &view.View{
	Name:        "k8s_deploy_objects_count",
	Measure:     K8sDeployObjects,
	Aggregation: view.LastValue(),
	Description: "K8s objects per resource",
	TagKeys:     []octag.Key{keyResourceName, keyHasError},
}
View Source 
var KeyBuildError = tag.MustNewKey("build_error")
View Source 
var KeyImageRef = tag.MustNewKey("image_ref")

Metric and label names must match the following rules: https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels

Functions

func BuildTargets added in v0.19.5 

func BuildTargets(manifest model.Manifest) []model.TargetSpec

Extract target specs from a manifest for BuildAndDeploy.

func EarliestPendingAutoTriggerTarget 

func EarliestPendingAutoTriggerTarget(targets []*store.ManifestTarget) *store.ManifestTarget

Go through all the manifests, and check: 1) all pending file changes 2) all pending dependency changes (where an image has been rebuilt by another manifest), and 3) all pending manifest changes The earliest one is the one we want.

If no targets are pending, return nil

func FindDeployOnlyK8sManifestTargets 

func FindDeployOnlyK8sManifestTargets(targets []*store.ManifestTarget) []*store.ManifestTarget

func FindLocalTargets 

func FindLocalTargets(targets []*store.ManifestTarget) []*store.ManifestTarget

func FindTargetsNeedingInitialBuild added in v0.10.18 

func FindTargetsNeedingInitialBuild(targets []*store.ManifestTarget) []*store.ManifestTarget

func FindUnresourcedYAML 

func FindUnresourcedYAML(targets []*store.ManifestTarget) *store.ManifestTarget

func HasFileChangesTree added in v0.19.5 

func HasFileChangesTree(g model.TargetGraph, target model.TargetSpec, stateSet store.BuildStateSet) ([]model.TargetID, error)

Given a target, return all the target IDs in its tree of dependencies that have changed files.

func HoldK8sTargets added in v0.17.5 

func HoldK8sTargets(targets []*store.ManifestTarget, holds HoldSet)

func HoldLiveUpdateTargetsWaitingOnDeploy added in v0.17.5 

func HoldLiveUpdateTargetsWaitingOnDeploy(state store.EngineState, mts []*store.ManifestTarget, holds HoldSet)

func HoldTargetsWaitingOnDependencies added in v0.17.5 

func HoldTargetsWaitingOnDependencies(state store.EngineState, mts []*store.ManifestTarget, holds HoldSet)

func HoldTargetsWithBuildingComponents added in v0.17.5 

func HoldTargetsWithBuildingComponents(mts []*store.ManifestTarget, holds HoldSet)

func HoldUnparallelizableLocalTargets added in v0.17.5 

func HoldUnparallelizableLocalTargets(targets []*store.ManifestTarget, holds map[model.ManifestName]store.Hold)

func InjectImageDependencies added in v0.19.5 

func InjectImageDependencies(iTarget model.ImageTarget, iTargetMap map[model.TargetID]model.ImageTarget, deps []store.BuildResult) (model.ImageTarget, error)

Create a new ImageTarget with the Dockerfiles rewritten with the injected images.

func IsBuildingAnything added in v0.14.0 

func IsBuildingAnything(state store.EngineState) bool

func IsBuildingUncategorizedYAML added in v0.16.0 

func IsBuildingUncategorizedYAML(state store.EngineState) bool

func IsBuildingUnparallelizableLocalTarget added in v0.17.2 

func IsBuildingUnparallelizableLocalTarget(state store.EngineState) bool

func IsDontFallBackError added in v0.10.25 

func IsDontFallBackError(err error) bool

func IsFatalError added in v0.10.25 

func IsFatalError(err error) bool

A permanent error indicates that the whole build pipeline needs to stop. It will never recover, even on subsequent rebuilds.

func IsImageDeployedToDC added in v0.19.5 

func IsImageDeployedToDC(iTarget model.ImageTarget, dcTarget model.DockerComposeTarget) bool

Returns true if the given image is deployed to one of the given docker-compose targets. Note that some images are injected into other images, so may never be deployed.

func IsImageDeployedToK8s added in v0.19.5 

func IsImageDeployedToK8s(iTarget model.ImageTarget, kTarget model.K8sTarget) bool

Returns true if the given image is deployed to one of the given k8s targets. Note that some images are injected into other images, so may never be deployed.

func IsLiveUpdateTargetWaitingOnDeploy added in v0.17.5 

func IsLiveUpdateTargetWaitingOnDeploy(state store.EngineState, mt *store.ManifestTarget) bool

func LogBuildEntry added in v0.14.2 

func LogBuildEntry(ctx context.Context, entry BuildEntry)

func NextManifestNameToBuild 

func NextManifestNameToBuild(state store.EngineState) model.ManifestName

func NextUnbuiltTargetToBuild 

func NextUnbuiltTargetToBuild(unbuilt []*store.ManifestTarget) *store.ManifestTarget

Helper function for ordering targets that have never been built before.

func ShouldFallBackForErr added in v0.10.25 

func ShouldFallBackForErr(err error) bool

func WrapDontFallBackError added in v0.10.25 

func WrapDontFallBackError(err error) error

Types

type BuildAndDeployer added in v0.19.5 

type BuildAndDeployer interface {

	// Returns a BuildResultSet containing output (build result and associated
	// file changes) for each target built in this call. The BuildResultSet only
	// contains results for newly built targets--if a target was clean and didn't
	// need to be built, it doesn't appear in the result set.
	//
	// BuildResult can be used to construct a set of BuildStates, which contain
	// the last successful builds of each target and the files changed since that
	// build.
	BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, currentState store.BuildStateSet) (store.BuildResultSet, error)
}

type BuildCompleteAction added in v0.10.25 

type BuildCompleteAction struct {
	ManifestName model.ManifestName
	SpanID       logstore.SpanID
	Result       store.BuildResultSet
	FinishTime   time.Time
	Error        error
}

func NewBuildCompleteAction added in v0.10.25 

func NewBuildCompleteAction(mn model.ManifestName, spanID logstore.SpanID, result store.BuildResultSet, err error) BuildCompleteAction

func (BuildCompleteAction) Action added in v0.10.25 

func (BuildCompleteAction) Action()

type BuildEntry added in v0.14.2 

type BuildEntry interface {
	Name() model.ManifestName
	BuildReason() model.BuildReason
	FilesChanged() []string
}

type BuildHandler added in v0.14.0 

type BuildHandler func(
	target model.TargetSpec,
	depResults []store.BuildResult) (store.BuildResult, error)

Allows the caller to inject its own build strategy for dirty targets.

type BuildStartedAction added in v0.10.25 

type BuildStartedAction struct {
	ManifestName       model.ManifestName
	StartTime          time.Time
	FilesChanged       []string
	Reason             model.BuildReason
	SpanID             logstore.SpanID
	FullBuildTriggered bool
}

func (BuildStartedAction) Action added in v0.10.25 

func (BuildStartedAction) Action()

type DockerComposeBuildAndDeployer added in v0.19.5 

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

func NewDockerComposeBuildAndDeployer added in v0.19.5 

func NewDockerComposeBuildAndDeployer(dcc dockercompose.DockerComposeClient, dc docker.Client,
	ib *ImageBuilder, c build.Clock) *DockerComposeBuildAndDeployer

func ProvideDockerComposeBuildAndDeployer added in v0.19.5 

func ProvideDockerComposeBuildAndDeployer(ctx context.Context, dcCli dockercompose.DockerComposeClient, dCli docker.Client, dir *dirs.TiltDevDir) (*DockerComposeBuildAndDeployer, error)

func (*DockerComposeBuildAndDeployer) BuildAndDeploy added in v0.19.5 

func (bd *DockerComposeBuildAndDeployer) BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, currentState store.BuildStateSet) (res store.BuildResultSet, err error)

type DontFallBackError added in v0.10.25 

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

Something is wrong enough that we shouldn't bother falling back to other BaD's -- they won't work.

func DontFallBackErrorf added in v0.10.25 

func DontFallBackErrorf(msg string, a ...interface{}) DontFallBackError

type HoldSet added in v0.17.5 

type HoldSet map[model.ManifestName]store.Hold

func NextTargetToBuild 

func NextTargetToBuild(state store.EngineState) (*store.ManifestTarget, HoldSet)

Algorithm to choose a manifest to build next.

func (HoldSet) AddHold added in v0.17.5 

func (s HoldSet) AddHold(target *store.ManifestTarget, hold store.Hold)

func (HoldSet) Fill added in v0.17.5 

func (s HoldSet) Fill(targets []*store.ManifestTarget, hold store.Hold)

For all the targets that should have built and don't have a prior Hold, add the given Hold.

func (HoldSet) RemoveIneligibleTargets added in v0.17.5 

func (s HoldSet) RemoveIneligibleTargets(targets []*store.ManifestTarget) []*store.ManifestTarget

type ImageBuildAndDeployer added in v0.19.5 

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

func NewImageBuildAndDeployer added in v0.19.5 

func NewImageBuildAndDeployer(
	db build.DockerBuilder,
	customBuilder build.CustomBuilder,
	k8sClient k8s.Client,
	env k8s.Env,
	analytics *analytics.TiltAnalytics,
	updMode UpdateMode,
	c build.Clock,
	runtime container.Runtime,
	kl KINDLoader,
) *ImageBuildAndDeployer

func ProvideImageBuildAndDeployer added in v0.19.5 

func ProvideImageBuildAndDeployer(ctx context.Context, docker2 docker.Client, kClient k8s.Client, env k8s.Env, dir *dirs.TiltDevDir, clock build.Clock, kp KINDLoader, analytics2 *analytics.TiltAnalytics) (*ImageBuildAndDeployer, error)

func (*ImageBuildAndDeployer) BuildAndDeploy added in v0.19.5 

func (ibd *ImageBuildAndDeployer) BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, stateSet store.BuildStateSet) (resultSet store.BuildResultSet, err error)

type ImageBuilder added in v0.19.5 

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

func NewImageBuilder added in v0.19.5 

func NewImageBuilder(db build.DockerBuilder, custb build.CustomBuilder, updateMode UpdateMode) *ImageBuilder

func (*ImageBuilder) Build added in v0.19.5 

func (icb *ImageBuilder) Build(ctx context.Context, iTarget model.ImageTarget,
	ps *build.PipelineState) (refs container.TaggedRefs, err error)

func (*ImageBuilder) CanReuseRef added in v0.19.5 

func (icb *ImageBuilder) CanReuseRef(ctx context.Context, iTarget model.ImageTarget, ref reference.NamedTagged) (bool, error)

type KINDLoader added in v0.19.5 

type KINDLoader interface {
	LoadToKIND(ctx context.Context, ref reference.NamedTagged) error
}

func NewKINDLoader added in v0.19.5 

func NewKINDLoader(env k8s.Env, clusterName k8s.ClusterName) KINDLoader

type LiveUpdateBuildAndDeployer added in v0.19.5 

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

func NewLiveUpdateBuildAndDeployer added in v0.19.5 

func NewLiveUpdateBuildAndDeployer(dcu *containerupdate.DockerUpdater,
	ecu *containerupdate.ExecUpdater,
	updMode UpdateMode, env k8s.Env, runtime container.Runtime, c build.Clock) *LiveUpdateBuildAndDeployer

func (*LiveUpdateBuildAndDeployer) BuildAndDeploy added in v0.19.5 

func (lubad *LiveUpdateBuildAndDeployer) BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, stateSet store.BuildStateSet) (store.BuildResultSet, error)

type LocalTargetBuildAndDeployer added in v0.19.5 

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

TODO(maia): CommandRunner interface for testability

func NewLocalTargetBuildAndDeployer added in v0.19.5 

func NewLocalTargetBuildAndDeployer(c build.Clock) *LocalTargetBuildAndDeployer

func (*LocalTargetBuildAndDeployer) BuildAndDeploy added in v0.19.5 

func (bd *LocalTargetBuildAndDeployer) BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, stateSet store.BuildStateSet) (resultSet store.BuildResultSet, err error)

type RedirectToNextBuilder added in v0.10.25 

type RedirectToNextBuilder struct {
	Level logger.Level
	// contains filtered or unexported fields
}

Nothing is on fire, this is an expected case like a container builder being passed a build with no attached container. `level` indicates at what log level this error should be shown to the user

func RedirectToNextBuilderInfof added in v0.10.25 

func RedirectToNextBuilderInfof(msg string, a ...interface{}) RedirectToNextBuilder

func SilentRedirectToNextBuilderf added in v0.10.25 

func SilentRedirectToNextBuilderf(msg string, a ...interface{}) RedirectToNextBuilder

func WrapRedirectToNextBuilder added in v0.10.25 

func WrapRedirectToNextBuilder(err error, level logger.Level) RedirectToNextBuilder

func (RedirectToNextBuilder) UserFacing added in v0.14.0 

func (redir RedirectToNextBuilder) UserFacing() bool

UserFacing indicates whether this error should be messaged to the user by default. Should be `true` for messages we always want the user to read, e.g. "couldn't Live Update because we matched a fall_back_on file".

type ReuseRefChecker added in v0.16.0 

type ReuseRefChecker func(ctx context.Context, iTarget model.ImageTarget, namedTagged reference.NamedTagged) (bool, error)

type TargetQueue added in v0.14.0 

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

A little data structure to help iterate through dirty targets in dependency order.

func NewImageTargetQueue added in v0.14.0 

func NewImageTargetQueue(ctx context.Context, iTargets []model.ImageTarget, state store.BuildStateSet, canReuseRef ReuseRefChecker) (*TargetQueue, error)

func (*TargetQueue) AllResults added in v0.14.1 

func (q *TargetQueue) AllResults() store.BuildResultSet

All results for targets in the current queue.

func (*TargetQueue) CountBuilds added in v0.14.1 

func (q *TargetQueue) CountBuilds() int

func (*TargetQueue) NewResults added in v0.14.1 

func (q *TargetQueue) NewResults() store.BuildResultSet

New results that were built with the current queue. Omits results that were re-used previous builds.

Returns results that the BuildAndDeploy contract expects.

func (*TargetQueue) ReusedResults added in v0.14.1 

func (q *TargetQueue) ReusedResults() store.BuildResultSet

Reused results that were not built with the current queue.

Used for printing out which builds are cached from previous builds.

func (*TargetQueue) RunBuilds added in v0.14.0 

func (q *TargetQueue) RunBuilds(handler BuildHandler) error

type UpdateMode added in v0.10.25 

type UpdateMode string
var (
	// Auto-pick the build mode based on
	UpdateModeAuto UpdateMode = "auto"

	// Only do image builds
	UpdateModeImage UpdateMode = "image"

	// Update containers in-place. This mode only works with DockerForDesktop and Minikube.
	// If you try to use this mode with a different K8s cluster type, we will return an error
	UpdateModeContainer UpdateMode = "container"

	// Use `kubectl exec`
	UpdateModeKubectlExec UpdateMode = "exec"
)

func ProvideUpdateMode added in v0.10.25 

func ProvideUpdateMode(flag UpdateModeFlag, env k8s.Env, runtime container.Runtime) (UpdateMode, error)

type UpdateModeFlag added in v0.10.25 

type UpdateModeFlag UpdateMode

A type to bind to flag values that need validation.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.