model

package
v0.17.10 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultMaxParallelUpdates = 3
	DefaultK8sUpsertTimeout   = 30 * time.Second
)
View Source 
const BuildHistoryLimit = 2
View Source 
const BuildReasonNone = BuildReason(0)
View Source 
const DefaultTelemetryPeriod = 60 * time.Second
View Source 
const DockerPruneDefaultInterval = time.Hour

How often to prune Docker images while Tilt is running

View Source 
const DockerPruneDefaultKeepRecent = 2

Keep the last 2 builds of an image

View Source 
const DockerPruneDefaultMaxAge = time.Hour * 6

Prune Docker objects older than this

View Source 
const OrchestratorDC = Orchestrator("DockerCompose")
View Source 
const OrchestratorK8s = Orchestrator("Kubernetes")
View Source 
const OrchestratorUnknown = Orchestrator("")
View Source 
const TiltfileManifestName = ManifestName("(Tiltfile)")
View Source 
const UnresourcedYAMLManifestName = ManifestName("uncategorized")

TODO(maia): throw an error if you try to name a manifest this in your Tiltfile?

Variables

View Source 
var DefaultReportingPeriod = 5 * time.Minute

Functions

func ChangesInvalidateBuild 

func ChangesInvalidateBuild(old, new Manifest) bool

ChangesInvalidateBuild checks whether the changes from old => new manifest invalidate our build of the old one; i.e. if we're replacing `old` with `new`, should we perform a full rebuild?

func FacetsToProto added in v0.10.16 

func FacetsToProto(facets []Facet) []*webview.Facet

func ImageTargetsByID 

func ImageTargetsByID(iTargets []ImageTarget) map[TargetID]ImageTarget

func LinksToURLStrings added in v0.17.8 

func LinksToURLStrings(lns []Link) []string

func LocalRefSelectorsForManifests added in v0.14.0 

func LocalRefSelectorsForManifests(manifests []Manifest) []container.RefSelector

func MakeTargetMap 

func MakeTargetMap(targets []TargetSpec) map[TargetID]TargetSpec

Map all the targets by their target ID.

func NewRelativeFileOrChildMatcher 

func NewRelativeFileOrChildMatcher(baseDir string, paths ...string) fileOrChildMatcher

NewRelativeFileOrChildMatcher returns a matcher for the given paths (with any relative paths converted to absolute, relative to the given baseDir).

func NewSimpleFileMatcher 

func NewSimpleFileMatcher(paths ...string) (fileMatcher, error)

NewSimpleFileMatcher returns a matcher for the given paths; any relative paths are converted to absolute (relative to cwd).

func TargetIDSet 

func TargetIDSet(tids []TargetID) map[TargetID]bool

func UnrecognizedWebModeError 

func UnrecognizedWebModeError(v string) error

Types

type BuildDetails 

type BuildDetails interface {
	// contains filtered or unexported methods
}

type BuildReason 

type BuildReason int
const (
	BuildReasonFlagChangedFiles BuildReason = 1 << iota
	BuildReasonFlagConfig

	// See comments on NeedsRebuildFromCrash
	BuildReasonFlagCrash

	BuildReasonFlagInit

	BuildReasonFlagTriggerWeb
	BuildReasonFlagTriggerCLI
	BuildReasonFlagTriggerUnknown

	// An external process called `tilt args`
	BuildReasonFlagTiltfileArgs

	// Suppose you have
	// manifestA with imageA depending on imageCommon
	// manifestB with imageB depending on imageCommon
	//
	// Building manifestA will mark imageB
	// with changed dependencies.
	BuildReasonFlagChangedDeps
)

func (BuildReason) Has 

func (r BuildReason) Has(flag BuildReason) bool

func (BuildReason) HasTrigger added in v0.14.0 

func (r BuildReason) HasTrigger() bool

func (BuildReason) IsCrashOnly 

func (r BuildReason) IsCrashOnly() bool

func (BuildReason) String added in v0.10.16 

func (r BuildReason) String() string

func (BuildReason) With 

func (r BuildReason) With(flag BuildReason) BuildReason

type BuildRecord 

type BuildRecord struct {
	Edits      []string
	Error      error
	StartTime  time.Time
	FinishTime time.Time // IsZero() == true for in-progress builds
	Reason     BuildReason

	BuildTypes []BuildType

	// The lookup key for the logs in the logstore.
	SpanID LogSpanID

	// We count the warnings by looking up all the logs with Level=WARNING
	// in the logstore. We store this number separately for ease of use.
	WarningCount int
}

func (BuildRecord) Duration 

func (bs BuildRecord) Duration() time.Duration

func (BuildRecord) Empty 

func (bs BuildRecord) Empty() bool

func (BuildRecord) HasBuildType added in v0.10.14 

func (r BuildRecord) HasBuildType(bt BuildType) bool

type BuildType added in v0.10.14 

type BuildType string
const BuildTypeDockerCompose BuildType = "docker-compose"
const BuildTypeImage BuildType = "image"
const BuildTypeK8s BuildType = "k8s"
const BuildTypeLiveUpdate BuildType = "live-update"
const BuildTypeLocal BuildType = "local"

type ByURL added in v0.17.7 

type ByURL []Link

ByURL implements sort.Interface based on the URL field.

func (ByURL) Len added in v0.17.7 

func (lns ByURL) Len() int

func (ByURL) Less added in v0.17.7 

func (lns ByURL) Less(i, j int) bool

func (ByURL) Swap added in v0.17.7 

func (lns ByURL) Swap(i, j int)

type Cmd 

type Cmd struct {
	Argv []string
}

