-
Notifications
You must be signed in to change notification settings - Fork 81
chore: add notes on Coder storage usage #649
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
title: Storage | ||
description: Learn about storage in workspaces. | ||
--- | ||
|
||
Coder differentiates between system-installed files and user-installed files. | ||
System-installed files are stored in `/user/`, while user-installed files are | ||
located in the root directory `~`. | ||
khorne3 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Conventionally, Coder places anything installed with `apt` or `yum` or similar | ||
khorne3 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
with the system-installed files. This is considered ephemeral storage in Coder | ||
workspaces, and we recommend that you install these using `docker build` and | ||
have them in your image. | ||
|
||
Conversely, things installed via `npm`, Java dependencies, Ruby bundles, or | ||
similar, belong in the project folder (which is the `~`) so that it persists in | ||
khorne3 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Coder workspaces. | ||
|
||
## Storage allocation for workspaces | ||
|
||
Coder allows users to choose how much storage to allocate to their workspace. | ||
|
||
Ephemeral storage (where system-installed files are located) is available to | ||
you, but we don't recommend that you use this too often. Kubernetes enforces | ||
some limits on using this storage, and exceeding certain bounds could | ||
potentially lead to eviction in some clusters. | ||
|
||
Instead, we recommend installing everything a user needs in the image, including | ||
build steps, so that they can be shared across workspaces. For example, if you | ||
have multiple users start base images and install the same five things | ||
(e.g., Node.js, CLIs, etc.), these things get placed in ephemeral storage, and | ||
none of it is shared across workspaces. | ||
|
||
However, if you share some of the items and install them during `docker | ||
build`, the image cache layers have the apps in them, and they can be shared | ||
across workspaces. This also has the benefit of speeding up the workspace build | ||
process. | ||
|
||
The only things we recommend placing in your workspace storage are the contents | ||
of your Git repos and any generated artifacts. | ||
|
||
If you're using Node.js or Go, you'll see that these install many items in your | ||
persistent user directory to make capabilities like `npx` persist (though these | ||
are project-specific items). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.