Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 3.18 KB

File metadata and controls

31 lines (25 loc) · 3.18 KB

MXC SDK samples

Audience: MXC consumers

These samples demonstrate the supported V1 SDK surfaces in Rust, .NET, and Node. They are organized by scenario so equivalent operations are easy to compare while each implementation remains idiomatic for its language.

Scenario Purpose Rust .NET Node
Run in a persisted container Provision, start, execute, stop, and deprovision run-in-persisted-container/rust run-in-persisted-container/dotnet run-in-persisted-container/node
Run in a transient container Build and execute a complete run-to-completion request run-in-transient-container/rust run-in-transient-container/dotnet run-in-transient-container/node
Run with filesystem containment Grant one host directory read-only run-with-containment-of-filesystem/rust run-with-containment-of-filesystem/dotnet run-with-containment-of-filesystem/node
Run with network containment Deny outbound, inbound, and host-loopback networking run-with-containment-of-network/rust run-with-containment-of-network/dotnet run-with-containment-of-network/node
Run with logging access denied Capture blocked ProcessContainer accesses run-with-logging-access-denied/rust run-with-logging-access-denied/dotnet run-with-logging-access-denied/node
Run with captured I/O Return complete stdout and stderr after exit run-with-io-captured/rust run-with-io-captured/dotnet run-with-io-captured/node
Run with interactive PTY I/O Forward an interactive terminal run-with-io-pty-interactive/rust run-with-io-pty-interactive/dotnet run-with-io-pty-interactive/node
Run with streaming standard I/O Stream live stdout and stderr run-with-io-stdio-streaming/rust run-with-io-stdio-streaming/dotnet run-with-io-stdio-streaming/node
Run with telemetry Request consent, then opt one transient run into telemetry run-with-telemetry/rust run-with-telemetry/dotnet run-with-telemetry/node
Check containment support Discover support without launching a container dryrun-check-containment-support/rust dryrun-check-containment-support/dotnet dryrun-check-containment-support/node

Conventions

  • Each sample demonstrates one primary concept through the public versioned V1 API.
  • Requests use typed SDK models rather than JSON or generated wire types.
  • Commands are harmless, bounded, and selected for the current operating system.
  • Workload failures, timeouts, SDK errors, warnings, and cleanup failures remain visible.
  • Projects reference the SDK in this repository so the samples track the current source.

Running a sample requires a supported and prepared host. See the applicable backend guide under docs/ for platform-specific prerequisites.