Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit a344fcf

Browse files
johnstcnKatie Horne
andauthored
chore: document hostPaths mounted by CVMs (#838)
* chore: document hostPaths mounted by CVMs * fix table * add link to sysbox design nodes * chore: edit text * remove stray character Co-authored-by: Katie Horne <katie@coder.com>
1 parent 91cbd67 commit a344fcf

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

admin/workspace-management/cvms/index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ deployment option.
1717
Kubernetes Node must run a supported Linux distro with the minimum kernel
1818
version. See
1919
[Sysbox distro compatibility](https://github.com/nestybox/sysbox/blob/master/docs/distro-compat.md)
20+
and
21+
[Sysbox User Guide: Design Notes](https://github.com/nestybox/sysbox/blob/master/docs/user-guide/design.md)
2022
for more information.
2123

2224
- The cluster must allow privileged containers and `hostPath` mounts. See
@@ -28,6 +30,24 @@ deployment option.
2830
> [Google](../../../setup/kubernetes/google.md). Azure-hosted clusters will meet
2931
> these requirements as long as you use Kubernetes version 1.18+.
3032
33+
### HostPath mounts
34+
35+
The host paths required for CVM functionality depend on whether you've enabled
36+
**Caching** and **Auto loading of the `shiftfs` kernel module**. You can find
37+
these settings under **Manage > Admin > Infrastructure**.
38+
39+
The following table documents the host paths that are mounted:
40+
41+
<!-- markdownlint-disable -->
42+
43+
| Caching | Auto Load `shiftfs` | `/usr/src` | `/lib/modules` | `/var/run` | `/var/lib` |
44+
| ------- | ------------------- | ---------- | -------------- | ---------- | ---------- |
45+
| Off | N/A | Read-only | Read-only | | |
46+
| On | Off | Read-only | Read-only | Read-only | Read-write |
47+
| On | On | Read-write | Read-write | Read-only | Read-write |
48+
49+
<!-- markdownlint-restore -->
50+
3151
## Security
3252

3353
The container-based virtual machine deployment option leverages the Sysbox

0 commit comments

Comments
 (0)