Skip to content

Commit 69ebd7e

Browse files
Update sandbox documentation to reflect SRT removal (#15865)
1 parent 06f4f0a commit 69ebd7e

1 file changed

Lines changed: 22 additions & 62 deletions

File tree

docs/src/content/docs/reference/sandbox.md

Lines changed: 22 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ disable-agentic-editing: true
88

99
The `sandbox` field configures sandbox environments for AI engines, providing two main capabilities:
1010

11-
1. **Agent Sandbox** - Controls the agent runtime security (AWF or Sandbox Runtime)
11+
1. **Agent Sandbox** - Controls the agent runtime security using AWF (Agent Workflow Firewall)
1212
2. **Model Context Protocol (MCP) Gateway** - Routes MCP server calls through a unified HTTP gateway
1313

1414
## Configuration
@@ -22,10 +22,6 @@ Configure the agent sandbox type to control how the AI engine is isolated:
2222
sandbox:
2323
agent: awf
2424

25-
# Use Sandbox Runtime (SRT) - experimental
26-
sandbox:
27-
agent: srt
28-
2925
# Disable agent sandbox (firewall only) - use with caution
3026
sandbox:
3127
agent: false
@@ -191,79 +187,37 @@ Custom mounts are useful for:
191187

192188
| Field | Type | Description |
193189
|-------|------|-------------|
194-
| `id` | `string` | Agent identifier: `awf` or `srt` |
190+
| `id` | `string` | Agent identifier: `awf` |
195191
| `command` | `string` | Custom command to replace AWF binary installation |
196192
| `args` | `string[]` | Additional arguments appended to the command |
197193
| `env` | `object` | Environment variables set on the execution step |
198194
| `mounts` | `string[]` | Container mounts using syntax `source:destination:mode` |
199195

200196
When `command` is specified, the standard AWF installation is skipped and your custom command is used instead.
201197

202-
### Sandbox Runtime (SRT)
198+
## Deprecated: Sandbox Runtime (SRT)
203199

204200
> [!CAUTION]
205-
> Experimental
206-
> Sandbox Runtime is experimental and requires the `sandbox-runtime` feature flag.
201+
> Removed
202+
> Sandbox Runtime (SRT) support has been removed. AWF is now the only supported sandbox implementation.
207203

208-
Sandbox Runtime provides enhanced isolation using Anthropic's sandbox technology. It supports custom filesystem configuration while network permissions are controlled by the top-level `network` field.
204+
### Migration
209205

210-
```yaml wrap
211-
features:
212-
sandbox-runtime: true
206+
Legacy workflows using `sandbox.agent: srt` or `sandbox: sandbox-runtime` are automatically migrated to AWF during workflow parsing. No manual changes are required.
213207

208+
**Before (automatically migrated):**
209+
```yaml wrap
214210
sandbox:
215-
agent:
216-
type: srt
217-
config:
218-
filesystem:
219-
allowWrite: [".", "/tmp", "/home/runner/.copilot"]
220-
denyRead: ["/etc/passwd"]
221-
enableWeakerNestedSandbox: true
222-
223-
network:
224-
allowed:
225-
- defaults
226-
- python
211+
agent: srt
227212
```
228213

229-
#### SRT Configuration Options
230-
231-
| Field | Type | Description |
232-
|-------|------|-------------|
233-
| `filesystem.allowWrite` | `string[]` | Paths allowed for write access |
234-
| `filesystem.denyRead` | `string[]` | Paths denied for read access |
235-
| `filesystem.denyWrite` | `string[]` | Paths denied for write access |
236-
| `ignoreViolations` | `object` | Map of command patterns to paths that should ignore violations |
237-
| `enableWeakerNestedSandbox` | `boolean` | Enable weaker nested sandbox mode (use only when required) |
238-
239-
> [!NOTE]
240-
> Network Configuration
241-
> Network configuration for SRT is controlled by the top-level `network` field, not the sandbox config. This ensures consistent network policy across all sandbox types.
242-
243-
#### Custom SRT Configuration
244-
245-
Similar to AWF, SRT supports custom commands, arguments, and environment variables:
246-
214+
**After (transparent conversion):**
247215
```yaml wrap
248-
features:
249-
sandbox-runtime: true
250-
251216
sandbox:
252-
agent:
253-
id: srt
254-
command: "custom-srt-wrapper"
255-
args:
256-
- "--custom-arg"
257-
- "--debug"
258-
env:
259-
SRT_DEBUG: "true"
260-
SRT_CUSTOM_VAR: "test_value"
261-
config:
262-
filesystem:
263-
allowWrite: [".", "/tmp"]
217+
agent: awf
264218
```
265219

266-
When `command` is specified, the standard SRT installation is skipped. The `config` field can still be used for filesystem configuration.
220+
If your workflow previously used SRT, it will now use AWF with the same network permissions configured in the `network` field. AWF provides network egress control while maintaining compatibility with existing workflow configurations.
267221

268222
## MCP Gateway
269223

@@ -335,7 +289,7 @@ sandbox:
335289
For backward compatibility, legacy formats are still supported:
336290

337291
```yaml wrap
338-
# Legacy string format (deprecated)
292+
# Legacy string format - automatically migrated to AWF
339293
sandbox: sandbox-runtime
340294
341295
# Legacy object format with 'type' field (deprecated)
@@ -351,23 +305,29 @@ sandbox:
351305

352306
The `id` field replaces the legacy `type` field in the object format. When both are present, `id` takes precedence.
353307

308+
> [!NOTE]
309+
> SRT Migration
310+
> The legacy string format `sandbox: sandbox-runtime` is automatically converted to `sandbox.agent: awf` during workflow parsing.
311+
354312
## Feature Flags
355313

356314
Some sandbox features require feature flags:
357315

358316
| Feature | Flag | Description |
359317
|---------|------|-------------|
360-
| Sandbox Runtime | `sandbox-runtime` | Enable SRT agent sandbox |
361318
| MCP Gateway | `mcp-gateway` | Enable MCP gateway routing |
362319

363320
Enable feature flags in your workflow:
364321

365322
```yaml wrap
366323
features:
367-
sandbox-runtime: true
368324
mcp-gateway: true
369325
```
370326

327+
> [!NOTE]
328+
> Removed Feature Flags
329+
> The `sandbox-runtime` feature flag has been removed. It is no longer recognized and will be ignored if present in workflow configurations.
330+
371331
## Related Documentation
372332

373333
- [Network Permissions](/gh-aw/reference/network/) - Configure network access controls

0 commit comments

Comments
 (0)