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

Cherry pick fuse docs update for OpenShift 4.15 #2698

Merged
merged 1 commit into from Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions modules/administration-guide/pages/configuring-fuse.adoc
Expand Up @@ -16,6 +16,11 @@ For more efficient image management, use the fuse-overlayfs storage driver which

To use fuse-overlayfs, you must make `/dev/fuse` accessible to workspace containers first.

[NOTE]
====
This procedure is not necessary for OpenShift versions 4.15 and later, since the `/dev/fuse` device is available by default. See link:https://docs.openshift.com/container-platform/4.15/release_notes/ocp-4-15-release-notes.html#ocp-4-15-nodes-dev-fuse[Release Notes].
====

[WARNING]
====
Creating `MachineConfig` resources on an OpenShift cluster is a potentially dangerous task, as you are making advanced, system-level changes to the cluster.
Expand Down
13 changes: 12 additions & 1 deletion modules/end-user-guide/pages/accessing-fuse.adoc
Expand Up @@ -11,19 +11,30 @@ You must have access to `/dev/fuse` to use fuse-overlayfs. This section describe

.Prerequisites

* The administrator has enabled access to `/dev/fuse` by following xref:administration-guide:configuring-fuse.adoc[].
* For OpenShift versions older than 4.15, the administrator has enabled access to `/dev/fuse` by following xref:administration-guide:configuring-fuse.adoc[].
* Determine a workspace to use fuse-overlayfs with.

.Procedure

. Use the `pod-overrides` attribute to add the required annotations defined in xref:administration-guide:configuring-fuse.adoc[] to the workspace. The `pod-overrides` attribute allows merging certain fields in the workspace pod's `spec`.
+
For OpenShift versions older than 4.15:
+
[subs="+quotes,+attributes,+macros"]
----
$ {orch-cli} patch devworkspace __<DevWorkspace_name>__ \
--patch '{"spec":{"template":{"attributes":{"pod-overrides":{"metadata":{"annotations":{"io.kubernetes.cri-o.Devices":"/dev/fuse","io.openshift.podman-fuse":""}}}}}}}' \
--type=merge
----
+
For OpenShift version 4.15 and later:
+
[subs="+quotes,+attributes,+macros"]
----
$ {orch-cli} patch devworkspace __<DevWorkspace_name>__ \
--patch '{"spec":{"template":{"attributes":{"pod-overrides":{"metadata":{"annotations":{"io.kubernetes.cri-o.Devices":"/dev/fuse"}}}}}}}' \
--type=merge
----

.Verification steps

Expand Down
Expand Up @@ -35,7 +35,7 @@ Otherwise, you can update the `/home/user/.config/containers/storage.conf` for a

.Prerequisites

* The administrator has enabled access to `/dev/fuse` by following xref:administration-guide:configuring-fuse.adoc[].
* For OpenShift versions older than 4.15, the administrator has enabled access to `/dev/fuse` by following xref:administration-guide:configuring-fuse.adoc[].

* A workspace with the required annotations are set by following xref:accessing-fuse.adoc[]

Expand Down
Expand Up @@ -17,7 +17,7 @@ For more efficient image management, use the fuse-overlayfs storage driver which

You must meet the following requirements to fuse-overlayfs in a workspace:

. The administrator has configured `/dev/fuse` access on the cluster by following xref:administration-guide:configuring-fuse.adoc[].
. For OpenShift versions older than 4.15, the administrator has enabled `/dev/fuse` access on the cluster by following xref:administration-guide:configuring-fuse.adoc[].
. The workspace has the necessary annotations for using the `/dev/fuse` device. See xref:accessing-fuse.adoc[].
. The `storage.conf` file in the workspace container has been configured to use fuse-overlayfs. See xref:enabling-overlay-with-a-configmap.adoc[].

Expand Down