spec

package

Go to main page

Versions in this module

v0

v0.17.2

Nov 2, 2026

v0.17.1

Nov 1, 2026

v0.17.0

Oct 29, 2026

Changes in this version

type AppSpec

+ Availability Availability

+ type Availability struct

+ Priority int

+ Standby StandbyMode

+ func (a Availability) WantsStandby(policyDefault bool) bool

+ type StandbyMode string

+ const StandbyDefault

+ const StandbyOff

+ const StandbyOn

v0.16.0

Oct 26, 2026

v0.15.1

Oct 25, 2026

v0.15.0

Oct 24, 2026

Changes in this version

+ func LimitsChanged(prev, next *AppSpec) bool

v0.14.0

Oct 23, 2026

Changes in this version

+ func AliasProblem(alias string) string

+ func CheckUploadOwner(src Source, appID string) error

+ func ConfineStoredPaths(s *AppSpec)

+ func MountPathProblem(p string) string

+ func ReservedName(name string) bool

+ func ValidHostname(h string) bool

type AppSpec

+ func (s *AppSpec) NamesImage(ref string) bool

+ func (s *AppSpec) WorkloadLimits(w Workload) ResourceLimits

type ResourceLimits

+ func LimitWithin(own ResourceLimits, app Resources) ResourceLimits

v0.13.0

Oct 21, 2026

Changes in this version

+ func ReadsSecret(s *AppSpec, key string) bool

v0.12.0

Oct 20, 2026

v0.11.0

Oct 20, 2026

v0.10.0

Oct 19, 2026

v0.9.0

Oct 18, 2026

v0.8.0

Oct 16, 2026

Changes in this version

+ func CheckSourceURL(src Source) error

v0.7.0

Oct 15, 2026

v0.6.1

Oct 14, 2026

v0.6.0

Oct 14, 2026

v0.5.0

Oct 13, 2026

Changes in this version

+ var PostgresSchemes = []string

+ func BuildInputs(s *AppSpec) string

+ func CheckSlotValue(s *AppSpec, slot, value string) error

+ func SlotPartOf(value string, part SlotPart) (string, bool)

type EnvEntry

+ SlotPart SlotPart

+ type SecretFormat string

+ const FormatDjangoKey

+ const FormatHex64

+ const FormatLaravelKey

+ const FormatRandom

+ const FormatRandomLong

+ func (f SecretFormat) Check(key, value string) error

+ func (f SecretFormat) Known() bool

type Slot

+ Aliases []string

+ Format SecretFormat

+ Scheme string

+ type SlotPart string

+ const SlotPartDatabase

+ const SlotPartHost

+ const SlotPartHostPort

+ const SlotPartPassword

+ const SlotPartPort

+ const SlotPartUser

+ func (p SlotPart) Known() bool

type SlotType

+ const SlotMemcached

+ const SlotMongoDB

type Workload

+ Aliases []string

+ func (w Workload) HTTPPort() (int, bool)

v0.4.0

Oct 11, 2026

Changes in this version

+ const FileSizeLimit

+ const SchemaVersion

+ const WarnComposeConstructRewritten

+ const WarnNoPersistentVolume

+ const WarnPathRoutingIncompatible

+ const WarnPrimaryWorkloadAssumed

+ const WarnScreeningAdvisory

+ const WarnUndeclaredDependency

+ var ReservedPaths = []string

+ func Address(host, slug string, r Routing) string

+ func CheckPathPrefix(p string) *errs.Error

+ func DropStalePin(prev, next *AppSpec)

+ func EnvSlot(s *AppSpec, workload, key string) (string, bool)

+ func FillSlotLiteral(s *AppSpec, slot, secretRef string) bool

+ func FillSlotValue(s *AppSpec, slot, value string) bool

+ func MarkSlotOptional(s *AppSpec, slot string) bool

+ func NormalizePathPrefix(p string) string

+ func SetEnv(s *AppSpec, workload, key string, entry EnvEntry)

+ func SetHostname(s *AppSpec, hostname string) error

+ func SlotSecretKey(slot string) string

+ func Validate(s *AppSpec) error

+ type AppSpec struct

+ AppID string

+ Build Build

+ CreatedAt time.Time

+ CreatedBy string

+ Deploy Deploy

+ Egress Egress

+ Health Health

+ Origin Origin

+ Resources Resources

+ Retention Retention

+ Revision int

+ Routing Routing

+ Runtime RuntimeRef

+ SchemaVersion int

+ Slots []Slot

+ Source Source

+ Volumes []Volume

+ Warnings []Warning

+ Workloads []Workload

+ func Carry(pinned, next *AppSpec) *AppSpec

+ func (s *AppSpec) PrimaryWorkload() (Workload, bool)

+ func (s *AppSpec) Slot(key string) (Slot, bool)

+ func (s *AppSpec) Volume(id string) (Volume, bool)

+ type AutoDeploy struct

+ Branch string

+ Enabled bool

+ TagPattern string

+ Trigger AutoDeployTrigger

+ type AutoDeployTrigger string

+ const TriggerBranchUpdated

+ const TriggerReleaseTagged

+ type Build struct

+ AdapterRef string

+ Args []KV

+ ComposeFile string

+ Context string

+ Dockerfile string

+ EgressAllow []string

+ EgressMode EgressMode

+ GeneratedFiles map[string]string

+ IsolationFloor IsolationClass

+ StaticDir string

+ Strategy BuildStrategy

+ Target string

+ TimeoutSeconds int

+ type BuildStrategy string

+ const BuildBuildpack

+ const BuildCompose

+ const BuildDockerfile

+ const BuildPrebuilt

+ const BuildStatic

