docs: advise against shared CODER_CACHE_DIRECTORY dir usage in note
#14216
Conversation
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
Signed-off-by: Danny Kopping <danny@coder.com>
CODER_CACHE_DIRECTORY dir usageCODER_CACHE_DIRECTORY dir usage in note
johnstcn
approved these changes
Aug 8, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This directory is used for several purposes such as caching coder binaries, downloaded terraform providers, and other use-cases.
We don't take the necessary preventative steps to prevent multiple processes from clobbering each others' files, should they share this directory.
This option might seem compelling to unsuspecting operators who want to, for example, ensure terraform providers are always cached when using multiple
provisionerdreplicas, by sharing the cache between them. This would lead to potentially problematic behaviour right now, and we should heavily discourage this approach.