func ToBatCmd added in v0.14.0 

func ToBatCmd(cmd string) Cmd

🦇🦇🦇 Named in honor of Bazel https://docs.bazel.build/versions/master/be/general.html#genrule.cmd_bat

func ToHostCmd added in v0.14.0 

func ToHostCmd(cmd string) Cmd

Create a shell command for running on the Host OS

func ToUnixCmd added in v0.14.0 

func ToUnixCmd(cmd string) Cmd

func ToUnixCmds added in v0.14.0 

func ToUnixCmds(cmds []string) []Cmd

func TrySquash 

func TrySquash(runs []Cmd) []Cmd

func (Cmd) Empty 

func (c Cmd) Empty() bool

func (Cmd) EntrypointStr 

func (c Cmd) EntrypointStr() string

func (Cmd) IsShellStandardForm 

func (c Cmd) IsShellStandardForm() bool

func (Cmd) IsWindowsStandardForm added in v0.14.0 

func (c Cmd) IsWindowsStandardForm() bool

func (Cmd) RunStr 

func (c Cmd) RunStr() string

func (Cmd) ShellStandardScript 

func (c Cmd) ShellStandardScript() string

Get the script when the shell is in standard form. Panics if the command is not in shell standard form.

func (Cmd) String 

func (c Cmd) String() string

type CompositePathMatcher 

type CompositePathMatcher struct {
	Matchers []PathMatcher
}

func (CompositePathMatcher) Matches 

func (c CompositePathMatcher) Matches(f string) (bool, error)

func (CompositePathMatcher) MatchesEntireDir 

func (c CompositePathMatcher) MatchesEntireDir(f string) (bool, error)

type CustomBuild 

type CustomBuild struct {
	WorkDir string
	Command Cmd
	// Deps is a list of file paths that are dependencies of this command.
	Deps []string

	// Optional: tag we expect the image to be built with (we use this to check that
	// the expected image+tag has been created).
	// If empty, we create an expected tag at the beginning of CustomBuild (and
	// export $EXPECTED_REF=name:expected_tag )
	Tag string

	LiveUpdate       LiveUpdate // Optionally, can use LiveUpdate to update this build in place.
	DisablePush      bool
	SkipsLocalDocker bool

	// We expect the custom build script to print the image ref to this file,
	// so that Tilt can read it out when we're done.
	OutputsImageRefTo string
}

func (CustomBuild) SkipsPush added in v0.10.22 

func (cb CustomBuild) SkipsPush() bool

func (CustomBuild) WithTag 

func (cb CustomBuild) WithTag(t string) CustomBuild

type DockerBuild 

type DockerBuild struct {
	Dockerfile  string
	BuildPath   string // the absolute path to the files
	BuildArgs   DockerBuildArgs
	LiveUpdate  LiveUpdate // Optionally, can use LiveUpdate to update this build in place.
	TargetStage DockerBuildTarget

	// Pass SSH secrets to docker so it can clone private repos.
	// https://docs.docker.com/develop/develop-images/build_enhancements/#using-ssh-to-access-private-data-in-builds
	SSHSpecs []string

	// Pass secrets to docker
	// https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information
	SecretSpecs []string

	Network string

	PullParent bool
	CacheFrom  []string

	// By default, Tilt creates a new temporary image reference for each build.
	// The user can also specify their own reference, to integrate with other tooling
	// (like build IDs for Jenkins build pipelines)
	//
	// Equivalent to the docker build --tag flag.
	// Named 'tag' for consistency with how it's used throughout the docker API,
	// even though this is really more like a reference.NamedTagged
	ExtraTags []string
}

type DockerBuildArgs 

type DockerBuildArgs map[string]string

type DockerBuildTarget added in v0.10.8 

type DockerBuildTarget string

func (DockerBuildTarget) String added in v0.10.8 

func (s DockerBuildTarget) String() string

type DockerComposeTarget 

type DockerComposeTarget struct {
	Name        TargetName
	ConfigPaths []string

	YAMLRaw []byte // for diff'ing when config files change
	DfRaw   []byte // for diff'ing when config files change
	// contains filtered or unexported fields
}

func ExtractDockerComposeTargets 

func ExtractDockerComposeTargets(specs []TargetSpec) []DockerComposeTarget

func (DockerComposeTarget) Dependencies 

func (t DockerComposeTarget) Dependencies() []string

TODO(nick): This method should be deleted. We should just de-dupe and sort LocalPaths once when we create it, rather than have a duplicate method that does the "right" thing.

func (DockerComposeTarget) DependencyIDs 

func (t DockerComposeTarget) DependencyIDs() []TargetID

func (DockerComposeTarget) Dockerignores 

func (t DockerComposeTarget) Dockerignores() []Dockerignore

func (DockerComposeTarget) Empty 

func (t DockerComposeTarget) Empty() bool

func (DockerComposeTarget) ID 

func (t DockerComposeTarget) ID() TargetID

func (DockerComposeTarget) IgnoredLocalDirectories 

func (t DockerComposeTarget) IgnoredLocalDirectories() []string

func (DockerComposeTarget) LocalPaths 

func (t DockerComposeTarget) LocalPaths() []string

func (DockerComposeTarget) LocalRepos 

func (t DockerComposeTarget) LocalRepos() []LocalGitRepo

func (DockerComposeTarget) ManifestName 

func (t DockerComposeTarget) ManifestName() ManifestName

TODO(nick): This is a temporary hack until we figure out how we want to pass these IDs to the docker-compose UX.

func (DockerComposeTarget) PublishedPorts 

func (t DockerComposeTarget) PublishedPorts() []int

