Documentation
¶
Overview ¶
Package toolversions reads a tool versions list (stock/tool-versions.yaml, shipped as a tool versions update) and owns the one a process uses: Versions answers its current list as an immutable Snapshot, the images AppTown runs for itself among it (the shell guidance checks run in, the df behind disk reads, the static server of release images, the private Docker daemon). apptownd and apptown-worker fill it at start from the update shipped beside them; owners take it, or the narrow Source, and each unit of work takes one Snapshot at its start. Nothing is compiled in and nothing is global.
Index ¶
Constants ¶
const ( ToolSh = "apptown-sh" ToolDF = "apptown-df" ToolStaticServer = "static-server" ToolPrivateDocker = "private-docker" )
The runtime tools and the line this build runs of each. A line is the build's choice; the list says what it means exactly.
Variables ¶
This section is empty.
Functions ¶
func ShippedDir ¶
ShippedDir is where a process finds the updates its release shipped: dir when given (-shipped), else stockupdate.Dir of its own executable.
Types ¶
type Entry ¶
type Entry struct {
Version string `yaml:"version"`
Label string `yaml:"label,omitempty"`
Images map[string]string `yaml:"images,omitempty"`
EndOfLife string `yaml:"endOfLife,omitempty"`
}
Entry is what one line names exactly.
type Images ¶
type Images struct {
Sh, DF, StaticServer, PrivateDocker string
}
Images is the set of runtime images.
type List ¶
List is a tool versions list: tool → line → entry.
func Parse ¶
Parse reads a tool versions document and validates it: every entry has an exact version, and every image names a digest.
type Snapshot ¶
type Snapshot struct {
Name, Digest string
Images Images
// contains filtered or unexported fields
}
Snapshot is one tool versions list as a unit of work uses it: the list, its runtime images and its identity, the update's name and the digest of what was read. It is never changed after it is made.
func NewSnapshot ¶
NewSnapshot validates a list's document and makes its snapshot, named name; the digest is of raw.
func Shipped ¶
Shipped reads the tool versions update in dir that this build, of version, can read: the newest, its worksWith judged (a dev- build's is not), its list validated, as a snapshot named by the update.
type Source ¶
type Source interface {
Current() Snapshot
}
Source is what an owner that runs images asks: the current snapshot.
type Versions ¶
type Versions struct {
// contains filtered or unexported fields
}
Versions owns a process's tool versions: the current validated list.
Source Files