-
Notifications
You must be signed in to change notification settings - Fork 8.4k
docs(sandboxes): post-v0.32.0 doc updates #25329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
a755c70
11fea16
67514bc
dc1affd
146d59a
c22158a
8cfebc0
613f8fa
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -183,20 +183,24 @@ Extracting the tar archive as the current user avoids the `chown` call. | |
|
|
||
| Filesystem operations such as `git status`, `git log`, or directory scans can | ||
| be noticeably slow when the sandbox workspace is mounted in direct mode (the | ||
| default for workspaces without `--clone`). In direct mode, virtiofs caching is | ||
| disabled by default to prevent data corruption. Clone-mode sandboxes enable | ||
| virtiofs caching automatically, so this tuning applies only to direct mode. | ||
| default for workspaces without `--clone`). Virtiofs caching speeds up these | ||
| workloads. Clone-mode sandboxes always enable it, so this tuning applies only | ||
| to direct mode. | ||
|
|
||
| To speed up filesystem-intensive workloads, opt into virtiofs caching when | ||
| creating the sandbox: | ||
| On macOS and Linux, virtiofs caching is enabled by default. On Windows it's | ||
| still opt-in — enable it when creating the sandbox: | ||
|
|
||
| ```console | ||
| $ DOCKER_SANDBOXES_ENABLE_VIRTIOFS_CACHE=1 sbx run <template> | ||
| ``` | ||
|
|
||
| The setting is persisted in the sandbox spec and applies for the lifetime of | ||
| that sandbox. If you experience Git index corruption or unexpected file content | ||
| after enabling the cache, remove the sandbox and recreate it without the flag. | ||
| that sandbox. If you experience Git index corruption or unexpected file content, | ||
| disable caching with the kill switch and recreate the sandbox: | ||
|
|
||
| ```console | ||
| $ DOCKER_SANDBOXES_ENABLE_VIRTIOFS_CACHE=0 sbx run <template> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [MEDIUM] Kill-switch ( The section explains that macOS/Linux have caching on by default, while Windows is opt-in ( $ DOCKER_SANDBOXES_ENABLE_VIRTIOFS_CACHE=0 sbx run <template>A macOS/Linux user experiencing issues will understand this as "disable the default". But a Windows user who followed the |
||
| ``` | ||
|
|
||
| ## Clone mode reports "not in a Git repository" on WSL | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[MEDIUM] Parenthetical mid-sentence violates style guide's "avoid parentheses" rule
The new text uses a parenthetical to introduce the loopback-names exception:
Per the Docker style guide, parentheses reduce readability in technical documentation and should be avoided. Consider rewriting as a separate clause: