webview

Documentation

Index

• func NeedsNudge(st store.EngineState) bool
• func NewProtoDCResourceInfo(configPaths []string, status dockercompose.Status, cID container.ID, ...) (*proto_webview.DCResourceInfo, error)
• func StateToProtoView(s store.EngineState) (*proto_webview.View, error)
• func ToProtoBuildRecord(br model.BuildRecord) (*proto_webview.BuildRecord, error)
• func ToProtoBuildRecords(brs []model.BuildRecord) ([]*proto_webview.BuildRecord, error)
• type Alert
• type BuildRecord
  • func ToWebViewBuildRecord(br model.BuildRecord) BuildRecord
  • func ToWebViewBuildRecords(brs []model.BuildRecord) []BuildRecord
• type DCResourceInfo
  • func NewDCResourceInfo(configPaths []string, status dockercompose.Status, cID container.ID, ...) DCResourceInfo
  • func (dcInfo DCResourceInfo) RuntimeLog() model.Log
  • func (dcInfo DCResourceInfo) Status() string
• type K8sResourceInfo
  • func (k8sInfo K8sResourceInfo) RuntimeLog() model.Log
  • func (k8sInfo K8sResourceInfo) Status() string
• type LocalResourceInfo
  • func (LocalResourceInfo) RuntimeLog() model.Log
  • func (LocalResourceInfo) Status() string
• type Resource
  • func (r Resource) LastBuild() BuildRecord
  • func (r Resource) ResourceInfo() ResourceInfoView
• type ResourceInfoView
• type RuntimeStatus
• type TiltBuild
• type View
• type YAMLResourceInfo
  • func (yamlInfo YAMLResourceInfo) RuntimeLog() model.Log
  • func (yamlInfo YAMLResourceInfo) Status() string

Functions

func NeedsNudge

func NeedsNudge(st store.EngineState) bool

func NewProtoDCResourceInfo

func NewProtoDCResourceInfo(configPaths []string, status dockercompose.Status, cID container.ID, log model.Log, startTime time.Time) (*proto_webview.DCResourceInfo, error)

func StateToProtoView

func StateToProtoView(s store.EngineState) (*proto_webview.View, error)

func ToProtoBuildRecord

func ToProtoBuildRecord(br model.BuildRecord) (*proto_webview.BuildRecord, error)

func ToProtoBuildRecords

func ToProtoBuildRecords(brs []model.BuildRecord) ([]*proto_webview.BuildRecord, error)

Types

type Alert

type Alert struct {
	AlertType    string `json:"alertType"`
	Header       string `json:"header"`
	Message      string `json:"msg"`
	Timestamp    string `json:"timestamp"`
	ResourceName string `json:"resourceName"`
}

type BuildRecord

type BuildRecord struct {
	Edits          []string  `json:"edits"`
	Error          string    `json:"error"`
	Warnings       []string  `json:"warnings"`
	StartTime      time.Time `json:"startTime"`
	FinishTime     time.Time `json:"finishTime"` // IsZero() == true for in-progress builds
	Log            model.Log `json:"log"`
	IsCrashRebuild bool      `json:"isCrashRebuild"`
}

func ToWebViewBuildRecord

func ToWebViewBuildRecord(br model.BuildRecord) BuildRecord

func ToWebViewBuildRecords

func ToWebViewBuildRecords(brs []model.BuildRecord) []BuildRecord

type DCResourceInfo

type DCResourceInfo struct {
	ConfigPaths     []string             `json:"configPaths"`
	ContainerStatus dockercompose.Status `json:"containerStatus"`
	ContainerID     container.ID         `json:"containerID"`
	Log             model.Log            `json:"log"`
	StartTime       time.Time            `json:"startTime"`
}

func NewDCResourceInfo

func NewDCResourceInfo(configPaths []string, status dockercompose.Status, cID container.ID, log model.Log, startTime time.Time) DCResourceInfo

func (DCResourceInfo) RuntimeLog

func (dcInfo DCResourceInfo) RuntimeLog() model.Log

func (DCResourceInfo) Status

func (dcInfo DCResourceInfo) Status() string

type K8sResourceInfo

type K8sResourceInfo struct {
	PodName            string    `json:"podName"`
	PodCreationTime    time.Time `json:"podCreationTime"`
	PodUpdateStartTime time.Time `json:"podUpdateStartTime"`
	PodStatus          string    `json:"podStatus"`
	PodStatusMessage   string    `json:"podStatusMessage"`
	AllContainersReady bool      `json:"allContainersReady"`
	PodRestarts        int       `json:"podRestarts"`
	PodLog             model.Log `json:"podLog"`
}