func (DockerComposeTarget) TiltFilename 

func (t DockerComposeTarget) TiltFilename() string

func (DockerComposeTarget) Validate 

func (dc DockerComposeTarget) Validate() error

func (DockerComposeTarget) WithBuildPath 

func (t DockerComposeTarget) WithBuildPath(buildPath string) DockerComposeTarget

func (DockerComposeTarget) WithDependencyIDs 

func (t DockerComposeTarget) WithDependencyIDs(ids []TargetID) DockerComposeTarget

func (DockerComposeTarget) WithDockerignores 

func (t DockerComposeTarget) WithDockerignores(dockerignores []Dockerignore) DockerComposeTarget

func (DockerComposeTarget) WithIgnoredLocalDirectories 

func (t DockerComposeTarget) WithIgnoredLocalDirectories(dirs []string) DockerComposeTarget

func (DockerComposeTarget) WithPublishedPorts 

func (t DockerComposeTarget) WithPublishedPorts(ports []int) DockerComposeTarget

func (DockerComposeTarget) WithRepos 

func (t DockerComposeTarget) WithRepos(repos []LocalGitRepo) DockerComposeTarget

func (DockerComposeTarget) WithTiltFilename 

func (t DockerComposeTarget) WithTiltFilename(f string) DockerComposeTarget

type DockerPruneSettings added in v0.10.14 

type DockerPruneSettings struct {
	Enabled    bool
	MaxAge     time.Duration // "prune Docker objects older than X"
	NumBuilds  int           // "prune every Y builds" (takes precedence over "prune every Z hours")
	Interval   time.Duration // "prune every Z hours"
	KeepRecent int           // Keep the most recent N builds of a tag.
}

func DefaultDockerPruneSettings added in v0.10.14 

func DefaultDockerPruneSettings() DockerPruneSettings

type Dockerignore 

type Dockerignore struct {
	// The path to evaluate the dockerignore contents relative to
	LocalPath string

	// A human-readable string that identifies where the ignores come from.
	Source string

	// Patterns parsed out of the .dockerignore file.
	Patterns []string
}

func (Dockerignore) Empty added in v0.17.6 

func (d Dockerignore) Empty() bool

type Facet added in v0.10.16 

type Facet struct {
	Name   string `json:"name"`
	Value  string `json:"value"`
	SpanID string `json:"span_id"`
}

func (Facet) ToProto added in v0.10.16 

func (f Facet) ToProto() *webview.Facet

type ImageTarget 

type ImageTarget struct {
	Refs           container.RefSet
	BuildDetails   BuildDetails
	MatchInEnvVars bool

	// User-supplied command to run when the container runs
	// (i.e. overrides k8s yaml "command", container ENTRYPOINT, etc.)
	OverrideCmd Cmd

	// User-supplied args override when the container runs.
	// (i.e. overrides k8s yaml "args")
	OverrideArgs OverrideArgs
	// contains filtered or unexported fields
}

func ExtractImageTargets 

func ExtractImageTargets(specs []TargetSpec) []ImageTarget

func MustNewImageTarget added in v0.14.0 

func MustNewImageTarget(ref container.RefSelector) ImageTarget

func (ImageTarget) CachePaths 

func (i ImageTarget) CachePaths() []string

func (ImageTarget) CustomBuildInfo 

func (i ImageTarget) CustomBuildInfo() CustomBuild

func (ImageTarget) Dependencies 

func (i ImageTarget) Dependencies() []string

TODO(nick): This method should be deleted. We should just de-dupe and sort LocalPaths once when we create it, rather than have a duplicate method that does the "right" thing.

func (ImageTarget) DependencyIDs 

func (i ImageTarget) DependencyIDs() []TargetID

func (ImageTarget) DockerBuildInfo 

func (i ImageTarget) DockerBuildInfo() DockerBuild

func (ImageTarget) Dockerignores 

func (i ImageTarget) Dockerignores() []Dockerignore

func (ImageTarget) HasDistinctClusterRef added in v0.14.0 

func (i ImageTarget) HasDistinctClusterRef() bool

HasDistinctClusterRef indicates whether the image target has a ClusterRef distinct from LocalRef, i.e. if the image is addressed different from inside and outside the cluster.

func (ImageTarget) ID 

func (i ImageTarget) ID() TargetID

func (ImageTarget) IgnoredLocalDirectories 

func (i ImageTarget) IgnoredLocalDirectories() []string

func (ImageTarget) IsCustomBuild 

func (i ImageTarget) IsCustomBuild() bool

func (ImageTarget) IsDockerBuild 

func (i ImageTarget) IsDockerBuild() bool

func (ImageTarget) LiveUpdateInfo added in v0.10.24 

func (i ImageTarget) LiveUpdateInfo() LiveUpdate

func (ImageTarget) LocalPaths 

func (i ImageTarget) LocalPaths() []string

func (ImageTarget) LocalRepos 

func (i ImageTarget) LocalRepos() []LocalGitRepo

func (ImageTarget) MaybeIgnoreRegistry added in v0.17.4 

func (i ImageTarget) MaybeIgnoreRegistry() ImageTarget

I (Nick) am deeply unhappy with the parameters of CustomBuild. They're not well-specified, and often interact in weird and unpredictable ways. This function is a good example.

custom_build(tag) means "My custom_build script already has a tag that it wants to use". In practice, it becomes the "You can't tell me what to do" flag.

custom_build(skips_local_docker) means "My custom_build script doesn't use Docker for storage, so you shouldn't expect to find the image there." In practice, it becomes the "You can't touch my outputs" flag.

