Update fuse docs for Podman 5.x #2842
Conversation
|
🎊 Navigate the preview: https://678ab189829fe63ea3e3a704--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 <[email protected]>
modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc
Show resolved
Hide resolved
| @@ -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."
There was a problem hiding this comment.
The script is configured for the container image entrypoint. After that, a new container image is built, and whatever workspace uses that container image, will be using fuse-overlay fs for podman
modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc
Outdated
Show resolved
Hide resolved
| @@ -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. | |||
There was a problem hiding this comment.
Updated, it should only be add
modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc
Outdated
Show resolved
Hide resolved
modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: dkwon17 <[email protected]>
|
@deerskindoll thank you for the review, I've made some changes |
modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc
Outdated
Show resolved
Hide resolved
| * For OpenShift versions 4.14 and lower, the xref:administration-guide:enabling-access-to-dev-fuse-for-openshift.adoc[] section has been completed. | ||
|
|
||
| * An active `{orch-cli}` session with administrative permissions to the destination OpenShift cluster. See {orch-cli-link}. |
There was a problem hiding this comment.
| * For OpenShift versions 4.14 and lower, the xref:administration-guide:enabling-access-to-dev-fuse-for-openshift.adoc[] section has been completed. | |
| * An active `{orch-cli}` session with administrative permissions to the destination OpenShift cluster. See {orch-cli-link}. | |
| * An active `{orch-cli}` session with administrative permissions to the destination OpenShift cluster. See {orch-cli-link}. | |
| * For OpenShift versions 4.14 and lower, the xref:administration-guide:enabling-access-to-dev-fuse-for-openshift.adoc[] section has been completed. | |
| * For Podman 5.x, the `/home/user/.config` must be owned by the current user. This is where the `storage.conf` file for Podman is typically stored. |
There was a problem hiding this comment.
For Podman 5.x, the
/home/user/.configmust be owned by the current user. This is where thestorage.conffile for Podman is typically stored.
This part is what the procedure aims to do, so it doesn't belong in the prerequisites. I've added a new commit to explain this part in the procedure steps: 5795e7c
WDYT?
| For OpenShift versions 4.14 and lower, the `io.openshift.podman-fuse: ""` annotation is also required. | ||
| ==== | ||
|
|
||
| . Optional: 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. |
There was a problem hiding this comment.
| . Optional: 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. | |
| . [OPTIONAL] 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. |
There was a problem hiding this comment.
I've applied this change, but the doc renders this as:
which I don't think is expected
modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc
Outdated
Show resolved
Hide resolved
…paces.adoc Co-authored-by: Jana Vrbkova <[email protected]>
…paces.adoc Co-authored-by: Jana Vrbkova <[email protected]>
…paces.adoc Co-authored-by: Jana Vrbkova <[email protected]>
Signed-off-by: dkwon17 <[email protected]>
|
@deerskindoll sorry for the late feedback, I've added some new comments |
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.