Skip to content
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

docs: Create read-only-fs.md #592

Merged
merged 6 commits into from
Dec 4, 2024
Merged
Changes from 2 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
34 changes: 34 additions & 0 deletions docs/read-only-fs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Read-only File Systems

Support for read-only file systems is currently in testing.

To test it, follow these steps:

## Use pre-release EE images

The custom images https://hub.docker.com/repository/docker/mend/renovate-ee-server and https://hub.docker.com/repository/docker/mend/renovate-ee-worker have been built to support read-only FS.
Use whatever is the latest `9.0.0-pre.x` tag available.

The `-full` worker image is now yet supported.
rarkins marked this conversation as resolved.
Show resolved Hide resolved

## Run the images in read-only mode

Set both the Server and Worker images to run with read-only file systems (e.g. `readOnlyRootFilesystem ` in Kubernetes).

## Map read-write volumes

Ensure that the EE Server has a read-write `/tmp` volume.

Ensure that the EE Worker has read-write `/tmp` and `/opt/containerbase` volumes.

## Other volumes

The main "risk" of a read-only FS for Renovate is that there are dozens of package managers which can be called, and those package managers can choose to write files into unexpected locations.
rarkins marked this conversation as resolved.
Show resolved Hide resolved

When such cases are found, the best scenario is that the Renovate CLI can be enhanced to "coerce" managers into writing to `/tmp/renovate`, e.g. through the configuration of environment variables.
However, it may also be feasible to selectively map files or folders as a stopgap solution (e.g. `/home/ubuntu/.some-manager`).

## Testing and release

The measure of success is that all packager managers succeed (e.g. at updating lock files) using the read-write volumes only.
Once more testing has been done and confidence raised that each manager works, then we will release this as GA.