Documentation
¶
Overview ¶
Package config loads and validates a skiff.toml describing a single app.
Index ¶
Constants ¶
View Source
const DefaultFile = "skiff.toml"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildConfig ¶
type BuildConfig struct {
Dockerfile string `toml:"dockerfile"`
Port int `toml:"port"`
// Optional recipe overrides — set start or static to skip auto-detection
// and build from these instead of a Dockerfile.
Base string `toml:"base"`
Install string `toml:"install"`
Build string `toml:"build"`
Start string `toml:"start"`
Static string `toml:"static"`
}
type Config ¶
type Config struct {
Name string `toml:"name"`
Replicas int `toml:"replicas"` // how many identical containers to run behind the router
Server ServerConfig `toml:"server"`
Build BuildConfig `toml:"build"`
Deploy DeployConfig `toml:"deploy"`
Resources ResourcesConfig `toml:"resources"`
Env map[string]string `toml:"env"` // available at build + runtime
Secrets map[string]string `toml:"secrets"` // runtime only (never baked into the image)
}
func (*Config) RemoteHost ¶
func (*Config) TargetLabel ¶
type DeployConfig ¶
type DeployConfig struct {
Release string `toml:"release"` // command run once (e.g. migrations) before a new version goes live
Network string `toml:"network"` // docker network to join for team isolation; empty = shared "skiff"
}
DeployConfig holds deploy-lifecycle hooks.
type ResourcesConfig ¶
type ServerConfig ¶
type ServerConfig struct {
Host string `toml:"host"`
}
ServerConfig describes where the app runs. An empty host means local Docker.
Click to show internal directories.
Click to hide internal directories.