Update fuse docs for Podman 5.x #2842

dkwon17 · 2025-01-03T06:15:10Z

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.

Any procedure:
- Successfully tested.
Any page or link rename:
- The page contains a redirection for the previous URL.
- Propagate the URL change in:
  - Dashboard default branding data
Builds on Eclipse Che hosted by Red Hat.
the Validate language on files added or modified step reports no vale warnings.

github-actions · 2025-01-03T06:15:20Z

🎊 Navigate the preview: https://677bfe8d37649e40c2f0abf6--eclipse-che-docs-pr.netlify.app 🎊

github-actions · 2025-01-03T06:15:21Z

Click here to review and test in web IDE:

Signed-off-by: dkwon17 <[email protected]>

deerskindoll

a couple of questions

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

deerskindoll · 2025-01-03T20:40:47Z

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

@@ -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.


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 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

deerskindoll · 2025-01-03T20:43:31Z

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

+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.


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?

I've updated the wording:

For OpenShift versions 4.14 and lower, the xref:administration-guide:enabling-access-to-dev-fuse-for-openshift.adoc[] section has been completed.

deerskindoll · 2025-01-03T20:45:20Z

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

@@ -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.


create and add?

Updated, it should only be add

deerskindoll · 2025-01-03T20:47:35Z

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

+To do this, create add the following to the workspace container image's entrypoint script before building the image.
+
+====
+[source,bash,subs="+quotes,+macros"]


please don't use bash as a source language, it causes issues https://redhat-documentation.github.io/supplementary-style-guide/#code-example-syntax-highlighting

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

Signed-off-by: dkwon17 <[email protected]>

dkwon17 · 2025-01-06T16:58:42Z

@deerskindoll thank you for the review, I've made some changes

deerskindoll

I edited the doc a bit to make it easier to follow. Let me know what you think.

deerskindoll · 2025-01-09T20:37:34Z

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

+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 workspace's container entrypoint script for the workspace so that fuse-overlayfs is being used for all workspaces using that container.
+The Universal Developer Image (UDI) already contains the necessary configuration by default.


Suggested change

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 workspace's container entrypoint script for the workspace so that fuse-overlayfs is being used for all workspaces using that container.

The Universal Developer Image (UDI) already contains the necessary configuration by default.

Learn about configuring the workspace's container entrypoint script so that fuse-overlayfs is used for all workspaces using that container.

The Universal Developer Image (UDI) already contains the necessary configuration by default. However, you must configure the script manually if you use custom images.

deerskindoll · 2025-01-09T20:40:30Z

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

+* 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}.


Suggested change

* 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.

deerskindoll · 2025-01-09T20:45:46Z

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

+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.


Suggested change

. 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.

deerskindoll · 2025-01-09T20:48:23Z

modules/administration-guide/pages/enabling-fuse-for-all-workspaces.adoc

+[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.
 ====


Suggested change

[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.

====

dkwon17 force-pushed the fuseupdate branch 3 times, most recently from c756db3 to 3df0d02 Compare January 3, 2025 16:41

feat: update fuse docs for Podman 5.x

d140ef6

Signed-off-by: dkwon17 <[email protected]>

dkwon17 force-pushed the fuseupdate branch from 3df0d02 to d140ef6 Compare January 3, 2025 19:30

dkwon17 marked this pull request as ready for review January 3, 2025 19:37

dkwon17 requested review from deerskindoll and a team as code owners January 3, 2025 19:37

dkwon17 requested a review from nickboldt January 3, 2025 19:37

deerskindoll reviewed Jan 3, 2025

View reviewed changes

Address PR feedback

081bc8b

Signed-off-by: dkwon17 <[email protected]>

deerskindoll reviewed Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update fuse docs for Podman 5.x #2842

Update fuse docs for Podman 5.x #2842

dkwon17 commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

deerskindoll left a comment

deerskindoll Jan 3, 2025

dkwon17 Jan 6, 2025

deerskindoll Jan 3, 2025

dkwon17 Jan 6, 2025

deerskindoll Jan 3, 2025

dkwon17 Jan 6, 2025

deerskindoll Jan 3, 2025

dkwon17 Jan 6, 2025

dkwon17 commented Jan 6, 2025

deerskindoll left a comment

deerskindoll Jan 9, 2025

deerskindoll Jan 9, 2025

deerskindoll Jan 9, 2025

deerskindoll Jan 9, 2025

		* 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}.

	. 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.

Update fuse docs for Podman 5.x #2842

Are you sure you want to change the base?

Update fuse docs for Podman 5.x #2842

Conversation

dkwon17 commented Jan 3, 2025 • edited Loading

What does this pull request change?

What issues does this pull request fix or reference?

Specify the version of the product this pull request applies to

Pull Request checklist

github-actions bot commented Jan 3, 2025 • edited Loading

github-actions bot commented Jan 3, 2025 • edited Loading

deerskindoll left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dkwon17 commented Jan 6, 2025

deerskindoll left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dkwon17 commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading