Skip to content

chore(docs): update advice for cache dir #7182

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
merged 2 commits into from
Apr 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions docs/install/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,10 @@ URL as a secret. Additionally, if accessing Coder over a hostname, set the `CODE
value.

By default, Coder creates the cache directory in `/home/coder/.cache`. Given the
OpenShift-provided UID, the Coder container does not have permission to write to
this directory. To fix this, set the `CODER_CACHE_DIRECTORY` environment variable
to `/tmp/coder-cache`.
OpenShift-provided UID and `readOnlyRootFS` security context constraint, the Coder
container does not have permission to write to this directory.
To fix this, you can mount a temporary volume in the pod and set
the `CODER_CACHE_DIRECTORY` environment variable to that location.

Additionally, create the Coder service as a `ClusterIP`. In the next step,
you will create an OpenShift route that points to the service HTTP target port.
Expand All @@ -70,7 +71,7 @@ coder:
type: ClusterIP
env:
- name: CODER_CACHE_DIRECTORY
value: /tmp/coder-cache
value: /cache
- name: CODER_PG_CONNECTION_URL
valueFrom:
secretKeyRef:
Expand All @@ -82,7 +83,15 @@ coder:
runAsNonRoot: true
runAsUser: <project-specific UID>
runAsGroup: <project-specific GID>
readOnlyRootFilesystem: false
readOnlyRootFilesystem: true
volumes:
- name: "cache"
emptyDir:
sizeLimit: 500Mi
volumeMounts:
- name: "cache"
mountPath: "/cache"
readOnly: false
```

> Note: OpenShift provides a Developer Catalog offering you can use to
Expand Down