func (K8sResourceInfo) RuntimeLog

func (k8sInfo K8sResourceInfo) RuntimeLog() model.Log

func (K8sResourceInfo) Status

func (k8sInfo K8sResourceInfo) Status() string

type LocalResourceInfo

type LocalResourceInfo struct{}

Local resources have no run time info, so it's all empty.

func (LocalResourceInfo) RuntimeLog

func (LocalResourceInfo) RuntimeLog() model.Log

func (LocalResourceInfo) Status

func (LocalResourceInfo) Status() string

type Resource

type Resource struct {
	Name               model.ManifestName `json:"name"`
	DirectoriesWatched []string           `json:"directoriesWatched"`
	PathsWatched       []string           `json:"pathsWatched"`
	LastDeployTime     time.Time          `json:"lastDeployTime"`
	TriggerMode        model.TriggerMode  `json:"triggerMode"`

	BuildHistory []BuildRecord `json:"buildHistory"`
	CurrentBuild BuildRecord   `json:"currentBuild"`

	PendingBuildReason model.BuildReason `json:"pendingBuildReason"`
	PendingBuildEdits  []string          `json:"pendingBuildEdits"`
	PendingBuildSince  time.Time         `json:"pendingBuildSince"`
	HasPendingChanges  bool              `json:"hasPendingChanges"`

	Endpoints []string  `json:"endpoints"`
	PodID     k8s.PodID `json:"podID"`

	// Only one of these resource info fields will be populated
	K8sResourceInfo   *K8sResourceInfo   `json:"k8sResourceInfo,omitempty"`
	DCResourceInfo    *DCResourceInfo    `json:"dcResourceInfo,omitempty"`
	YAMLResourceInfo  *YAMLResourceInfo  `json:"yamlResourceInfo,omitempty"`
	LocalResourceInfo *LocalResourceInfo `json:"localResourceInfo,omitempty"`

	RuntimeStatus RuntimeStatus `json:"runtimeStatus"`

	IsTiltfile      bool      `json:"isTiltfile"`
	ShowBuildStatus bool      `json:"showBuildStatus"` // if true, we show status & time in 'Build Status'; else, "N/A"
	CombinedLog     model.Log `json:"combinedLog"`
	CrashLog        model.Log `json:"crashLog"`

	Alerts []Alert `json:"alerts"`

	Facets []model.Facet `json:"facets"`
}

func (Resource) LastBuild

func (r Resource) LastBuild() BuildRecord

func (Resource) ResourceInfo

func (r Resource) ResourceInfo() ResourceInfoView

type ResourceInfoView

type ResourceInfoView interface {
	RuntimeLog() model.Log
	Status() string
	// contains filtered or unexported methods
}

type RuntimeStatus

type RuntimeStatus string

const (
	RuntimeStatusOK            RuntimeStatus = "ok"
	RuntimeStatusPending       RuntimeStatus = "pending"
	RuntimeStatusError         RuntimeStatus = "error"
	RuntimeStatusNotApplicable RuntimeStatus = "not_applicable"
)

type TiltBuild

type TiltBuild struct {
	Version   string `json:"version"`
	CommitSHA string `json:"commitSHA"`
	Date      string `json:"date"`
	Dev       bool   `json:"dev"`
}

type View

type View struct {
	Log       model.Log  `json:"log"`
	Resources []Resource `json:"resources"`

	FeatureFlags map[string]bool `json:"featureFlags"`

	NeedsAnalyticsNudge bool `json:"needsAnalyticsNudge"`

	RunningTiltBuild TiltBuild `json:"runningTiltBuild"`
	LatestTiltBuild  TiltBuild `json:"latestTiltBuild"`

	TiltCloudUsername   string `json:"tiltCloudUsername"`
	TiltCloudSchemeHost string `json:"tiltCloudSchemeHost"`
	TiltCloudTeamID     string `json:"tiltCloudTeamID"`

	FatalError string `json:"fatalError"`
}

type YAMLResourceInfo

type YAMLResourceInfo struct {
	K8sResources []string `json:"k8sResources"`
}

func (YAMLResourceInfo) RuntimeLog

func (yamlInfo YAMLResourceInfo) RuntimeLog() model.Log

func (YAMLResourceInfo) Status

func (yamlInfo YAMLResourceInfo) Status() string