Commitd79a7ad

authored

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

1 parentf50e1d5 commitd79a7adCopy full SHA for d79a7ad

File tree

+15

-11

lines changed

+15

-11

lines changed

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@ OPTIONS:`
`22`	`22`	`--cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])`
`23`	`23`	`The directory to cache temporary files. If unspecified and`
`24`	`24`	`$CACHE_DIRECTORY is set, it will be used for compatibility with`
`25`		`- systemd.`
	`25`	`+ systemd. This directory is NOT safe to be configured as a shared`
	`26`	`+ directory across coderd/provisionerd replicas.`
`26`	`27`
`27`	`28`	`--disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS`
`28`	`29`	`Remove the permission for the 'owner' role to have workspace execution`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -414,7 +414,8 @@ updateCheck: false`
`414`	`414`	`# (default: <unset>, type: bool)`
`415`	`415`	`enableSwagger: false`
`416`	`416`	`# The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is`
`417`		`-# set, it will be used for compatibility with systemd.`
	`417`	`+# set, it will be used for compatibility with systemd. This directory is NOT safe`
	`418`	`+# to be configured as a shared directory across coderd/provisionerd replicas.`
`418`	`419`	`# (default: [cache dir], type: string)`
`419`	`420`	`cacheDir: [cache dir]`
`420`	`421`	`# Controls whether data will be stored in an in-memory database.`

Lines changed: 8 additions & 7 deletions

Original file line number	Diff line number	Diff line change
@@ -1977,13 +1977,14 @@ when required by your organization's security policy.`,
`1977`	`1977`	`Annotations: serpent.Annotations{}.Mark(annotationExternalProxies,"true"),`
`1978`	`1978`	`},`
`1979`	`1979`	`{`
`1980`		`-Name:"Cache Directory",`
`1981`		`-Description:"The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd.",`
`1982`		`-Flag:"cache-dir",`
`1983`		`-Env:"CODER_CACHE_DIRECTORY",`
`1984`		`-Default:DefaultCacheDir(),`
`1985`		`-Value:&c.CacheDir,`
`1986`		`-YAML:"cacheDir",`
	`1980`	`+Name:"Cache Directory",`
	`1981`	`+Description:"The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd. "+`
	`1982`	`+"This directory is NOT safe to be configured as a shared directory across coderd/provisionerd replicas.",`
	`1983`	`+Flag:"cache-dir",`
	`1984`	`+Env:"CODER_CACHE_DIRECTORY",`
	`1985`	`+Default:DefaultCacheDir(),`
	`1986`	`+Value:&c.CacheDir,`
	`1987`	`+YAML:"cacheDir",`
`1987`	`1988`	`},`
`1988`	`1989`	`{`
`1989`	`1990`	`Name:"In Memory Database",`

Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,8 @@ OPTIONS:`
`23`	`23`	`--cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])`
`24`	`24`	`The directory to cache temporary files. If unspecified and`
`25`	`25`	`$CACHE_DIRECTORY is set, it will be used for compatibility with`
`26`		`- systemd.`
	`26`	`+ systemd. This directory is NOT safe to be configured as a shared`
	`27`	`+ directory across coderd/provisionerd replicas.`
`27`	`28`
`28`	`29`	`--disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS`
`29`	`30`	`Remove the permission for the 'owner' role to have workspace execution`

Comments

(0)