4.80 docs updates#25430
Conversation
Signed-off-by: aevesdocker <allie.sadler@docker.com>
github-actions
Bot
added
the
area/desktop
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
| | :----------------------------------- | ---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | | ||
| | `filesharingAllowedDirectories` | | Specify which paths your developers can add file shares to. Also accepts `$HOME`, `$TMP`, or `$TEMP` as `path` variables. When a path is added, its subdirectories are allowed. If `sharedByDefault` is set to `true`, that path will be added upon factory reset or when Docker Desktop first starts. | | | ||
| | `useVirtualizationFrameworkVirtioFS` | macOS only | If `value` is set to `true`, VirtioFS is set as the file sharing mechanism. Note: If both `useVirtualizationFrameworkVirtioFS` and `useGrpcfuse` have `value` set to `true`, VirtioFS takes precedence. Likewise, if both `useVirtualizationFrameworkVirtioFS` and `useGrpcfuse` have `value` set to `false`, osxfs is set as the file sharing mechanism. | | | ||
| | `useVirtualizationFrameworkVirtioFS` | macOS only | If `value` is set to `true`, VirtioFS is set as the file sharing mechanism. Note: If both `useVirtualizationFrameworkVirtioFS` and `useGrpcfuse` have `value` set to `true`, VirtioFS takes precedence. | | |
There was a problem hiding this comment.
[MEDIUM] "Both false" fallback behavior left undocumented after osxfs removal
The removed sentence documented what Docker Desktop does when both useVirtualizationFrameworkVirtioFS and useGrpcfuse are set to false. With osxfs gone, that fallback no longer applies — but the new text says nothing about the both-false case.
Administrators locking these settings in admin-settings.json need to know what file sharing mechanism is used when both values are false. Consider documenting the new default behavior (e.g., "If both are set to false, Docker Desktop uses the default file sharing mechanism") or noting that at least one should be set to true.
There was a problem hiding this comment.
@aevesdocker Any reason why we aren't documenting what happens when both useVirtualizationFrameworkVirtioFS and useGrpcfuse are set to false?
There was a problem hiding this comment.
Great question — I raised this originally because the documentation now only covers the both-true case (VirtioFS wins) but leaves the both-false scenario undocumented.
From an admin's perspective, if I'm locking these settings in admin-settings.json, I need to know what file sharing mechanism Docker Desktop will use when both values are false. The old text mentioned osxfs as the fallback, but that's removed now.
@aevesdocker might have insight on whether there's a default mechanism that kicks in, or whether setting both to false is an invalid/unsupported configuration that should be noted.
There was a problem hiding this comment.
@usha-mandya Coz it's not a valid scenario and errors out. useVirtualizationFrameworkVirtioFS and useGrpcfuse set to true is also technically not valid but support wanted it in there incase it is done by mistake
There was a problem hiding this comment.
Ah, that's the key context — thank you! If both-false errors out, then the current documentation is actually complete. The both-true case is documented as a safety net ("VirtioFS takes precedence"), and the both-false case doesn't need documentation since it's an invalid configuration.
For admins configuring admin-settings.json, the implicit requirement is that at least one must be true, which is clear from the fact that there are only two mutually-exclusive file sharing options available on macOS.
Closing this as the documentation correctly covers the valid scenarios.
There was a problem hiding this comment.
OK. Can we add a note in that case for users who've already set the file sharing options to false about the error message?
There was a problem hiding this comment.
Good idea — that would help admins avoid misconfiguration. You could expand the existing note to cover both edge cases:
Note: If both
useVirtualizationFrameworkVirtioFSanduseGrpcfusehavevalueset totrue, VirtioFS takes precedence. If both are set tofalse, Docker Desktop will fail to start with an error, as at least one file sharing mechanism must be enabled.
This documents both the both-true scenario (already covered) and the both-false scenario (now clarified) in one place. It makes the requirement that "at least one must be true" explicit for anyone managing these settings.
This comment was marked as spam.
This comment was marked as spam.
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
4 participants
Description
as per https://github.com/docker/pinata/pull/41635
Related issues or tickets
Reviews