Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ImageOutdated ¶ added in v0.11.0
ImageOutdated reports whether a running container's image no longer matches the catalog entry it was deployed from. It is true when the provider changed the image path (the ProxyBase migration) or the catalog re-pinned to a new digest, so the UI can prompt a re-deploy instead of showing a healthy-looking container that is silently running a retired image and earning nothing. Deliberately conservative: unknown/empty images and a pure tag-vs-digest difference of the same repository are NOT flagged.
Types ¶
type Catalog ¶
type Catalog struct {
// contains filtered or unexported fields
}
func (*Catalog) ListVisible ¶
type CollectorMetadata ¶
type DockerConfig ¶
type DockerConfig struct {
Image string `json:"image" yaml:"image"`
Platforms []string `json:"platforms" yaml:"platforms"`
Env []EnvVar `json:"env" yaml:"env"`
Ports []string `json:"ports" yaml:"ports"`
Volumes []string `json:"volumes" yaml:"volumes"`
Command string `json:"command" yaml:"command"`
NetworkMode string `json:"networkMode" yaml:"network_mode"`
CapAdd []string `json:"capAdd" yaml:"cap_add"`
Privileged bool `json:"privileged" yaml:"privileged"`
StopTimeout int `json:"stopTimeout" yaml:"stop_timeout"`
Resources ResourceLimits `json:"resources" yaml:"resources"`
Setup string `json:"setup" yaml:"setup"`
Notes string `json:"notes" yaml:"notes"`
}
type EarningsEstimate ¶
type NativeBinary ¶ added in v0.10.0
type NativeBinary struct {
OS string `json:"os" yaml:"os"`
Arch string `json:"arch" yaml:"arch"`
URL string `json:"url" yaml:"url"`
SHA256 string `json:"sha256" yaml:"sha256"`
Archive string `json:"archive" yaml:"archive"`
Bin string `json:"bin" yaml:"bin"`
}
NativeBinary is one downloadable, SHA-256-pinned native executable for a specific OS/arch. OS matches Go's runtime.GOOS (darwin|linux|windows) and Arch matches runtime.GOARCH (amd64|arm64). URL must be HTTPS and SHA256 is the hex digest of the downloaded artifact (the archive or the raw binary) — the NativeProcessProvider verifies it and refuses to execute anything that fails or lacks verification. Archive is how the artifact is packaged: "tar.gz", "zip", or "none" (a raw binary). Bin is the path to the executable inside the extracted archive (e.g. "myst" or "myst.exe"); for archive "none" it is the on-disk name to give the raw binary.
type NativeConfig ¶ added in v0.10.0
type NativeConfig struct {
Binaries []NativeBinary `json:"binaries" yaml:"binaries"`
Command string `json:"command" yaml:"command"`
Env []EnvVar `json:"env" yaml:"env"`
}
NativeConfig is the optional native: block from a service YAML. It declares how a service can be run as a supervised native child process (no container): a per OS/arch pinned binary download plus a launch-argument template. It is additive and parallel to DockerConfig — a service may declare docker:, native:, or both. The NativeProcessProvider (internal/runtime) downloads+verifies+extracts the matching Binary and launches it with argv built from Command via the same shell-safe tokenizeCommand/substitute path Docker uses, reusing the existing EnvVar type for Env so the schema stays consistent.
type Requirements ¶
type Requirements struct {
ResidentialIP bool `json:"residentialIp" yaml:"residential_ip"`
VPSIP bool `json:"vpsIp" yaml:"vps_ip"`
DevicesPerAccount int `json:"devicesPerAccount" yaml:"devices_per_account"`
DevicesPerIP int `json:"devicesPerIp" yaml:"devices_per_ip"`
MinBandwidth string `json:"minBandwidth" yaml:"min_bandwidth"`
GPU bool `json:"gpu" yaml:"gpu"`
MinStorage string `json:"minStorage" yaml:"min_storage"`
Note string `json:"note" yaml:"note"`
}
type ResourceLimits ¶ added in v0.8.0
type ResourceLimits struct {
MemLimit string `json:"memLimit" yaml:"mem_limit"`
MemReservation string `json:"memReservation" yaml:"mem_reservation"`
OomScoreAdj *int `json:"oomScoreAdj" yaml:"oom_score_adj"`
}
ResourceLimits is the optional docker.resources block from a service YAML. Its fields map to Docker HostConfig knobs applied at container creation (see internal/runtime.applyResourceLimits) so a service's memory ceiling and OOM priority survive restarts instead of being set out-of-band. MemLimit and MemReservation are Docker-style size strings ("768m", "2g"); an empty string leaves that limit unset. OomScoreAdj is a pointer so an absent value is distinguishable from an explicit 0 and is applied only when present.
type Service ¶
type Service struct {
Name string `json:"name" yaml:"name"`
Slug string `json:"slug" yaml:"slug"`
Category string `json:"category" yaml:"category"`
Status string `json:"status" yaml:"status"`
Website string `json:"website" yaml:"website"`
Description string `json:"description" yaml:"description"`
ShortDescription string `json:"shortDescription" yaml:"short_description"`
Referral Referral `json:"referral" yaml:"referral"`
Docker DockerConfig `json:"docker" yaml:"docker"`
Native NativeConfig `json:"native" yaml:"native"`
Requirements Requirements `json:"requirements" yaml:"requirements"`
Payment Payment `json:"payment" yaml:"payment"`
Earnings EarningsEstimate `json:"earnings" yaml:"earnings"`
Cashout Cashout `json:"cashout" yaml:"cashout"`
Platforms []string `json:"platforms" yaml:"platforms"`
Collector CollectorMetadata `json:"collector" yaml:"collector"`
SourcePath string `json:"sourcePath" yaml:"-"`
ManualOnly bool `json:"manualOnly" yaml:"-"`
}
func (Service) HasNative ¶ added in v0.10.0
HasNative reports whether the service declares at least one native binary, i.e. it can be run as a supervised native child process (by the NativeProcessProvider) instead of, or in addition to, a Docker container. It is the native counterpart of the "has a Docker image" check that drives ManualOnly and runtime routing.
func (Service) NativeBinaryFor ¶ added in v0.10.0
func (s Service) NativeBinaryFor(goos, goarch string) (NativeBinary, bool)
NativeBinaryFor returns the native binary declared for the given GOOS/GOARCH (as in Go's runtime.GOOS/GOARCH), and whether one exists. It is used both by the runtime provider (to pick the artifact to download) and by routing (to prefer native only when this host actually has a native binary available).