When used together, you have a script that takes no inputs and doesn't let Tilt fix the outputs. So people use custom_build(tag=x, skips_local_docker=True) to enable all sorts of off-road experimental image-building flows that need better primitives.

For now, when we detect this case, we strip off registry information, since the script isn't going to use it anyway. This is tightly coupled with CustomBuilder, which already has similar logic for handling these two cases together.

func (ImageTarget) TiltFilename 

func (i ImageTarget) TiltFilename() string

func (ImageTarget) Validate 

func (i ImageTarget) Validate() error

func (ImageTarget) WithBuildDetails 

func (i ImageTarget) WithBuildDetails(details BuildDetails) ImageTarget

func (ImageTarget) WithCachePaths 

func (i ImageTarget) WithCachePaths(paths []string) ImageTarget

func (ImageTarget) WithDependencyIDs 

func (i ImageTarget) WithDependencyIDs(ids []TargetID) ImageTarget

func (ImageTarget) WithDockerignores 

func (i ImageTarget) WithDockerignores(dockerignores []Dockerignore) ImageTarget

func (ImageTarget) WithOverrideCommand 

func (i ImageTarget) WithOverrideCommand(cmd Cmd) ImageTarget

func (ImageTarget) WithRepos 

func (i ImageTarget) WithRepos(repos []LocalGitRepo) ImageTarget

func (ImageTarget) WithTiltFilename 

func (i ImageTarget) WithTiltFilename(f string) ImageTarget

type K8sImageLocator added in v0.15.2 

type K8sImageLocator interface {
	EqualsImageLocator(other interface{}) bool
}

type K8sTarget 

type K8sTarget struct {
	Name         TargetName
	YAML         string
	PortForwards []PortForward
	// labels for pods that we should watch and associate with this resource
	ExtraPodSelectors []labels.Selector

	// Each K8s entity should have a display name for user interfaces
	// that balances brevity and uniqueness
	DisplayNames []string

	// Store the name, namespace, and type in a structured form
	// for easy access. This should duplicate what's specified in the YAML.
	ObjectRefs []v1.ObjectReference

	PodReadinessMode PodReadinessMode

	// Implementations of k8s.ImageLocator
	//
	// NOTE(nick): Untangling the circular dependency between k8s and pkg/model is
	// a longer project. The k8s package needs to be split up a bit between the
	// API objects and the client objects.
	ImageLocators []K8sImageLocator

	// zero+ links assoc'd with this resource (to be displayed in UIs,
	// in addition to any port forwards/LB endpoints)
	Links []Link
	// contains filtered or unexported fields
}

func ExtractK8sTargets 

func ExtractK8sTargets(specs []TargetSpec) []K8sTarget

func (K8sTarget) DependencyIDs 

func (k8s K8sTarget) DependencyIDs() []TargetID

func (K8sTarget) Empty 

func (k8s K8sTarget) Empty() bool

func (K8sTarget) HasJob added in v0.14.0 

func (k8s K8sTarget) HasJob() bool

func (K8sTarget) ID 

func (k8s K8sTarget) ID() TargetID

func (K8sTarget) RefInjectCounts 

func (k8s K8sTarget) RefInjectCounts() map[string]int

func (K8sTarget) Validate 

func (k8s K8sTarget) Validate() error

func (K8sTarget) WithDependencyIDs 

func (k8s K8sTarget) WithDependencyIDs(ids []TargetID) K8sTarget

func (K8sTarget) WithRefInjectCounts 

func (k8s K8sTarget) WithRefInjectCounts(ric map[string]int) K8sTarget

type LabelPair 

type LabelPair struct {
	Key   string
	Value string
}

func ToLabelPairs 

func ToLabelPairs(m map[string]string) []LabelPair
type Link struct {
	URL *url.URL

	// Optional name of the link; if given, used as text of the URL
	// displayed in the web UI (e.g. <a href="localhost:8888">Debugger</a>)
	Name string
}

A link associated with resource; may represent a port forward, an endpoint derived from a Service/Ingress/etc., or a URL manually associated with a resource via the Tiltfile 

func MustNewLink(urlStr string, name string) Link
func NewLink(urlStr string, name string) (Link, error)

func (Link) URLString added in v0.17.8 

func (li Link) URLString() string

type LiveUpdate 

type LiveUpdate struct {
	Steps   []LiveUpdateStep
	BaseDir string // directory where the LiveUpdate was initialized (we'll use this to eval. any relative paths)
}