+ type Change struct

+ Class Class

+ From any

+ Path string

+ Summary string

+ To any

+ type Class string

+ const Benign

+ const Destructive

+ const Rebuild

+ const Restart

+ type Defaults struct

+ BaseDomain string

+ BuildIsolation IsolationClass

+ BuildTimeoutSeconds int

+ BuilderAdapter string

+ Resources Resources

+ Retention Retention

+ RoutingAdapter string

+ RoutingMode RoutingMode

+ RuntimeAdapter string

+ RuntimeIsolation IsolationClass

+ func StandardDefaults() Defaults

+ func (d Defaults) Apply(s *AppSpec, slug string)

+ type Deploy struct

+ AutoDeploy AutoDeploy

+ AutoRollback bool

+ RequireApproval bool

+ Strategy DeployStrategy

+ type DeployStrategy string

+ const DeployRecreate

+ const DeployStartThenSwap

+ type Diff struct

+ Changes []Change

+ func Compare(old, next *AppSpec) Diff

+ func (d Diff) Class() Class

+ func (d Diff) Empty() bool

+ func (d Diff) RequiresConfirmation() bool

+ type Egress struct

+ Add []string

+ Allowlist []string

+ BlockPrivate *bool

+ List []string

+ Mode EgressMode

+ Remove []string

+ func (e *Egress) Normalize()

+ func (e Egress) Same(o Egress) bool

+ type EgressMode string

+ const EgressAllowAll

+ const EgressAllowlist

+ const EgressBlockPrivate

+ const EgressDenylist

+ const EgressInherit

+ type EnvEntry struct

+ Key string

+ SecretRef *string

+ SlotRef *string

+ Source EnvSource

+ Value *string

+ type EnvSource string

+ const EnvFromCompose

+ const EnvFromDetection

+ const EnvFromScreening

+ const EnvFromUser

+ type File struct

+ Content string

+ Mode int

+ Path string

+ type Health struct

+ IntervalSeconds int

+ Path string

+ Port int

+ Retries int

+ Source HealthSource

+ TimeoutSeconds int

+ type HealthSource string

+ const HealthFromCompose

+ const HealthFromHTTP

+ const HealthFromProcess

+ const HealthFromTCP

+ type Healthcheck struct

+ Command []string

+ IntervalSeconds int

+ Path string

+ Port int

+ Retries int

+ TimeoutSeconds int

+ type IsolationClass int

+ const IsolationContainer

+ const IsolationDedicatedHost

+ const IsolationSandboxed

+ const IsolationVM

+ type KV struct

+ Key string

+ Value string

+ type ModeSource string

+ const ModeFromAdapterDefault

+ const ModeFromUserOverride

+ type Mount struct

+ Path string

+ ReadOnly bool

+ VolumeID string

+ type Origin string

+ const OriginAutoDeploy

+ const OriginDetected

+ const OriginEdited

+ const OriginImported

+ const OriginManual

+ const OriginRedetect

+ type Port struct

+ Number int

+ Protocol string

+ Source PortSource

+ type PortSource string

+ const PortCompose

+ const PortExpose

+ const PortFramework

+ const PortObserved

+ const PortScreened

+ const PortUser

+ type Resolution struct

+ Mode ResolutionMode

+ SecretRef string

+ ServiceRef string

+ Target string

+ type ResolutionMode string

+ const ResolutionBound

+ const ResolutionLiteral

+ const ResolutionProvisioned

+ type ResourceLimits struct

+ CPUMillis int

+ MemoryBytes int64

+ type Resources struct

+ CPUMillis int

+ DiskBytes int64

+ MemoryBytes int64

+ Overridden bool

+ type Retention struct

+ BackupDailyCount int

+ LogBytes int64

+ SpecRevisions int

+ type Routing struct

+ AdapterRef string

+ Hostname string

+ Mode RoutingMode

+ ModeSource ModeSource

+ PathPrefix string

+ Port int

+ type RoutingMode string

+ const RoutingPath

+ const RoutingPort

+ const RoutingSubdomain

+ type RuntimeRef struct

+ AdapterRef string

+ IsolationFloor IsolationClass

+ type Slot struct

+ Evidence []string

+ Key string

+ Required bool

+ Resolution *Resolution

+ Type SlotType

+ type SlotType string

+ const SlotMySQL

+ const SlotPostgres

+ const SlotRedis

+ const SlotS3

+ const SlotSMTP

+ const SlotUnknown

+ func (t SlotType) DisplayName() string

+ type Source struct

+ Commit string

+ CredentialRef string

+ Digest string

+ Image string

+ Ref string

+ Subdir string

+ Type SourceType

+ URL string

+ UploadID string

+ type SourceType string

+ const SourceGit

+ const SourceImage

+ const SourceUpload

+ type Volume struct

+ Declared VolumeSource

+ ID string

+ Name string

+ SizeHintBytes int64

+ type VolumeSource string

+ const VolumeFromCompose

+ const VolumeFromImage

+ const VolumeFromScreening

+ const VolumeFromUser

+ const VolumeFromWarning

+ type Warning struct

+ Code string

+ Dismissed bool

+ DismissedBy string

+ Message string

+ type Workload struct

+ Build *WorkloadBuild

+ Command []string

+ DependsOn []string

+ Entrypoint []string

+ Env []EnvEntry

+ Exposed bool

+ Files []File

+ Health *Healthcheck

+ Image string

+ Mounts []Mount

+ Name string

+ Ports []Port

+ Primary bool

+ Resources *ResourceLimits

+ WorkingDir string

+ type WorkloadBuild struct

+ Args []KV

+ Context string

+ Dockerfile string

+ Target string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL