buildcontrol

package
v0.33.21 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2024 License: Apache-2.0 Imports: 35 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var BaseWireSet = wire.NewSet(wire.Value(dockerfile.Labels{}), v1alpha1.NewScheme, k8s.ProvideMinikubeClient, build.NewDockerBuilder, build.NewCustomBuilder, wire.Bind(new(build.DockerKubeConnection), new(*build.DockerBuilder)), NewDockerComposeBuildAndDeployer,
	NewImageBuildAndDeployer,
	NewLocalTargetBuildAndDeployer, containerupdate.NewDockerUpdater, containerupdate.NewExecUpdater, build.NewImageBuilder, tracer.InitOpenTelemetry, liveupdates.ProvideUpdateMode,
)

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 FindTargetsNeedingAnyBuild added in v0.23.2 

func FindTargetsNeedingAnyBuild(state store.EngineState) []*store.ManifestTarget

Grab all the targets that are build-eligible from the engine state.

We apply this filter first, then layer on individual build decisions about what to build next. This MUST be the union of all checks in all downstream build decisions in NextTargetToBuild.

func FindTargetsNeedingInitialBuild added in v0.10.18 

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

func FindUnresourcedYAML 

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

func HoldK8sTargets added in v0.17.5 

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

func HoldLiveUpdateTargetsHandledByReconciler added in v0.23.0 

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

Hold back live update targets that are being successfully handled by a reconciler.

func HoldLiveUpdateTargetsWaitingOnDeploy added in v0.17.5 

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

func HoldTargetsWaitingOnCluster added in v0.23.4 

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

We use the cluster to detect what architecture we're building for. Until the cluster connection has been established, we block any image builds.

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(state store.EngineState, mts []*store.ManifestTarget, holds HoldSet)

func HoldUnparallelizableLocalTargets added in v0.17.5 

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

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) (model.ManifestName, model.TargetName, bool)

func IsDontFallBackError added in v0.10.25 

func IsDontFallBackError(err error) bool

func IsLiveUpdateEligibleTrigger added in v0.25.1 

func IsLiveUpdateEligibleTrigger(manifest model.Manifest, reason model.BuildReason) bool

In automatic trigger mode: - Clicking the trigger button always triggers a full rebuild.

In manual trigger mode: - If there are no pending changes, clicking the trigger button triggers a full rebuild. - If there are only pending changes, clicking the trigger button triggers a live-update.

func IsLiveUpdateTargetWaitingOnDeploy added in v0.17.5 

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

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 TargetsWithPendingEnableStatus added in v0.23.9 

func TargetsWithPendingEnableStatus(targets []*store.ManifestTarget) []model.TargetID

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 BuildHandler added in v0.14.0 

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

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

type DockerComposeBuildAndDeployer added in v0.19.5 

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

func NewDockerComposeBuildAndDeployer added in v0.19.5 

func NewDockerComposeBuildAndDeployer(
	dr *dockerimage.Reconciler,
	cr *cmdimage.Reconciler,
	ib *build.ImageBuilder,
	dcsr *dockercomposeservice.Reconciler,
	c build.Clock,
	ctrlClient ctrlclient.Client,
) *DockerComposeBuildAndDeployer

func ProvideDockerComposeBuildAndDeployer added in v0.19.5 

func ProvideDockerComposeBuildAndDeployer(ctx context.Context, dcCli dockercompose.DockerComposeClient, dCli docker.Client, ctrlclient client.Client, st store.RStore, clock clockwork.Clock, 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.

The HoldSet is used in the UI to display why a resource is waiting.

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) IsEligible added in v0.22.14 

func (s HoldSet) IsEligible(target *store.ManifestTarget) bool

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(
	dr *dockerimage.Reconciler,
	cr *cmdimage.Reconciler,
	ib *build.ImageBuilder,
	analytics *analytics.TiltAnalytics,
	c build.Clock,
	ctrlClient ctrlclient.Client,
	r *kubernetesapply.Reconciler,
) *ImageBuildAndDeployer

func ProvideImageBuildAndDeployer added in v0.19.5 

func ProvideImageBuildAndDeployer(ctx context.Context, docker2 docker.Client, kClient k8s.Client, env clusterid.Product, kubeContext k8s.KubeContext, clusterEnv docker.ClusterEnv, dir *dirs.TiltDevDir, clock build.Clock, clock2 clockwork.Clock, kp build.KINDLoader, analytics2 *analytics.TiltAnalytics, ctrlclient client.Client, st store.RStore) (*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 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,
	ctrlClient ctrlclient.Client,
	cmds *cmd.Controller) *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.ImageBuildResultSet

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.ImageBuildResultSet

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.ImageBuildResultSet

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

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.