opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-10-28 02:42:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: advise against shared CODER_CACHE_DIRECTORY dir usage in note (#14216)

Browse Source
This commit is contained in:
Danny Kopping
2024-08-08 12:42:47 +00:00
committed by GitHub
parent f50e1d5a9a
commit d79a7adf99
5 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli/testdata/coder_server_--help.golden
Vendored
+2 -1
View File
@@ -22,7 +22,8 @@ OPTIONS:
--cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir]) --cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])
The directory to cache temporary files. If unspecified and The directory to cache temporary files. If unspecified and
$CACHE_DIRECTORY is set, it will be used for compatibility with $CACHE_DIRECTORY is set, it will be used for compatibility with
systemd. systemd. This directory is NOT safe to be configured as a shared
directory across coderd/provisionerd replicas.
--disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS --disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS
Remove the permission for the 'owner' role to have workspace execution Remove the permission for the 'owner' role to have workspace execution
cli/testdata/server-config.yaml.golden
Vendored
+2 -1
View File
@@ -414,7 +414,8 @@ updateCheck: false
# (default: <unset>, type: bool) # (default: <unset>, type: bool)
enableSwagger: false enableSwagger: false
# The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is # The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is
# set, it will be used for compatibility with systemd. # set, it will be used for compatibility with systemd. This directory is NOT safe
# to be configured as a shared directory across coderd/provisionerd replicas.
# (default: [cache dir], type: string) # (default: [cache dir], type: string)
cacheDir: [cache dir] cacheDir: [cache dir]
# Controls whether data will be stored in an in-memory database. # Controls whether data will be stored in an in-memory database.
codersdk/deployment.go
+8 -7
View File
@@ -1977,13 +1977,14 @@ when required by your organization's security policy.`,
Annotations: serpent.Annotations{}.Mark(annotationExternalProxies, "true"), Annotations: serpent.Annotations{}.Mark(annotationExternalProxies, "true"),
}, },
{ {
Name: "Cache Directory", Name: "Cache Directory",
Description: "The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd.", Description: "The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd. " +
Flag: "cache-dir", "This directory is NOT safe to be configured as a shared directory across coderd/provisionerd replicas.",
Env: "CODER_CACHE_DIRECTORY", Flag: "cache-dir",
Default: DefaultCacheDir(), Env: "CODER_CACHE_DIRECTORY",
Value: &c.CacheDir, Default: DefaultCacheDir(),
YAML: "cacheDir", Value: &c.CacheDir,
YAML: "cacheDir",
}, },
{ {
Name: "In Memory Database", Name: "In Memory Database",
docs/cli/server.md
Generated
+1 -1
View File
@@ -917,7 +917,7 @@ Origin addresses to respect "proxy-trusted-headers". e.g. 192.168.1.0/24.
| YAML | <code>cacheDir</code> | | YAML | <code>cacheDir</code> |
| Default | <code>~/.cache/coder</code> | | Default | <code>~/.cache/coder</code> |
The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd. The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd. This directory is NOT safe to be configured as a shared directory across coderd/provisionerd replicas.
### --postgres-url ### --postgres-url
enterprise/cli/testdata/coder_server_--help.golden
Vendored
+2 -1
View File
@@ -23,7 +23,8 @@ OPTIONS:
--cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir]) --cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])
The directory to cache temporary files. If unspecified and The directory to cache temporary files. If unspecified and
$CACHE_DIRECTORY is set, it will be used for compatibility with $CACHE_DIRECTORY is set, it will be used for compatibility with
systemd. systemd. This directory is NOT safe to be configured as a shared
directory across coderd/provisionerd replicas.
--disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS --disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS
Remove the permission for the 'owner' role to have workspace execution Remove the permission for the 'owner' role to have workspace execution