Update fuse docs for Podman 5.x #2842
Conversation
|
🎊 Navigate the preview: https://67783b914e30744f1de33309--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
dkwon17
force-pushed
the
fuseupdate
branch
3 times, most recently
from
c756db3 to
3df0d02
Compare
Signed-off-by: dkwon17 <dakwon@redhat.com>
| For Podman 5.x, the `/home/user/.config` must be owned by the current user for Podman to function correctly. | ||
| The `storage.conf` file for Podman is typically stored in this folder. | ||
| This document explains how to configure the container entrypoint script for the workspace so that fuse-overlayfs is being used. | ||
| The Universal Developer Image (UDI) already contains the necessary configuration by default. |
There was a problem hiding this comment.
when you refer to the configuration already contained in UDI, what sort of configuration are you referring to? the one from the previous line (container entrypoint script)?
| @@ -7,6 +7,11 @@ | |||
| [id="enabling-fuse-overlayfs-for-all-workspaces"] | |||
| = Enabling fuse-overlayfs for all workspaces | |||
|
|
|||
| For Podman 5.x, the `/home/user/.config` must be owned by the current user for Podman to function correctly. | |||
| The `storage.conf` file for Podman is typically stored in this folder. | |||
| This document explains how to configure the container entrypoint script for the workspace so that fuse-overlayfs is being used. | |||
There was a problem hiding this comment.
after configuration, is fuse-overlayfs used by the workspace with the configured script? the wording is a bit unclear, especially with "so that fuse-overlayfs is being used."
| The `storage.conf` file for Podman is typically stored in this folder. | ||
| This document explains how to configure the container entrypoint script for the workspace so that fuse-overlayfs is being used. | ||
| The Universal Developer Image (UDI) already contains the necessary configuration by default. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * The xref:administration-guide:enabling-access-to-dev-fuse-for-openshift.adoc[] section has been completed. This is not required for OpenShift versions 4.15 and later. |
There was a problem hiding this comment.
i'm wondering if it would make sense to reword the prerequisite since it's only necessary for older OCP versions.
maybe we should add FOR OCP VERSIONS 4.14 AND LOWER there?
| @@ -62,9 +39,51 @@ spec: | |||
| For OpenShift versions before 4.15, the `io.openshift.podman-fuse: ""` annotation is also required. | |||
| ==== | |||
|
|
|||
| . If you are using a custom image for the workspace container, create the `/home/user/.config` folder and configure the `storage.conf` file on runtime via the entrypoint. | |||
| To do this, create add the following to the workspace container image's entrypoint script before building the image. | |||
| To do this, create add the following to the workspace container image's entrypoint script before building the image. | ||
| + | ||
| ==== | ||
| [source,bash,subs="+quotes,+macros"] |
There was a problem hiding this comment.
please don't use bash as a source language, it causes issues https://redhat-documentation.github.io/supplementary-style-guide/#code-example-syntax-highlighting
| + | ||
| [NOTE] | ||
| ==== | ||
| This is configured in the UDI by default. Therefore this step is only required if you are using a custom image for the workspace container. |
There was a problem hiding this comment.
maybe we could mark the whole step as [OPTIONAL] since it's only required for custom images
What does this pull request change?
This PR updates the "Enabling fuse-overlayfs for all workspaces" doc such that they work with Podman 5.x. This PR is in response to devfile/developer-images#209
What issues does this pull request fix or reference?
Related PR: devfile/developer-images#209
Specify the version of the product this pull request applies to
Che 7.95
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.