README
¶
Engine Design Doc
Engine is primarily a for
loop that takes inputs from a variety of sources, updates state, and makes a decision based off of that state. The rough shape of the for loop is as follows:
state := &state{}
for {
select {
// sources like local filesystem, kubernetes, ui, etc
case ev := <- fsCh:
e.handleFsEvent(ev)
case ev := <- k8sCh:
e.handleK8sEvent(ev)
}
// decide what to do: start a pipeline, stop a pipeline
actions := handle(state)
// tell subscribers what we took
updateSubscribers(actions, state.copy())
}
When state changes, and only when state changes, can we make decisions about what to do. Only after actions have been taken do we tell subscribers.
Rules
- No blocking I/O in the for loop
- No long operations in the for loop
- Actions taken in
handle
shouldn’t directly send to channels that thisfor
select
s on.
Documentation
¶
Index ¶
- Constants
- Variables
- func IsDontFallBackError(err error) bool
- func NewErrorAction(err error) store.ErrorAction
- func NewImageAndCacheBuilder(ib build.ImageBuilder, cb build.CacheBuilder, custb build.CustomBuilder, ...) *imageAndCacheBuilder
- func ParseYAMLFromManifests(manifests ...model.Manifest) ([]k8s.K8sEntity, error)
- func ProvideSubscribers(hud hud.HeadsUpDisplay, pw *k8swatch.PodWatcher, sw *k8swatch.ServiceWatcher, ...) []store.Subscriber
- func ProvideTimerMaker() timerMaker
- type AnalyticsReporter
- type BuildAndDeployer
- type BuildCompleteAction
- type BuildController
- type BuildHandler
- type BuildLogAction
- type BuildLogActionWriter
- type BuildOrder
- type BuildStartedAction
- type CompositeBuildAndDeployer
- type DeployIDAction
- type DockerComposeBuildAndDeployer
- type DockerComposeEventAction
- type DockerComposeEventWatcher
- type DockerComposeLogAction
- type DockerComposeLogActionWriter
- type DockerComposeLogManager
- type DontFallBackError
- type FallbackTester
- type FsWatcherMaker
- type GithubClientFactory
- type HardCancelReader
- type HudStoppedAction
- type ImageBuildAndDeployer
- type ImageController
- type ImageExistsChecker
- type InitAction
- type KINDPusher
- type LatestVersionAction
- type LiveUpdateBuildAndDeployer
- type LocalTargetBuildAndDeployer
- type ManifestReloadedAction
- type PodLogAction
- type PodLogActionWriter
- type PodLogManager
- type PodLogWatch
- type PodWatcherMaker
- type PortForwardController
- type ProfilerManager
- type RedirectToNextBuilder
- type ServiceWatcherMaker
- type TargetQueue
- type TiltAnalyticsSubscriber
- type TiltVersionChecker
- type UIDUpdateAction
- type UpdateMode
- type UpdateModeFlag
- type Upper
- type WatchManager
- type WatchableTarget
Constants ¶
const DetectedOverflowErrMsg = `` /* 194-byte string literal not displayed */
Variables ¶
var AllUpdateModes = []UpdateMode{
UpdateModeAuto,
UpdateModeImage,
UpdateModeNaive,
UpdateModeSynclet,
UpdateModeContainer,
UpdateModeKubectlExec,
}
var ConfigsTargetID = model.TargetID{
Type: model.TargetTypeConfigs,
Name: "singleton",
}
var DeployerBaseWireSet = wire.NewSet(wire.Value(dockerfile.Labels{}), wire.Value(UpperReducer), sidecar.WireSet, minikube.ProvideMinikubeClient, build.DefaultImageBuilder, build.NewCacheBuilder, build.NewDockerImageBuilder, build.NewExecCustomBuilder, wire.Bind(new(build.CustomBuilder), new(build.ExecCustomBuilder)), NewLocalTargetBuildAndDeployer,
NewImageBuildAndDeployer, containerupdate.NewDockerContainerUpdater, containerupdate.NewSyncletUpdater, containerupdate.NewExecUpdater, NewLiveUpdateBuildAndDeployer,
NewDockerComposeBuildAndDeployer,
NewImageAndCacheBuilder,
DefaultBuildOrder, wire.Bind(new(BuildAndDeployer), new(CompositeBuildAndDeployer)), NewCompositeBuildAndDeployer,
ProvideUpdateMode,
)
var DeployerWireSet = wire.NewSet(
DeployerBaseWireSet, containerupdate.NewSyncletManager,
)
var DeployerWireSetTest = wire.NewSet(
DeployerBaseWireSet, containerupdate.NewSyncletManagerForTests, synclet.FakeGRPCWrapper,
)
var UpperReducer = store.Reducer(upperReducerFn)
Functions ¶
func IsDontFallBackError ¶ added in v0.10.0
func IsDontFallBackError(err error) bool
func NewErrorAction ¶
func NewErrorAction(err error) store.ErrorAction
func NewImageAndCacheBuilder ¶ added in v0.6.0
func NewImageAndCacheBuilder(ib build.ImageBuilder, cb build.CacheBuilder, custb build.CustomBuilder, updateMode UpdateMode) *imageAndCacheBuilder
func ParseYAMLFromManifests ¶
func ParseYAMLFromManifests(manifests ...model.Manifest) ([]k8s.K8sEntity, error)
func ProvideSubscribers ¶ added in v0.8.0
func ProvideSubscribers(
hud hud.HeadsUpDisplay,
pw *k8swatch.PodWatcher,
sw *k8swatch.ServiceWatcher,
plm *PodLogManager,
pfc *PortForwardController,
fwm *WatchManager,
bc *BuildController,
ic *ImageController,
cc *configs.ConfigsController,
dcw *DockerComposeEventWatcher,
dclm *DockerComposeLogManager,
pm *ProfilerManager,
sm containerupdate.SyncletManager,
ar *AnalyticsReporter,
hudsc *server.HeadsUpServerController,
tvc *TiltVersionChecker,
ta *TiltAnalyticsSubscriber,
ewm *k8swatch.EventWatchManager,
tcum *cloud.CloudUsernameManager) []store.Subscriber
func ProvideTimerMaker ¶
func ProvideTimerMaker() timerMaker
Types ¶
type AnalyticsReporter ¶ added in v0.7.11
type AnalyticsReporter struct {
// contains filtered or unexported fields
}
func ProvideAnalyticsReporter ¶ added in v0.7.11
func ProvideAnalyticsReporter(a *analytics.TiltAnalytics, st *store.Store) *AnalyticsReporter
type BuildAndDeployer ¶
type BuildAndDeployer interface {
// BuildAndDeploy builds and deployed the specified target specs.
//
// Returns a BuildResult that expresses the outputs(s) of the build.
//
// 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 ¶
type BuildCompleteAction struct {
Result store.BuildResultSet
Error error
}
func NewBuildCompleteAction ¶
func NewBuildCompleteAction(result store.BuildResultSet, err error) BuildCompleteAction
type BuildController ¶
type BuildController struct {
// contains filtered or unexported fields
}
func NewBuildController ¶
func NewBuildController(b BuildAndDeployer) *BuildController
func (*BuildController) DisableForTesting ¶ added in v0.1.0
func (c *BuildController) DisableForTesting()
type BuildHandler ¶ added in v0.7.11
type BuildHandler func(
target model.TargetSpec,
state store.BuildState,
depResults []store.BuildResult) (store.BuildResult, error)
Allows the caller to inject its own build strategy for dirty targets.
type BuildLogAction ¶ added in v0.2.0
type BuildLogAction struct {
store.LogEvent
}
type BuildLogActionWriter ¶ added in v0.2.0
type BuildLogActionWriter struct {
// contains filtered or unexported fields
}
type BuildOrder ¶
type BuildOrder []BuildAndDeployer
func DefaultBuildOrder ¶
func DefaultBuildOrder(lubad *LiveUpdateBuildAndDeployer, ibad *ImageBuildAndDeployer, dcbad *DockerComposeBuildAndDeployer,
ltbad *LocalTargetBuildAndDeployer, updMode UpdateMode, env k8s.Env, runtime container.Runtime) BuildOrder
type BuildStartedAction ¶
type BuildStartedAction struct {
ManifestName model.ManifestName
StartTime time.Time
FilesChanged []string
Reason model.BuildReason
}
type CompositeBuildAndDeployer ¶
type CompositeBuildAndDeployer struct {
// contains filtered or unexported fields
}
CompositeBuildAndDeployer tries to run each builder in order. If a builder emits an error, it uses the FallbackTester to determine whether the error is critical enough to stop the whole pipeline, or to fallback to the next builder.
func NewCompositeBuildAndDeployer ¶
func NewCompositeBuildAndDeployer(builders BuildOrder) *CompositeBuildAndDeployer
func (*CompositeBuildAndDeployer) BuildAndDeploy ¶
func (composite *CompositeBuildAndDeployer) BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, currentState store.BuildStateSet) (store.BuildResultSet, error)
type DeployIDAction ¶ added in v0.7.11
type DeployIDAction struct {
TargetID model.TargetID
DeployID model.DeployID
}
func NewDeployIDAction ¶ added in v0.7.11
func NewDeployIDAction(id model.TargetID, dID model.DeployID) DeployIDAction
func NewDeployIDActionsForTargets ¶ added in v0.7.11
func NewDeployIDActionsForTargets(ids []model.TargetID, dID model.DeployID) []DeployIDAction
type DockerComposeBuildAndDeployer ¶ added in v0.4.1
type DockerComposeBuildAndDeployer struct {
// contains filtered or unexported fields
}
func NewDockerComposeBuildAndDeployer ¶ added in v0.4.1
func NewDockerComposeBuildAndDeployer(dcc dockercompose.DockerComposeClient, dc docker.Client,
icb *imageAndCacheBuilder, c build.Clock) *DockerComposeBuildAndDeployer
func (*DockerComposeBuildAndDeployer) BuildAndDeploy ¶ added in v0.4.1
func (bd *DockerComposeBuildAndDeployer) BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, currentState store.BuildStateSet) (store.BuildResultSet, error)
type DockerComposeEventAction ¶ added in v0.4.1
type DockerComposeEventAction struct {
Event dockercompose.Event
}
type DockerComposeEventWatcher ¶ added in v0.4.1
type DockerComposeEventWatcher struct {
// contains filtered or unexported fields
}
func NewDockerComposeEventWatcher ¶ added in v0.4.1
func NewDockerComposeEventWatcher(dcc dockercompose.DockerComposeClient) *DockerComposeEventWatcher
type DockerComposeLogAction ¶ added in v0.4.1
type DockerComposeLogAction struct {
store.LogEvent
}
type DockerComposeLogActionWriter ¶ added in v0.4.1
type DockerComposeLogActionWriter struct {
// contains filtered or unexported fields
}
type DockerComposeLogManager ¶ added in v0.4.1
type DockerComposeLogManager struct {
// contains filtered or unexported fields
}
Collects logs from running docker-compose services.
func NewDockerComposeLogManager ¶ added in v0.4.1
func NewDockerComposeLogManager(dcc dockercompose.DockerComposeClient) *DockerComposeLogManager
type DontFallBackError ¶ added in v0.2.0
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.2.0
func DontFallBackErrorf(msg string, a ...interface{}) DontFallBackError
func WrapDontFallBackError ¶ added in v0.2.0
func WrapDontFallBackError(err error) DontFallBackError
type FallbackTester ¶
type FallbackTester func(error) bool
type FsWatcherMaker ¶
type FsWatcherMaker func(paths []string, ignore watch.PathMatcher, l logger.Logger) (watch.Notify, error)
func ProvideFsWatcherMaker ¶
func ProvideFsWatcherMaker() FsWatcherMaker
type GithubClientFactory ¶ added in v0.8.4
type GithubClientFactory func() github.Client
func NewGithubClientFactory ¶ added in v0.8.4
func NewGithubClientFactory() GithubClientFactory
type HardCancelReader ¶ added in v0.2.0
type HardCancelReader struct {
// contains filtered or unexported fields
}
A reader that will stop returning data after its context has been canceled.
If any data is read from the underlying stream after the cancel happens, throw the data out.
func NewHardCancelReader ¶ added in v0.2.0
func NewHardCancelReader(ctx context.Context, reader io.Reader) HardCancelReader
type HudStoppedAction ¶ added in v0.1.0
type HudStoppedAction struct {
// contains filtered or unexported fields
}
func NewHudStoppedAction ¶ added in v0.1.0
func NewHudStoppedAction(err error) HudStoppedAction
type ImageBuildAndDeployer ¶
type ImageBuildAndDeployer struct {
// contains filtered or unexported fields
}
func NewImageBuildAndDeployer ¶
func NewImageBuildAndDeployer(
b build.ImageBuilder,
cacheBuilder build.CacheBuilder,
customBuilder build.CustomBuilder,
k8sClient k8s.Client,
env k8s.Env,
analytics *analytics.TiltAnalytics,
updMode UpdateMode,
c build.Clock,
runtime container.Runtime,
kp KINDPusher,
syncletContainer sidecar.SyncletContainer,
) *ImageBuildAndDeployer
func (*ImageBuildAndDeployer) BuildAndDeploy ¶
func (ibd *ImageBuildAndDeployer) BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, stateSet store.BuildStateSet) (resultSet store.BuildResultSet, err error)
func (*ImageBuildAndDeployer) SetInjectSynclet ¶
func (ibd *ImageBuildAndDeployer) SetInjectSynclet(inject bool)
Turn on synclet injection. Should be called before any builds.
type ImageController ¶ added in v0.1.0
type ImageController struct {
// contains filtered or unexported fields
}
Handles image garbage collection.
func NewImageController ¶ added in v0.1.0
func NewImageController(reaper build.ImageReaper) *ImageController
type ImageExistsChecker ¶ added in v0.9.2
type ImageExistsChecker func(ctx context.Context, namedTagged reference.NamedTagged) (bool, error)
type InitAction ¶
type InitAction struct {
WatchFiles bool
TiltfilePath string
ConfigFiles []string
InitManifests []model.ManifestName
TiltBuild model.TiltBuild
StartTime time.Time
AnalyticsOpt analytics.Opt
CloudAddress string
Token token.Token
}
type KINDPusher ¶ added in v0.7.11
type KINDPusher interface {
PushToKIND(ctx context.Context, ref reference.NamedTagged, w io.Writer) error
}
func NewKINDPusher ¶ added in v0.7.11
func NewKINDPusher(clusterName k8s.ClusterName) KINDPusher
type LatestVersionAction ¶ added in v0.8.4
type LatestVersionAction struct {
Build model.TiltBuild
}
type LiveUpdateBuildAndDeployer ¶ added in v0.9.5
type LiveUpdateBuildAndDeployer struct {
// contains filtered or unexported fields
}
func NewLiveUpdateBuildAndDeployer ¶ added in v0.9.5
func NewLiveUpdateBuildAndDeployer(dcu *containerupdate.DockerContainerUpdater,
scu *containerupdate.SyncletUpdater, ecu *containerupdate.ExecUpdater,
updMode UpdateMode, env k8s.Env, runtime container.Runtime) *LiveUpdateBuildAndDeployer
func (*LiveUpdateBuildAndDeployer) BuildAndDeploy ¶ added in v0.9.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.10.8
type LocalTargetBuildAndDeployer struct {
// contains filtered or unexported fields
}
TODO(maia): CommandRunner interface for testability
func NewLocalTargetBuildAndDeployer ¶ added in v0.10.8
func NewLocalTargetBuildAndDeployer(c build.Clock) *LocalTargetBuildAndDeployer
func (*LocalTargetBuildAndDeployer) BuildAndDeploy ¶ added in v0.10.8
func (bd *LocalTargetBuildAndDeployer) BuildAndDeploy(ctx context.Context, st store.RStore, specs []model.TargetSpec, stateSet store.BuildStateSet) (resultSet store.BuildResultSet, err error)
type ManifestReloadedAction ¶
type ManifestReloadedAction struct {
OldManifest model.Manifest
NewManifest model.Manifest
Error error
}
type PodLogAction ¶
type PodLogAction struct {
store.LogEvent
PodID k8s.PodID
}
type PodLogActionWriter ¶
type PodLogActionWriter struct {
// contains filtered or unexported fields
}
type PodLogManager ¶
type PodLogManager struct {
// contains filtered or unexported fields
}
Collects logs from deployed containers.
func NewPodLogManager ¶
func NewPodLogManager(kClient k8s.Client) *PodLogManager
type PodLogWatch ¶
type PodLogWatch struct {
// contains filtered or unexported fields
}
type PodWatcherMaker ¶
type PodWatcherMaker func(context.Context, *store.Store) error
type PortForwardController ¶
type PortForwardController struct {
// contains filtered or unexported fields
}
func NewPortForwardController ¶
func NewPortForwardController(kClient k8s.Client) *PortForwardController
type ProfilerManager ¶ added in v0.4.2
type ProfilerManager struct {
// contains filtered or unexported fields
}
func NewProfilerManager ¶ added in v0.4.2
func NewProfilerManager() *ProfilerManager
func (*ProfilerManager) OnChange ¶ added in v0.4.2
func (p *ProfilerManager) OnChange(ctx context.Context, st store.RStore)
type RedirectToNextBuilder ¶ added in v0.2.0
type RedirectToNextBuilder struct {
// 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.7.12
func RedirectToNextBuilderInfof(msg string, a ...interface{}) RedirectToNextBuilder
func SilentRedirectToNextBuilderf ¶ added in v0.7.12
func SilentRedirectToNextBuilderf(msg string, a ...interface{}) RedirectToNextBuilder
func WrapRedirectToNextBuilder ¶ added in v0.2.0
func WrapRedirectToNextBuilder(err error, level logger.Level) RedirectToNextBuilder
type ServiceWatcherMaker ¶
type ServiceWatcherMaker func(context.Context, *store.Store) error
type TargetQueue ¶ added in v0.7.11
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.7.11
func NewImageTargetQueue(ctx context.Context, iTargets []model.ImageTarget, state store.BuildStateSet, imageExists ImageExistsChecker) (*TargetQueue, error)
func (*TargetQueue) CountDirty ¶ added in v0.7.11
func (q *TargetQueue) CountDirty() int
type TiltAnalyticsSubscriber ¶ added in v0.8.7
type TiltAnalyticsSubscriber struct {
// contains filtered or unexported fields
}
func NewTiltAnalyticsSubscriber ¶ added in v0.8.7
func NewTiltAnalyticsSubscriber(ta *analytics.TiltAnalytics) *TiltAnalyticsSubscriber
type TiltVersionChecker ¶ added in v0.8.4
type TiltVersionChecker struct {
// contains filtered or unexported fields
}
func NewTiltVersionChecker ¶ added in v0.8.4
func NewTiltVersionChecker(ghcf GithubClientFactory, timerMaker timerMaker) *TiltVersionChecker
type UIDUpdateAction ¶ added in v0.8.9
type UIDUpdateAction struct {
UID types.UID
EventType watch.EventType
ManifestName model.ManifestName
Entity k8s.K8sEntity
}
type UpdateMode ¶
type UpdateMode string
var (
// Auto-pick the build mode based on
UpdateModeAuto UpdateMode = "auto"
// Only do image builds
UpdateModeImage UpdateMode = "image"
// Only do image builds from scratch
UpdateModeNaive UpdateMode = "naive"
// Deploy a synclet to make container updates faster
UpdateModeSynclet UpdateMode = "synclet"
// 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 ¶
func ProvideUpdateMode(flag UpdateModeFlag, env k8s.Env, runtime container.Runtime) (UpdateMode, error)
type UpdateModeFlag ¶
type UpdateModeFlag UpdateMode
A type to bind to flag values that need validation.
type Upper ¶
type Upper struct {
// contains filtered or unexported fields
}
TODO(nick): maybe this should be called 'BuildEngine' or something? Upper seems like a poor and undescriptive name.
type WatchManager ¶
type WatchManager struct {
// contains filtered or unexported fields
}
func NewWatchManager ¶
func NewWatchManager(watcherMaker FsWatcherMaker, timerMaker timerMaker) *WatchManager
func (*WatchManager) DisableForTesting ¶ added in v0.2.0
func (w *WatchManager) DisableForTesting()
type WatchableTarget ¶ added in v0.5.1
type WatchableTarget interface {
ignore.IgnorableTarget
Dependencies() []string
ID() model.TargetID
}
If you modify this interface, you might also need to update the watchRulesMatch function below.
Source Files
¶
- actions.go
- analytics_reporter.go
- build_and_deployer.go
- build_errors.go
- buildcontroller.go
- docker_compose_build_and_deployer.go
- docker_compose_event_watcher.go
- docker_compose_log_manager.go
- extractors.go
- image_and_cache_builder.go
- image_build_and_deployer.go
- imagecontroller.go
- live_update_build_and_deployer.go
- live_update_state_tree.go
- local_target_build_and_deployer.go
- parse.go
- pod.go
- podlogmanager.go
- portforwardcontroller.go
- profiler.go
- reader.go
- subscribers.go
- target_queue.go
- tilt_analytics.go
- update_mode.go
- upper.go
- version_checker.go
- watchmanager.go
- wire_gen.go