Specifies how to update a running container.

  1. If any paths specified in a FallBackOn step have changed, fall back to an image build (i.e. don't do a LiveUpdate)
  2. If there are Sync steps in `Steps`, files will be synced as specified.
  3. Any time we sync one or more files, all Run and RestartContainer steps will be evaluated.

func NewLiveUpdate 

func NewLiveUpdate(steps []LiveUpdateStep, baseDir string) (LiveUpdate, error)

func (LiveUpdate) Empty 

func (lu LiveUpdate) Empty() bool

func (LiveUpdate) FallBackOnFiles 

func (lu LiveUpdate) FallBackOnFiles() PathSet

FallBackOnFiles returns a PathSet of files which, if any have changed, indicate that we should fall back to an image build.

func (LiveUpdate) RunSteps 

func (lu LiveUpdate) RunSteps() []Run

func (LiveUpdate) ShouldRestart 

func (lu LiveUpdate) ShouldRestart() bool

func (LiveUpdate) SyncSteps 

func (lu LiveUpdate) SyncSteps() []Sync

type LiveUpdateFallBackOnStep 

type LiveUpdateFallBackOnStep struct {
	Files []string
}

Specifies that changes to any of the given files should cause the builder to fall back (i.e. do a full image build)

type LiveUpdateRestartContainerStep 

type LiveUpdateRestartContainerStep struct{}

Specifies that the container should be restarted when any files in `Sync` steps have changed.

type LiveUpdateRunStep 

type LiveUpdateRunStep struct {
	Command  Cmd
	Triggers PathSet
}

Specifies that `Command` should be executed when any files in `Sync` steps have changed If `Trigger` is non-empty, `Command` will only be executed when the local paths of changed files covered by at least one `Sync` match one of `PathSet.Paths` (evaluated relative to `PathSet.BaseDirectory`.

type LiveUpdateStep 

type LiveUpdateStep interface {
	// contains filtered or unexported methods
}

type LiveUpdateSyncStep 

type LiveUpdateSyncStep struct {
	Source, Dest string
}

Specifies that changes to local path `Source` should be synced to container path `Dest`

type LocalGitRepo 

type LocalGitRepo struct {
	LocalPath string
}

func (LocalGitRepo) IsRepo 

func (LocalGitRepo) IsRepo()

type LocalTarget added in v0.10.8 

type LocalTarget struct {
	Name      TargetName
	UpdateCmd Cmd      // e.g. `make proto`
	ServeCmd  Cmd      // e.g. `python main.py`
	Workdir   string   // directory from which the commands should be run
	Links     []Link   // zero+ links assoc'd with this resource (to be displayed in UIs)
	Deps      []string // a list of ABSOLUTE file paths that are dependencies of this target

	// Indicates that we should allow this to run in parallel with other
	// resources  (by default, this is presumed unsafe and is not allowed).
	AllowParallel bool
	// contains filtered or unexported fields
}

func NewLocalTarget added in v0.10.8 

func NewLocalTarget(name TargetName, updateCmd Cmd, serveCmd Cmd, deps []string, workdir string) LocalTarget

func (LocalTarget) Dependencies added in v0.10.8 

func (lt LocalTarget) Dependencies() []string

Implements: engine.WatchableManifest

func (LocalTarget) DependencyIDs added in v0.10.8 

func (lt LocalTarget) DependencyIDs() []TargetID

func (LocalTarget) Dockerignores added in v0.10.8 

func (lt LocalTarget) Dockerignores() []Dockerignore

func (LocalTarget) Empty added in v0.10.9 

func (lt LocalTarget) Empty() bool

func (LocalTarget) ID added in v0.10.8 

func (lt LocalTarget) ID() TargetID

func (LocalTarget) IgnoredLocalDirectories added in v0.10.8 

func (lt LocalTarget) IgnoredLocalDirectories() []string

func (LocalTarget) LocalRepos added in v0.10.8 

func (lt LocalTarget) LocalRepos() []LocalGitRepo

func (LocalTarget) Validate added in v0.10.8 

func (lt LocalTarget) Validate() error

func (LocalTarget) WithAllowParallel added in v0.17.2 

func (lt LocalTarget) WithAllowParallel(val bool) LocalTarget

func (LocalTarget) WithIgnores added in v0.10.16 

func (lt LocalTarget) WithIgnores(ignores []Dockerignore) LocalTarget
func (lt LocalTarget) WithLinks(links []Link) LocalTarget

func (LocalTarget) WithRepos added in v0.10.8 

func (lt LocalTarget) WithRepos(repos []LocalGitRepo) LocalTarget

type Log 

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

func AppendLog 

func AppendLog(l Log, le LogEvent, prefix string, secrets SecretSet) Log

Returns a new instance of `Log` with content equal to `b` appended to the end of `l` Performs truncation off the start of the log (at a newline) to ensure the resulting log is not longer than `maxLogLengthInBytes`. (which maybe means a pedant would say this isn't strictly an `append`?)

func NewLog 

func NewLog(s string) Log

func (Log) Empty 

func (l Log) Empty() bool

func (Log) Len 

func (l Log) Len() int

func (Log) LineCount added in v0.10.10 

func (l Log) LineCount() int

func (Log) MarshalJSON 

func (l Log) MarshalJSON() ([]byte, error)

func (Log) ScrubSecretsStartingAt added in v0.10.10 

func (l Log) ScrubSecretsStartingAt(secrets SecretSet, index int)

func (Log) String 

func (l Log) String() string

func (Log) Tail 

func (l Log) Tail(n int) Log

Get at most N lines from the tail of the log.

func (*Log) UnmarshalJSON added in v0.10.11 

func (l *Log) UnmarshalJSON(data []byte) error

type LogEvent 

type LogEvent interface {
	Message() []byte
	Time() time.Time
}

type LogSpanID added in v0.10.25 

type LogSpanID string

type Manifest 

type Manifest struct {
	// Properties for all manifests.
	Name ManifestName

	// Info needed to build an image. (This struct contains details of DockerBuild, FastBuild... etc.)
	ImageTargets []ImageTarget

	// How updates are triggered:
	// - automatically, when we detect a change
	// - manually, when the user tells us to
	TriggerMode TriggerMode

	// The resource in this manifest will not be built until all of its dependencies have been
	// ready at least once.
	ResourceDependencies []ManifestName
	// contains filtered or unexported fields
}

NOTE: If you modify Manifest, make sure to modify `Manifest.Equal` appropriately

func (Manifest) DependencyIDs 

func (m Manifest) DependencyIDs() []TargetID

func (Manifest) DeployTarget 

func (m Manifest) DeployTarget() TargetSpec

func (Manifest) DockerComposeTarget 

func (m Manifest) DockerComposeTarget() DockerComposeTarget

func (Manifest) ID 

func (m Manifest) ID() TargetID

func (Manifest) ImageTargetAt 

func (m Manifest) ImageTargetAt(i int) ImageTarget

func (Manifest) ImageTargetWithID added in v0.17.5 

func (m Manifest) ImageTargetWithID(id TargetID) ImageTarget

func (Manifest) IsDC 

func (m Manifest) IsDC() bool

func (Manifest) IsImageDeployed 

func (m Manifest) IsImageDeployed(iTarget ImageTarget) bool

func (Manifest) IsK8s 

func (m Manifest) IsK8s() bool

func (Manifest) IsLocal added in v0.10.8 

func (m Manifest) IsLocal() bool

func (Manifest) K8sTarget 

func (m Manifest) K8sTarget() K8sTarget

func (Manifest) LocalPaths 

func (m Manifest) LocalPaths() []string

func (Manifest) LocalTarget added in v0.10.8 

func (m Manifest) LocalTarget() LocalTarget

func (Manifest) ManifestName 

func (m Manifest) ManifestName() ManifestName

func (Manifest) PodReadinessMode added in v0.17.0 

func (m Manifest) PodReadinessMode() PodReadinessMode

func (Manifest) ReverseDependencyIDs added in v0.16.0 

func (m Manifest) ReverseDependencyIDs() map[TargetID][]TargetID

A map from each target id to the target IDs that depend on it.

func (Manifest) TargetIDSet added in v0.15.0 

func (m Manifest) TargetIDSet() map[TargetID]bool

func (Manifest) TargetSpecs 

func (m Manifest) TargetSpecs() []TargetSpec

func (Manifest) Validate 

func (m Manifest) Validate() error

func (Manifest) WithDeployTarget 

func (m Manifest) WithDeployTarget(t TargetSpec) Manifest

func (Manifest) WithImageTarget 

func (m Manifest) WithImageTarget(iTarget ImageTarget) Manifest

func (Manifest) WithImageTargets 

func (m Manifest) WithImageTargets(iTargets []ImageTarget) Manifest

func (Manifest) WithTriggerMode 

func (m Manifest) WithTriggerMode(mode TriggerMode) Manifest

type ManifestName 

type ManifestName string

TODO(nick): We should probably get rid of ManifestName completely and just use TargetName everywhere.

func (ManifestName) String 

func (m ManifestName) String() string

func (ManifestName) TargetName 

func (m ManifestName) TargetName() TargetName

type ManifestNameSet added in v0.17.1 

type ManifestNameSet map[ManifestName]bool

type MetricsSettings added in v0.17.4 

type MetricsSettings struct {
	Enabled  bool
	Address  string
	Insecure bool

	// How often Tilt reports its metrics. Useful for testing.
	// https://pkg.go.dev/go.opencensus.io/stats/view?tab=doc#SetReportingPeriod
	ReportingPeriod time.Duration
}

Metrics settings generally map to exporter options https://pkg.go.dev/contrib.go.opencensus.io/exporter/ocagent?tab=doc#ExporterOption

func DefaultMetricsSettings added in v0.17.4 

func DefaultMetricsSettings() MetricsSettings

type Orchestrator 

type Orchestrator string

The current orchestrator we're running with (K8s or DockerCompose)

type OverrideArgs added in v0.14.0 

type OverrideArgs struct {
	ShouldOverride bool
	Args           []string
}

Represent OverrideArgs as a special struct, to cleanly distinguish "replace with 0 args" from "don't replace"

type PathMatcher 

type PathMatcher interface {
	Matches(f string) (bool, error)

	// If this matches the entire dir, we can often optimize filetree walks a bit
	MatchesEntireDir(file string) (bool, error)
}
var EmptyMatcher PathMatcher = emptyMatcher{}

func NewCompositeMatcher 

func NewCompositeMatcher(matchers []PathMatcher) PathMatcher

type PathSet 

type PathSet struct {
	Paths         []string
	BaseDirectory string
}

A PathSet stores one or more filepaths, along with the directory that any relative paths are relative to NOTE(maia): in its current usage (for LiveUpdate.Run.Triggers, LiveUpdate.FallBackOnFiles()) this isn't strictly necessary, could just as easily convert paths to Abs when specified in the Tiltfile--but leaving this code in place for now because it was already written and may help with complicated future cases (glob support, etc.)

func NewPathSet 

func NewPathSet(paths []string, baseDir string) PathSet

func (PathSet) AnyMatch 

func (ps PathSet) AnyMatch(paths []string) (bool, string, error)

AnyMatch returns true if any of the given filepaths match any paths contained in the pathset (along with the first path that matched).

func (PathSet) Empty 

func (ps PathSet) Empty() bool

type PodReadinessMode added in v0.17.0 

type PodReadinessMode string

Whether or not to wait for pods to become ready before marking the k8s resource healthy.

TODO(nick): I strongly suspect we will at least want a separate mode for jobs that waits until they become complete, as we do in `tilt ci` 

const PodReadinessIgnore PodReadinessMode = "ignore"

Don't even wait for pods to appear. 

const PodReadinessNone PodReadinessMode = ""

Pod readiness isn't applicable to this resource 

const PodReadinessWait PodReadinessMode = "wait"

Always wait for pods to become ready.

type PortForward 

type PortForward struct {
	// The port to connect to inside the deployed container.
	// If 0, we will connect to the first containerPort.
	ContainerPort int

	// The port to expose on the current machine.
	LocalPort int

	// Optional host to bind to on the current machine (localhost by default)
	Host string

	// Optional name of the port forward; if given, used as text of the URL
	// displayed in the web UI (e.g. <a href="localhost:8888">Debugger</a>)
	Name string
	// contains filtered or unexported fields
}

func MustPortForward added in v0.17.9 

func MustPortForward(local int, container int, host string, name string, path string) PortForward

func (PortForward) PathForAppend added in v0.17.9 

func (pf PortForward) PathForAppend() string
func (pf PortForward) ToLink() Link

func (PortForward) WithPath added in v0.17.9 

func (pf PortForward) WithPath(p *url.URL) PortForward

type Run 

type Run struct {
	// Required. The command to run.
	Cmd Cmd
	// Optional. If not specified, this command runs on every change.
	// If specified, we only run the Cmd if the changed file matches a trigger.
	Triggers PathSet
}

func ToRun 

func ToRun(cmd Cmd) Run

func ToRuns 

func ToRuns(cmds []Cmd) []Run

func (Run) WithTriggers 

func (r Run) WithTriggers(paths []string, baseDir string) Run

type RuntimeStatus added in v0.14.0 

type RuntimeStatus string
const (
	RuntimeStatusUnknown       RuntimeStatus = "unknown"
	RuntimeStatusOK            RuntimeStatus = "ok"
	RuntimeStatusPending       RuntimeStatus = "pending"
	RuntimeStatusError         RuntimeStatus = "error"
	RuntimeStatusNotApplicable RuntimeStatus = "not_applicable"
)

type Secret added in v0.10.10 

type Secret struct {
	// The name of the secret in the kubernetes cluster, so the user
	// can look it up themselves.
	Name string

	Key string

	Value []byte

	ValueEncoded []byte

	Replacement []byte
}

func (Secret) Scrub added in v0.10.10 

func (s Secret) Scrub(text []byte) []byte

type SecretSet added in v0.10.10 

type SecretSet map[string]Secret

Secrets are different than other kinds of build/deploy outputs.

Once something is marked as a secret, we want to scrub it from all logs until the user quits Tilt. Removing the secret from the Kubernetes cluster doesn't suddenly "reveal" the secret.

func (SecretSet) AddAll added in v0.10.10 

func (s SecretSet) AddAll(other SecretSet)

func (SecretSet) AddSecret added in v0.10.10 

func (s SecretSet) AddSecret(name string, key string, value []byte)

func (SecretSet) Scrub added in v0.10.10 

func (s SecretSet) Scrub(text []byte) []byte

type SecretSettings added in v0.14.0 

type SecretSettings struct {
	ScrubSecrets bool // whether to scrub secrets in logs
}

func DefaultSecretSettings added in v0.14.0 

func DefaultSecretSettings() SecretSettings

type Sync 

type Sync struct {
	LocalPath     string
	ContainerPath string
}

type Target 

type Target interface {
	Spec() TargetSpec
	Status() TargetStatus
}

type TargetGraph 

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

func NewTargetGraph 

func NewTargetGraph(targets []TargetSpec) (TargetGraph, error)

func (TargetGraph) DeployedImages 

func (g TargetGraph) DeployedImages() []ImageTarget

Returns all the images in the graph that are directly deployed to a container.

func (TargetGraph) DepsOf 

func (g TargetGraph) DepsOf(t TargetSpec) ([]TargetSpec, error)

Return the direct dependency targets.

func (TargetGraph) Images 

func (g TargetGraph) Images() []ImageTarget

func (TargetGraph) IsDeployedImage 

func (g TargetGraph) IsDeployedImage(iTarget ImageTarget) bool

Is this image directly deployed a container?

func (TargetGraph) IsSingleSourceDAG 

func (g TargetGraph) IsSingleSourceDAG() bool

In Tilt, Manifests should always be DAGs with a single root node (the deploy target). This is just a quick sanity check to make sure that's true, because many of our graph-traversal algorithms won't work if it's not true.

func (TargetGraph) VisitTree 

func (g TargetGraph) VisitTree(root TargetSpec, visit func(dep TargetSpec) error) error

Visit t and its transitive dependencies in post-order (aka depth-first)

type TargetID 

type TargetID struct {
	Type TargetType
	Name TargetName
}

func DedupeTargetIDs 

func DedupeTargetIDs(ids []TargetID) []TargetID

De-duplicate target ids, maintaining the same order.

func ImageID 

func ImageID(ref container.RefSelector) TargetID

func (TargetID) Empty 

func (id TargetID) Empty() bool

func (TargetID) String 

func (id TargetID) String() string

type TargetName 

type TargetName string

func (TargetName) String 

func (n TargetName) String() string

type TargetSpec 

type TargetSpec interface {
	ID() TargetID

	// Check to make sure the spec is well-formed.
	// All TargetSpecs should throw an error in the case where the ID is empty.
	Validate() error

	DependencyIDs() []TargetID
}

func TopologicalSort 

func TopologicalSort(targets []TargetSpec) ([]TargetSpec, error)

Create a topologically sorted list of targets. Returns an error if the targets can't be topologically sorted. (e.g., there's a cycle).

type TargetStatus 

type TargetStatus interface {
	TargetID() TargetID
	ActiveBuild() BuildRecord
	LastBuild() BuildRecord
}

type TargetType 

type TargetType string
const (
	// Deployed k8s entities
	TargetTypeK8s TargetType = "k8s"

	// Image builds
	// TODO(nick): It might make sense to represent FastBuild and normal Docker builds
	// as separate types.
	TargetTypeImage TargetType = "image"

	// Docker-compose service build and deploy
	// TODO(nick): Currently, build and deploy are represented as a single target.
	// In the future, we might have a separate build target and deploy target.
	TargetTypeDockerCompose TargetType = "docker-compose"

	// Runs a local command when triggered (manually or via changed dep)
	TargetTypeLocal TargetType = "local"

	// Aggregation of multiple targets into one UI view.
	// TODO(nick): Currently used as the type for both Manifest and YAMLManifest, though
	// we expect YAMLManifest to go away.
	TargetTypeManifest TargetType = "manifest"

	// Changes that affect all targets, rebuilding the target graph.
	TargetTypeConfigs TargetType = "configs"
)

type TelemetrySettings added in v0.10.25 

type TelemetrySettings struct {
	Cmd     Cmd
	Workdir string // directory from which this Cmd should be run

	// How often to send the trace data.
	Period time.Duration
}

type TelemetryStatus added in v0.10.25 

type TelemetryStatus struct {
	LastRunAt             time.Time
	ControllerActionCount int
}

type TiltBuild 

type TiltBuild struct {
	// Version w/o leading "v"
	Version   string
	CommitSHA string
	Date      string
	Dev       bool
}

Information on a build of the Tilt binary

func (TiltBuild) AnalyticsVersion 

func (b TiltBuild) AnalyticsVersion() string

func (TiltBuild) Empty 

func (b TiltBuild) Empty() bool

func (TiltBuild) HumanBuildStamp added in v0.15.0 

func (b TiltBuild) HumanBuildStamp() string

func (TiltBuild) WebVersion 

func (b TiltBuild) WebVersion() WebVersion

type TiltSubcommand added in v0.16.0 

type TiltSubcommand string

e.g., "up", "down", "ci"

func (TiltSubcommand) String added in v0.16.0 

func (t TiltSubcommand) String() string

type TriggerMode 

type TriggerMode int
const (
	// Tilt automatically performs initial and non-initial builds without manual intervention
	TriggerModeAuto TriggerMode = iota
	// Tilt automatically performs initial builds without manual intervention, but requires manual intervention for non-initial builds
	TriggerModeManualAfterInitial TriggerMode = iota
	// Tilt requires manual intervention for all builds, and never automatically performs a build
	TriggerModeManualIncludingInitial TriggerMode = iota
)

When Tilt decides that a resource could use a build, TriggerMode specifies whether to require manual approval before that build takes place. There are two classes of build as far as TriggerMode is concerned:

  1. Initial - A manifest's first build per `tilt up`. Either directly because the user ran `tilt up`, or because the user just added the manifest to the Tiltfile.
  2. Non-initial - After the initial build, any time one of the manifest's dependencies changes, the manifest is ready for an update

func (TriggerMode) AutoInitial added in v0.10.18 

func (t TriggerMode) AutoInitial() bool

func (TriggerMode) AutoOnChange added in v0.10.18 

func (t TriggerMode) AutoOnChange() bool

type UpdateSettings added in v0.14.0 

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

func DefaultUpdateSettings added in v0.14.0 

func DefaultUpdateSettings() UpdateSettings

func (UpdateSettings) K8sUpsertTimeout added in v0.14.0 

func (us UpdateSettings) K8sUpsertTimeout() time.Duration

func (UpdateSettings) MaxParallelUpdates added in v0.14.0 

func (us UpdateSettings) MaxParallelUpdates() int

func (UpdateSettings) WithK8sUpsertTimeout added in v0.14.0 

func (us UpdateSettings) WithK8sUpsertTimeout(timeout time.Duration) UpdateSettings

func (UpdateSettings) WithMaxParallelUpdates added in v0.14.0 

func (us UpdateSettings) WithMaxParallelUpdates(n int) UpdateSettings

type UserConfigState added in v0.10.24 

type UserConfigState struct {
	ArgsChangeTime time.Time
	Args           []string
}

func NewUserConfigState added in v0.10.24 

func NewUserConfigState(args []string) UserConfigState

func (UserConfigState) WithArgs added in v0.10.25 

func (ucs UserConfigState) WithArgs(args []string) UserConfigState

type VersionSettings added in v0.10.19 

type VersionSettings struct {
	CheckUpdates bool
}

type WatchSettings added in v0.17.6 

type WatchSettings struct {
	Ignores []Dockerignore
}

func (WatchSettings) Empty added in v0.17.6 

func (ws WatchSettings) Empty() bool

type WebDevPort 

type WebDevPort int

type WebHost added in v0.10.18 

type WebHost string

type WebMode 

type WebMode string
const (
	// By default, we serve the js locally in dev builds and from prod in released
	// builds.
	DefaultWebMode WebMode = "default"

	// Local webpack server
	LocalWebMode WebMode = "local"

	// Prod gcloud bucket
	ProdWebMode WebMode = "prod"

	// Precompiled with `make build-js`. This is an experimental mode
	// we're playing around with to avoid the cost of webpack startup.
	PrecompiledWebMode WebMode = "precompiled"
)

func (*WebMode) Set 

func (m *WebMode) Set(v string) error

func (*WebMode) String 

func (m *WebMode) String() string

func (*WebMode) Type 

func (m *WebMode) Type() string

type WebPort 

type WebPort int

type WebSHA added in v0.10.14 

type WebSHA string

Web version of the form aaaaaaa where a is a hex letter Used for fetching web assets

type WebURL 

type WebURL url.URL

func (WebURL) Empty 

func (u WebURL) Empty() bool

func (WebURL) String 

func (u WebURL) String() string

type WebVersion 

type WebVersion string

Web version of the form vA.B.C, where A, B, and C are integers Used for fetching web assets

Source Files

View all Source files

Directories

Path Synopsis
A central logstore.
 A central logstore.

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.