Skip to content

Commit cdb0a0d

Browse files
authored
fix: update details about fuse for OpenShift 4.15 (#2694)
Signed-off-by: dkwon17 <dakwon@redhat.com>
1 parent 1f9ecf7 commit cdb0a0d

File tree

4 files changed

+19
-3
lines changed

4 files changed

+19
-3
lines changed

modules/administration-guide/pages/configuring-fuse.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ For more efficient image management, use the fuse-overlayfs storage driver which
1616

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

19+
[NOTE]
20+
====
21+
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].
22+
====
23+
1924
[WARNING]
2025
====
2126
Creating `MachineConfig` resources on an OpenShift cluster is a potentially dangerous task, as you are making advanced, system-level changes to the cluster.

modules/end-user-guide/pages/accessing-fuse.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,30 @@ You must have access to `/dev/fuse` to use fuse-overlayfs. This section describe
1111

1212
.Prerequisites
1313

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

1717
.Procedure
1818

1919
. 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`.
2020
+
21+
For OpenShift versions older than 4.15:
22+
+
2123
[subs="+quotes,+attributes,+macros"]
2224
----
2325
$ {orch-cli} patch devworkspace __<DevWorkspace_name>__ \
2426
--patch '{"spec":{"template":{"attributes":{"pod-overrides":{"metadata":{"annotations":{"io.kubernetes.cri-o.Devices":"/dev/fuse","io.openshift.podman-fuse":""}}}}}}}' \
2527
--type=merge
2628
----
29+
+
30+
For OpenShift version 4.15 and later:
31+
+
32+
[subs="+quotes,+attributes,+macros"]
33+
----
34+
$ {orch-cli} patch devworkspace __<DevWorkspace_name>__ \
35+
--patch '{"spec":{"template":{"attributes":{"pod-overrides":{"metadata":{"annotations":{"io.kubernetes.cri-o.Devices":"/dev/fuse"}}}}}}}' \
36+
--type=merge
37+
----
2738

2839
.Verification steps
2940

modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Otherwise, you can update the `/home/user/.config/containers/storage.conf` for a
3535

3636
.Prerequisites
3737

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

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

modules/end-user-guide/pages/using-the-fuse-overlay-storage-driver.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For more efficient image management, use the fuse-overlayfs storage driver which
1717

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

20-
. The administrator has configured `/dev/fuse` access on the cluster by following xref:administration-guide:configuring-fuse.adoc[].
20+
. 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[].
2121
. The workspace has the necessary annotations for using the `/dev/fuse` device. See xref:accessing-fuse.adoc[].
2222
. The `storage.conf` file in the workspace container has been configured to use fuse-overlayfs. See xref:enabling-overlay-with-a-configmap.adoc[].
2323

0 commit comments

Comments
 (0)