Expand description
Product-neutral infrastructure read and verified mutation engines.
soma-infra defines typed host, Docker, Compose, filesystem, process, log,
and ZFS contracts above soma-fleet, plus bounded mutation coordinators that
preserve send state and verify postconditions. Product configuration,
authorization, and CLI/MCP/REST presentation remain outside.
Structs§
- Bollard
Client Provider - Revision-aware Bollard provider for local and strict-SSH hosts.
- Bollard
Read Client - Local Bollard implementation of the neutral Docker read contracts.
- Build
Context Fingerprint - Deterministic content fingerprint for one admitted build context.
- Build
Context Policy - Explicit roots and traversal ceilings for Docker build contexts.
- Command
Build Context Inspector - Descriptor-confined build-context inspector backed by fleet command execution.
- Command
Compose Build Mutator - Process-backed Compose build driver.
- Command
Compose Inspector - Compose inspector backed by a
soma-fleetcommand executor. - Command
File Transfer - Descriptor-confined local or strict-SSH file transfer driver.
- Command
Filesystem Query Inspector - Descriptor-walking filesystem query driver backed by fleet command execution.
- Command
Host Exec - Process-backed host command driver with explicit per-host read roots.
- Command
Host System Inspector - Host-system inspector backed by a fleet command executor.
- Command
Image Build Mutator - Process-backed Docker build driver.
- Command
LogReader - Operating-system log reader backed by a fleet command executor.
- Command
Process Inspector - Process inspector backed by a fleet command executor.
- Command
ZfsInspector - ZFS inspector backed by a fleet command executor.
- Compose
Build Artifact - One planned Compose service build artifact.
- Compose
Build Engine - Coordinates context drift checks, Compose build, and image verification.
- Compose
Build Outcome - Verified Compose build outcome.
- Compose
Build Receipt - Compose build process receipt.
- Compose
Build Request - Deadline-bound Compose build request.
- Compose
Build Services - Borrowed services required for one Compose build execution.
- Compose
Built Image - One verified Compose service build result.
- Compose
Config - Typed read-only Compose configuration summary.
- Compose
Down Engine - Verified Docker Compose teardown coordinator.
- Compose
Down Outcome - Verified Compose teardown outcome.
- Compose
Down Receipt - Process driver receipt for Compose down.
- Compose
Down Request - Deadline-bound Compose teardown request.
- Compose
LogRequest - Bounded Compose log request.
- Compose
Logs - Bounded Compose log result.
- Compose
Mutation Engine - Coordinates a Compose mutation and independent service-state verification.
- Compose
Mutation Outcome - Verified Compose mutation outcome.
- Compose
Mutation Receipt - Receipt returned after a Compose mutation command was sent.
- Compose
Mutation Request - Deadline-bound Compose mutation request.
- Compose
Project - Project row returned by
docker compose ls. - Compose
Project Ref - Validated reference to one Compose project configuration.
- Compose
Pull Engine - Coordinates Compose image pulls and verifies every configured local image identity.
- Compose
Pull Outcome - Verified Compose pull outcome.
- Compose
Pull Receipt - Receipt returned when the Compose pull command completes.
- Compose
Pull Request - Deadline-bound Compose image pull request.
- Compose
Pulled Image - One Compose service image verification row.
- Compose
Recreate Engine - Coordinates Compose drift checks, force-recreate, and post-state verification.
- Compose
Recreate Fingerprint - Stable fingerprint of the Compose configuration and service pre-state.
- Compose
Recreate Outcome - Verified Compose replacement outcome.
- Compose
Recreate Receipt - Process driver receipt for Compose force-recreate.
- Compose
Recreate Request - Deadline-bound Compose replacement request.
- Compose
Service Config - Selected read-only service configuration.
- Compose
Service Status - Service row returned by
docker compose ps. - Compose
Status - Typed status for one Compose project.
- Container
Exec Receipt - Completed non-interactive Docker exec.
- Container
Exec Request - One non-interactive bounded Docker exec request.
- Container
Inspect - Selected neutral container inspection fields.
- Container
Lifecycle Engine - Coordinates mutation and independent container-state verification.
- Container
Lifecycle Outcome - Verified lifecycle mutation outcome.
- Container
Lifecycle Request - Deadline-bound container lifecycle request.
- Container
List Options - Closed container-list options.
- Container
LogOptions - Bounded one-shot Docker log options.
- Container
Logs - Bounded one-shot Docker log result.
- Container
Mutation Receipt - Receipt returned once a lifecycle mutation was accepted by the driver.
- Container
Process Table - Process table returned by Docker top.
- Container
Recreate Engine - Coordinates configuration drift checks, replacement, and post-state verification.
- Container
Recreate Fingerprint - Stable digest and selected identity captured before a container replacement.
- Container
Recreate Outcome - Verified container replacement outcome.
- Container
Recreate Receipt - Driver receipt for one replacement attempt.
- Container
Recreate Request - Deadline-bound request to replace one container from its captured configuration.
- Container
Stats Snapshot - Neutral one-shot Docker container statistics.
- Container
Summary - Neutral Docker container summary.
- Docker
Cleanup Engine - Verified Docker image-removal and prune coordinator.
- Docker
Disk Usage - Neutral Docker disk-usage snapshot.
- Docker
Prune Fingerprint - Deterministic pre-prune inventory.
- Docker
Prune Outcome - Verified prune result.
- Docker
Prune Receipt - Complete prune receipt.
- Docker
Prune Request - Request to prune one exact inventory.
- Docker
Prune Scope Receipt - Backend receipt for one prune scope.
- Docker
System Info - Neutral Docker daemon information.
- Docker
Usage Category - Aggregate disk usage for one Docker resource category.
- Doctor
Check - One doctor check.
- Doctor
Report - Typed doctor report.
- File
Find Request - Bounded recursive file search request.
- File
Hash - SHA-256 file digest.
- File
Metadata - Typed filesystem metadata.
- File
Preview - Bounded file preview.
- File
Read Policy - Closed read policy for one filesystem inspector.
- File
Search - Bounded file-search result.
- File
Tail - Bounded file tail.
- File
Tail Request - Request for a bounded file tail.
- File
Transfer Engine - Verified bounded file-transfer coordinator.
- File
Transfer Fingerprint - Complete authorization-relevant transfer fingerprint.
- File
Transfer Policy - Explicit source and destination roots for one host.
- Filesystem
Usage - Byte-precise filesystem usage.
- Host
Exec Many Engine - Bounded stable-order host execution fanout coordinator.
- Host
Exec Many Outcome - Complete stable-order host execution fanout outcome.
- Host
Exec Policy - Explicit read roots used by the typed host command launcher.
- Host
Exec Receipt - Completed bounded host execution.
- Host
Exec Request - One bounded allowlisted host execution request.
- Host
Exec Target Result - Stable-order outcome for one fanout target.
- Host
Identity - Stable host identity fields collected from the operating system.
- Host
Inspect Request - Deadline-bound request for one host inspection.
- Host
Inspection - Complete read-only host inspection result.
- Host
Load Average - Parsed Linux load averages.
- Host
Memory - Parsed host memory counters.
- Image
Build Engine - Coordinates context verification, image build, and image-store verification.
- Image
Build Outcome - Verified image build outcome.
- Image
Build Receipt - Receipt returned after a build command reaches a terminal process state.
- Image
Build Request - Deadline-bound request for one Docker image build.
- Image
Build Services - Borrowed services required for one image build execution.
- Image
Identity - Stable image identity observed through the Docker read API.
- Image
List Options - Closed image-list options.
- Image
Pull Engine - Coordinates one image pull and independent image-store verification.
- Image
Pull Outcome - Verified image pull outcome.
- Image
Pull Progress Frame - One retained neutral image-pull progress frame.
- Image
Pull Receipt - Receipt returned after the image pull stream completes.
- Image
Pull Request - Deadline-bound request to pull one Docker/OCI image reference.
- Image
Removal Fingerprint - Stable identity bound into an image-removal plan.
- Image
Removal Outcome - Verified image-removal result.
- Image
Removal Receipt - Backend receipt for image removal.
- Image
Removal Request - Request to remove one exact local image identity.
- Image
Summary - Neutral Docker image summary.
- Journal
Filters - Validated journal filters.
- Linux
Command Host Inspector - Host inspector backed by a
soma-fleetcommand executor. - Linux
Filesystem Inspector - Linux descriptor-confined filesystem reader.
- LogPermission
Diagnostic - Structured permission diagnostic for a log source.
- LogRead
- Bounded log read result.
- LogRead
Request - Bounded read request for one log source.
- Mount
Info - One mounted filesystem.
- Mutation
Failure - Infrastructure mutation failure with explicit backend send state.
- Mutation
Verification - Stable verification detail for a mutation outcome.
- Mutation
Verification Policy - Bounded post-mutation verification policy.
- Network
Address - One interface address.
- Network
Interface - One network interface.
- Network
Summary - Neutral Docker network summary.
- Path
Read - Bounded file or directory read.
- Path
Read Request - Request for a bounded file or directory read.
- Port
Info - One listening socket.
- Port
List Request - Request for bounded listening-port inspection.
- Process
List Request - Closed request for one process snapshot.
- Process
Row - Typed row from a process snapshot.
- Process
Snapshot - Bounded process snapshot for one host revision.
- Service
List Request - Request for a bounded service listing.
- Service
Status - One system service row.
- Transfer
File Identity - Stable file content identity.
- Verified
File Transfer Outcome - Verified file-transfer result.
- Verified
File Transfer Request - Deadline-bound transfer request.
- Volume
Summary - Neutral Docker volume summary.
- ZfsDataset
Request - Request for a ZFS dataset listing.
- ZfsPool
Request - Request for a ZFS pool listing.
- ZfsSnapshot
Request - Request for a bounded ZFS snapshot listing.
- ZfsTable
- Structured ZFS tabular output.
Enums§
- Compose
Mutation Action - Supported Compose mutations in the first reversible slice.
- Container
Lifecycle Action - Supported reversible container lifecycle mutations.
- Container
Recreate Stage - Furthest destructive stage reached by a container recreation.
- Container
State - Neutral container runtime state.
- Docker
LogStream - Selected Docker log stream.
- Docker
Prune Target - Closed Docker prune scope.
- File
Kind - Read-only filesystem object kind.
- File
Transfer Path Role - Policy role used while inspecting a transfer path.
- Host
Exec Command - Closed allowlist of host commands admitted by canonical Synapse execution.
- Host
Exec Target Status - Terminal classification for one host-exec fanout target.
- Infra
Error - Product-neutral infrastructure operation failure.
- Journal
Priority - Journal priority accepted by journalctl.
- LogSource
- Supported read-only operating-system log sources.
- Port
Protocol - Supported listening-port protocols.
- Process
Sort - Supported deterministic process sort orders.
- ZfsDataset
Type - Allowlisted ZFS dataset types.
Constants§
- MAX_
FILE_ TRANSFER_ BYTES - Maximum bytes copied by one canonical file-transfer mutation.
Traits§
- Build
Context Inspector - Reads one build context through descriptor-confined traversal.
- Compose
Build Mutator - Driver for one Compose build command.
- Compose
Down Client - Complete Compose client required by teardown verification.
- Compose
Down Mutator - Executes Docker Compose teardown.
- Compose
Inspector - Product-neutral Compose inspection engine.
- Compose
Mutation Client - Complete client required by the Compose mutation coordinator.
- Compose
Mutator - Driver for Compose mutation commands.
- Compose
Pull Client - Complete Compose client required by the pull coordinator.
- Compose
Pull Mutator - Driver for one Compose image pull command.
- Compose
Recreate Client - Complete Compose client required by the replacement engine.
- Compose
Recreate Mutator - Executes Docker Compose force-recreate.
- Container
Exec Client Provider - Supplies one host-bound Docker exec client.
- Container
Exec Mutator - Product-neutral non-interactive Docker exec driver.
- Container
Lifecycle Mutator - Driver for one reversible container lifecycle mutation.
- Container
Reader - Docker container read operations.
- Container
Recreate Client - Complete client required by the verified recreate engine.
- Container
Recreate Client Provider - Supplies one host-bound container replacement client.
- Container
Recreate Inspector - Reads a driver-native replacement fingerprint without leaking SDK models.
- Container
Recreate Mutator - Performs one container replacement while preserving partial-stage evidence.
- Docker
Artifact Client - Complete Docker client required by artifact mutations.
- Docker
Artifact Client Provider - Factory for host- and revision-bound artifact mutation clients.
- Docker
Cleanup Client - Complete Docker cleanup client used by verification engines.
- Docker
Cleanup Client Provider - Host-bound cleanup client provider.
- Docker
Cleanup Mutator - Product-neutral Docker cleanup mutations.
- Docker
Client Provider - Factory for host- and revision-bound Docker read clients.
- Docker
Mutation Client - Complete Docker client required by the lifecycle coordinator.
- Docker
Mutation Client Provider - Factory for host- and revision-bound Docker mutation clients.
- Docker
Read Client - Complete neutral Docker read surface.
- Docker
System Reader - Docker system-level read operations.
- Docker
Telemetry Reader - Docker telemetry read operations.
- File
Transfer Inspector - Reads file identities for transfer planning and verification.
- Filesystem
Inspector - Product-neutral filesystem inspection engine.
- Filesystem
Query Inspector - Descriptor-confined filesystem queries usable locally or over SSH.
- Host
Exec Mutator - Product-neutral bounded host command driver.
- Host
Inspector - Product-neutral host inspection engine.
- Host
System Inspector - Remaining product-neutral host-system reads.
- Image
Build Mutator - Driver for one Docker image build command.
- Image
Pull Mutator - Driver for one image-pull stream.
- Image
Reader - Docker image read operations.
- LogReader
- Product-neutral operating-system log reader.
- Mutation
Progress Reporter - Object-safe adapter for canonical operation progress delivery.
- Network
Reader - Docker network read operations.
- Process
Inspector - Product-neutral process inspection engine.
- Verified
File Transfer Client - Complete transfer client used by the verified engine.
- Volume
Reader - Docker volume read operations.
- ZfsInspector
- Product-neutral ZFS read engine.
Functions§
- canonical_
image_ reference - Returns the canonical tag used by Docker when no tag or digest is supplied.
- compose_
recreate_ fingerprint - Produces deterministic replacement material from canonical Compose reads.
- resolve_
compose_ build_ context - Resolves an absolute or Compose-file-relative build context without permitting root escape.
Type Aliases§
- Infra
Result - Result type for neutral infrastructure operations.
- Mutation
Result - Result type for infrastructure mutations.