Versions in this module Expand all Collapse all v0 v0.4.2 Oct 26, 2026 v0.4.1 Oct 26, 2026 v0.4.0 Oct 23, 2026 Changes in this version type ComposeSpec + ProjectEnv map[string]string v0.3.1 Oct 21, 2026 v0.3.0 Oct 21, 2026 v0.2.1 Oct 14, 2026 v0.2.0 Oct 14, 2026 Changes in this version type Definition + ApplyWiring func(def *Definition, wiring any) (*Definition, error) v0.1.0 Oct 14, 2026 Changes in this version + const VarBlock + func AliasFor(d *Definition, ordinal, replicas int) (string, error) + func Assemble(inj *ConfigInjection, repoRoot string, blockOverlay string, vars Vars) ([]byte, error) + func EnvFileContent(env map[string]string) []byte + func Label(name string, ordinal, replicas int) string + func Merge(base string, overlays ...string) ([]byte, error) + func MergeTrees(base map[string]any, overlays ...map[string]any) (map[string]any, error) + func MergeWithVars(vars Vars, base string, overlays ...string) ([]byte, error) + type ComposeSpec struct + BootAttempts int + ComposeFile string + ComposeOverrideFiles []string + CoverageServices []CoverageService + Env map[string]string + GeneratedFiles map[string][]byte + PrimaryService string + Services []string + StagedFiles map[string]string + func (c *ComposeSpec) StagingName() string + func (c *ComposeSpec) StagingNames() []string + func (c *ComposeSpec) WithGenerated(files map[string][]byte) *ComposeSpec + type ConfigFormat string + const TOML + type ConfigInjection struct + BaseConfigPath string + ContainerPath string + ExtraOverlays []string + Format ConfigFormat + SharedOverlayPath string + Versioned map[string]ConfigProfile + func (inj *ConfigInjection) ForVersion(version string) (*ConfigInjection, error) + type ConfigProfile struct + BaseConfigPath string + SharedOverlayPath string + type CoverageService struct + Name string + OutputName string + Types []string + type DBContract struct + Env func(DSN) map[string]string + Schema map[DBType][]string + SelfMigrates []DBType + SharesStoreWith string + Supported []DBType + func (c *DBContract) Owns() bool + func (c *DBContract) SchemaFor(t DBType) ([]string, bool) + func (c *DBContract) Supports(t DBType) bool + type DBType string + const Postgres + const SQLServer + const SQLite + func (d DBType) Embedded() bool + func (d DBType) Valid() bool + type DSN struct + Database string + FilePath string + Host string + Password string + Port int + SSLMode string + Type DBType + User string + type Definition struct + Alias string + AliasIsFixed bool + Cmd []string + Compose *ComposeSpec + Config *ConfigInjection + DB *DBContract + DependsOn []string + Endpoints []Endpoint + Env map[string]string + External *ExternalSpec + Files []FileMount + Health *HealthCheck + Image ImageRef + Limits ResourceLimits + Name string + Provisions func(ctx context.Context, inst *Instance, dependent string) (map[string]string, error) + Shared bool + SourceProduct string + VersionedHealth map[string]HealthCheck + Wiring WiringSpec + func (d *Definition) Endpoint(name string) (Endpoint, bool) + func (d *Definition) ExternalEndpointNames() []string + func (d *Definition) IsCompose() bool + func (d *Definition) IsExternal() bool + func (d *Definition) Product() string + func (d *Definition) ResolveDBType(explicit, blockDefault DBType) (DBType, error) + func (d *Definition) String() string + func (d *Definition) Validate() error + func (d *Definition) WithConfigVersion(version string) (*Definition, error) + func (d *Definition) WithImageVersion(version string) *Definition + func (d *Definition) WithReleaseVersion(version string) (*Definition, error) + func (d *Definition) WithStagedFiles(overrides map[string]string) (*Definition, error) + type Endpoint struct + AwaitListening bool + Name string + PathPrefix string + Port int + Scheme string + Service string + type ExternalEndpoint struct + Name string + type ExternalSpec struct + Endpoints []ExternalEndpoint + RequiredParameters []string + Resolve func(repoRoot string, parameters map[string]string) (map[string]string, error) + type FileMount struct + ContainerPath string + Content []byte + HostPath string + Mode int64 + type HealthCheck struct + Endpoint string + ExpectStatus int + Interval time.Duration + Path string + Service string + Timeout time.Duration + type ImageBuild struct + Args map[string]string + Context string + Dockerfile string + type ImageRef struct + Build *ImageBuild + ByArch map[string]string + Ref string + func (i ImageRef) Resolve(arch string) string + func (i ImageRef) WithVersion(version string) ImageRef + type Instance struct + func NewExternalInstance(def *Definition, ordinal, replicas int, urls map[string]string) (*Instance, error) + func NewInstance(def *Definition, ordinal, replicas int, host string, mapped map[int]int) (*Instance, error) + func (i *Instance) Alias() string + func (i *Instance) Definition() *Definition + func (i *Instance) EndpointNames() []string + func (i *Instance) Host() string + func (i *Instance) InternalURL(endpoint string) (string, error) + func (i *Instance) Label() string + func (i *Instance) MappedPort(endpoint string) (int, error) + func (i *Instance) Name() string + func (i *Instance) Ordinal() int + func (i *Instance) RefreshPorts(mapped map[int]int) + func (i *Instance) URL(endpoint string) (string, error) + type Registry struct + func NewRegistry() *Registry + func (r *Registry) Len() int + func (r *Registry) Lookup(name string) (*Definition, bool) + func (r *Registry) MustRegister(defs ...*Definition) *Registry + func (r *Registry) Names() []string + func (r *Registry) Register(d *Definition) error + func (r *Registry) Validate() error + type ResourceLimits struct + CPUs float64 + MemoryMB int64 + type Set struct + func NewSet() *Set + func (s *Set) Add(inst *Instance) error + func (s *Set) All(name string) []*Instance + func (s *Set) At(name string, ordinal int) (*Instance, error) + func (s *Set) Get(name string) (*Instance, error) + func (s *Set) Len() int + func (s *Set) Names() []string + type Vars map[string]string + type WiringSpec interface + Decode func(node *yaml.Node) (any, error) + func TypedWiring[T any]() WiringSpec
Go to main page