Expand description
Format-independent application model for BoxFerry.
The model describes container application intent without exposing Compose, Quadlet, Podman, Docker, or Kubernetes types. Ordered collections and source provenance remain available to conversion adapters.
Structs§
- Annotation
- One protected annotation with independently sourced name and value.
- Application
- One ordered multi-service application graph.
- Artifact
Dependency - One explicit, directed image-artifact dependency.
- Build
Context - One named additional context in a structured source build declaration.
- Build
Setting Values - One typed collection belonging to one explicitly present image-artifact key.
- Config
- One application-level configuration declaration.
- Deferred
Expression - Bounded flat concatenation with per-segment provenance.
- Environment
File - One ordered environment-file declaration.
- Environment
Variable - One ordered service environment entry.
- Exposed
Port - A container port exposed for inter-service use without publishing it to a host.
- Healthcheck
- Format-independent service health-check intent with field-level provenance.
- Healthcheck
Duration - Raw-preserving duration shared by container health-check implementations.
- Healthcheck
Retries - Raw-preserving non-negative health-check retry count.
- Host
Address - One raw-preserving address or runtime token used by a service host mapping.
- Host
Mapping - One ordered service hostname-to-address mapping.
- Identifier
- Opaque, non-empty application or resource identifier.
- Image
Acquisition - An image-acquisition resource.
- Image
Artifact Assignment - One source-preserving assignment used by image artifact settings.
- Image
Build - An image-build resource with independently retained source declaration and artifact settings.
- Image
Reference - A preserved image reference with optional tag and digest components.
- Kernel
Parameter - One raw-preserving kernel-parameter assignment.
- Logging
- Provider-specific logging intent.
- Logging
Option - One provider-specific logging option with independently sourced name and value.
- Metadata
Entry - One ordered string-keyed mapping entry, including key provenance and sensitivity.
- Metadata
Label - One portable metadata label attached to an application resource.
- Metadata
Node - One value with its own sensitivity and source folded-text presentation hint.
- Mount
- One service storage attachment.
- Network
- One application-level network declaration.
- Network
Attachment - One service attachment to an application network.
- Network
Driver Option - One driver-specific network option with independently sourced key and value.
- Network
Ipam Config - One explicitly associated IPAM configuration row.
- Port
- One container port published to a fixed or automatically allocated host port.
- Protected
String - Plain or sensitive text with redacting debug output.
- Provenance
- Location from which a neutral-model value was derived.
- Resource
Grant - One ordered service grant of a configuration or secret resource.
- Resource
Limit - One raw-preserving resource-limit declaration.
- Retained
Native Evidence - One provenance-bearing native evidence event.
- Secret
- One application-level secret declaration.
- Service
- One application service with ordered attachments and source provenance.
- Service
Dependency - One ordered dependency edge from a service to another application service.
- Service
Environment Assignment - Explicit protected assignment to the service execution environment.
- Service
Environment File - Mandatory absolute literal external file; construction never reads the file.
- Service
Environment Name - Portable environment reference name.
- Service
Execution Environment - Explicit per-service allowlist and external execution providers.
- Service
Group - One structural group of application services.
- Service
Group Runtime - Native runtime settings owned by one
ServiceGroup. - Source
Build Secret - A source build-secret declaration whose options remain distinct from target build-secret text.
- Source
Id - Caller-selected identity for one imported source.
- Source
Span - Half-open byte range in one imported source.
- Sourced
- A value and every source location that contributed to it.
- Stop
Timeout - Raw-preserving stop grace duration.
- Vendor
Metadata - One exact, case-sensitive vendor namespace at a supported neutral owner.
- Volume
- One application-level volume declaration.
Enums§
- Artifact
Dependency Node - A format-neutral node used by explicit image-artifact dependency validation.
- Build
Attestation - A source build attestation value.
- Build
Source Declaration - One source declaration for an image build.
- Build
Syntax - The generic syntax family that supplied a build declaration or per-key value collection.
- Command
- How a service command overrides the image command.
- Config
Material - Material source for an application-managed configuration resource.
- Deferred
Segment - A flat expression segment, retaining literal protection independently of references.
- Device
- A service device declaration with its authored syntax retained.
- Entrypoint
- How a service overrides the image entrypoint.
- Environment
File Format - Explicit parsing mode requested for an environment file.
- Environment
File Syntax - Authored syntax family retained for an environment-file declaration.
- Environment
Value - Source of an environment variable’s value.
- Group
Exit Policy - Pod exit behavior retained without assigning lifecycle semantics to group membership.
- Healthcheck
Command - How a container runtime executes one service health check.
- Host
Address Kind - Conservative kind of one service host-mapping address.
- Image
Acquisition Setting - One image-acquisition setting.
- Image
Build Setting - One image-build setting.
- Metadata
Error - Value-free validation error for inert metadata.
- Metadata
Scope - Owner of an inert vendor extension.
- Metadata
Value - Semantic value of vendor metadata. Map and sequence order is retained.
- Model
Error - Error raised when constructing an invalid neutral model value.
- Mount
Source - Storage backing attached to a service.
- Protocol
- Transport protocol attached to a published port.
- Provenance
Kind - How a neutral-model value entered a conversion plan.
- Pull
Policy - Source-independent image pull intent.
- Reload
Action - One mutually exclusive reload action.
- Resource
Grant Syntax - Authored syntax family retained for a config or secret grant.
- Resource
Ownership - Who owns a named application resource lifecycle.
- Restart
Policy - Container-level automatic restart intent.
- Retained
Native Evidence Event - One authored opaque native occurrence retained in source order.
- Retained
Native Evidence Subject - Resource-qualified opaque source fact retained for explanation, never execution.
- Secret
Material - Material source for an application-managed secret resource.
- Security
Option - One format-independent service security option.
- Selinux
Relabel SELinuxlabel sharing requested for a bind mount.- Service
Dependency Condition - Readiness state a service dependency must reach before its dependent starts.
- Source
Build Setting - One field from a structured source build declaration.
- Startup
Notification - Startup notification behavior requested for one service.
- Volume
Image Source - The explicit source of an image-backed volume.
Constants§
- DEFERRED_
MAX_ BYTES - Maximum decoded bytes in an expression or execution provider plan.
- DEFERRED_
MAX_ SEGMENTS - Maximum flat segments or provider entries.
- METADATA_
MAX_ BYTES - Maximum total metadata text and node accounting bytes per application.
- METADATA_
MAX_ DEPTH - Maximum supported recursive metadata depth.