compose

type Command []string

type DependsOn []string

type Deploy struct {
	Resources struct {
		Reservations struct {
			Devices []Device `yaml:"devices"`
		} `yaml:"reservations"`
		Limits deployLimits `yaml:"limits"`
	} `yaml:"resources"`
	// Replicas maps onto the same store.DesiredService.Replicas /
	// spec.Service.Replicas field a service's own top-level replicas:
	// (app.yaml) already resolves through. Zero means unset.
	Replicas int `yaml:"replicas"`
	// contains filtered or unexported fields
}

type Device struct {
	Driver       string           `yaml:"driver"`
	Count        yamlScalarString `yaml:"count"`
	DeviceIDs    []string         `yaml:"device_ids"`
	Capabilities []string         `yaml:"capabilities"`
}

type EnvFileRef struct {
	Path     string
	Required bool
}

type Environment map[string]string

type ExpandOption func(*expandConfig)

type File struct {
	Version  string
	Services map[string]Service
	// CapGrants lists, per service key, the cap_add values a manifest declared and
	// the caller approved. Never read from YAML; unset means cap_add is rejected.
	CapGrants map[string][]string
	// DropUngrantedCaps drops a Review or Elevated cap_add that CapGrants no longer
	// covers instead of rejecting it, for a rollback to a revision made under older policy.
	DropUngrantedCaps bool
	// Domains maps a service key to the real domain it should be
	// reachable at, from the top-level x-levelrail-domains extension
	// (Compose's own reserved x- prefix for tool-specific keys). Used
	// both to set that service's own store.DesiredService.Domains (real
	// ingress routing) and to resolve any ${SERVICE_FQDN_*} reference
	// within that same service's environment (ResolveMagicVars).
	Domains map[string]string
	// RuntimeDomains holds domains assigned after deploy (service key to
	// host). Only SERVICE_FQDN and SERVICE_URL resolution reads it, so a
	// re-render never changes what ToDesiredServices persists.
	RuntimeDomains map[string]string
	// Networks lists this file's own top-level networks: names, sorted.
	// Only used by Notices to detect that custom networks were declared
	// at all; Levelrail doesn't create per-network isolation from this.
	Networks []string
	// HasSecrets/HasConfigs record whether this file declares a top-level
	// secrets: or configs: block: neither has a translation onto this
	// platform's own env-var/Levelrail-secrets model, so validate rejects
	// either outright (unlike restart:/networks:/depends_on:, which parse
	// and are merely non-blocking Notices) rather than silently dropping
	// values an operator would reasonably expect to reach a container.
	HasSecrets bool
	HasConfigs bool
	// Unsupported lists keys that parsed but are not read, so Notices can
	// report them instead of dropping them silently.
	Unsupported []UnsupportedKey
	// InterpVars are the variables ${VAR:-default} forms in env values read
	// (app env and saved env keys); nil means every variable is unset.
	InterpVars map[string]string
	// InterpWarnings collects names-only notes about unset variables.
	InterpWarnings []string
}

type Healthcheck struct {
	Test        healthcheckTest `yaml:"test"`
	Interval    string          `yaml:"interval"`
	Timeout     string          `yaml:"timeout"`
	Retries     int             `yaml:"retries"`
	StartPeriod string          `yaml:"start_period"`
}

type HostAccess struct {
	Privileged  bool     `yaml:"privileged"`
	NetworkMode string   `yaml:"network_mode"`
	Pid         string   `yaml:"pid"`
	Ipc         string   `yaml:"ipc"`
	Uts         string   `yaml:"uts"`
	UsernsMode  string   `yaml:"userns_mode"`
	Cgroup      string   `yaml:"cgroup"`
	CapAdd      []string `yaml:"cap_add"`
	Devices     []any    `yaml:"devices"`
	SecurityOpt []string `yaml:"security_opt"`
	VolumesFrom []string `yaml:"volumes_from"`
}

type MagicVar struct {
	Token       string
	Kind        string
	Key         string
	Length      int
	Default     string
	HasDefault  bool
	Generatable bool
}

type MissingVar struct {
	Name    string `json:"name"`
	Message string `json:"message"`
}

type Networks []string

type Notice struct {
	Level   NoticeLevel
	Message string
	// Service, Key and Alternative are set for an ignored-key warning.
	Service     string
	Key         string
	Alternative string
}

type NoticeLevel string

type Port struct {
	HostPort      int
	ContainerPort int
	// Protocol is empty for tcp (the default) or "udp".
	Protocol string
}

type SecretMatcher func(key, value string) bool

type Service struct {
	Image       string
	Build       *rawBuild
	Environment Environment
	Ports       []Port
	Volumes     []Volume
	Labels      map[string]string
	Networks    Networks
	Restart     string
	Healthcheck *Healthcheck
	// DependsOn is depends_on:, enforced by the reconciler as a start-
	// order guarantee (see this file's own doc comment and Notices).
	DependsOn DependsOn
	// Command overrides the image's own default CMD
	// (store.DesiredService.Command), parsed from command:'s own
	// string-or-list union (Command's own UnmarshalYAML in yaml.go): a
	// plain string is shell-wrapped as ["/bin/sh", "-c", "<string>"],
	// matching Compose's own documented behavior for that form.
	Command Command
	// Entrypoint overrides the image's own default ENTRYPOINT
	// (store.DesiredService.Entrypoint), parsed with the same
	// string-or-list union as Command.
	Entrypoint Command
	// User and WorkingDir are user: and working_dir:, validated like app.yaml's.
	User       string
	WorkingDir string
	// PullPolicy is pull_policy:, normalized by normalizePullPolicy into
	// exactly the two states store.DesiredService.PullPolicy
	// distinguishes: PullPolicyAlways forces a fresh pull even when the
	// image is already present locally, empty means today's existing
	// pull-if-absent behavior. Real Compose's other recognized spellings
	// ("missing", "if_not_present", an unset field) all normalize to
	// empty too; "never" and "build" are rejected, see
	// normalizePullPolicy.
	PullPolicy string
	// Deploy carries the GPU device reservation and replicas count
	// (gpu.go).
	Deploy *Deploy
	// Secrets/Configs are this service's own secrets:/configs: references
	// (short string form or long {source, target,...} map form, either
	// decodes fine into []any since only their presence matters here),
	// the per-service counterpart to File.HasSecrets/HasConfigs; same
	// rejection reasoning, see validateComposeServices.
	Secrets []any
	Configs []any
	// Files are inline configs: content translated to container files.
	Files []spec.File
	// Profiles gates the service behind compose profiles (ApplyProfiles).
	Profiles []string
	// MemLimit and CPUs are the mem_limit: and cpus: shorthands for a hard cap.
	MemLimit yamlScalarString
	CPUs     yamlScalarString
	// ShmSize is shm_size:, the /dev/shm size Chromium based apps need.
	ShmSize yamlScalarString
	// Allowlisted runtime tuning keys, mapped by runtimeFromService.
	Tmpfs           stringList
	Ulimits         map[string]spec.Ulimit
	Init            *bool
	StopGracePeriod string
	ExtraHosts      hostList
	DNS             stringList
	Sysctls         sysctlMap
	CapDrop         []string
	PidsLimit       int
	ReadOnly        bool
	HostAccess      HostAccess
	// Strategy is x-levelrail-strategy: a deploy strategy the template needs,
	// such as recreate for an app that locks its state volume. Empty means default.
	Strategy       string
	StrategyReason string
	// PlatformProbe is x-levelrail-healthcheck, see resolveServiceHealth.
	PlatformProbe *spec.PlatformProbe
	// PublishedTCP is x-levelrail-published-ports: tcp container ports from
	// ports: published on their own host port with a private bind, instead
	// of being dropped. The routed web port is the first tcp port not listed.
	PublishedTCP []int
	// DependsOnHealthy lists the DependsOn entries declared with
	// condition: service_healthy, which wait for readiness, not just start.
	DependsOnHealthy []string
	// DependsOnCompleted lists the DependsOn entries declared with
	// condition: service_completed_successfully, which wait for exit 0.
	DependsOnCompleted []string
	// EnvFiles is env_file:, read by ResolveEnvFiles when a checkout exists.
	EnvFiles []EnvFileRef
}

type StrictError struct {
	Code    string
	Rule    string
	Service string
	Key     string
	Line    int
	Message string
}

type StrictErrors []*StrictError

type StrictLimits struct {
	MaxBytes int
	MaxNodes int
}

type Translation struct {
	Compose     string
	Generated   []string
	Hosts       []string
	Unsupported []string
}

type UnresolvedVar struct {
	Service string
	EnvKey  string
	Token   string
}

type UnsupportedKey struct {
	Service     string
	Key         string
	Alternative string
}

type Volume struct {
	Name          string
	HostPath      string
	ContainerPath string
	// ReadOnly mounts read-only inside the container, from an optional
	// trailing ":ro" on the short-form entry.
	ReadOnly bool
}