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

chore: document hostPaths mounted by CVMs #838

Merged
merged 5 commits into from
Feb 10, 2022
Merged

chore: document hostPaths mounted by CVMs #838

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c33f670
chore: document hostPaths mounted by CVMs
johnstcn Feb 9, 2022
29a1708
fix table
johnstcn Feb 9, 2022
45f07dd
add link to sysbox design nodes
johnstcn Feb 9, 2022
d25adc5
chore: edit text
Feb 9, 2022
b57dbde
remove stray character
Feb 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions admin/workspace-management/cvms/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ deployment option.
> [Google](../../../setup/kubernetes/google.md). Azure-hosted clusters will meet
> these requirements as long as you use Kubernetes version 1.18+.

### HostPath mounts

The host paths required for CVM functionality depend on whether **Caching** is
Copy link

@jawnsy jawnsy Feb 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth mentioning that Sysbox requires kernel source headers in order to run Kubernetes (e.g. kind) inside the sysbox container?

Also, here's docs for the sysbox mounts: https://github.com/nestybox/sysbox/blob/master/docs/user-guide/design.md#mounts

Not sure how much detail we want, I think the existing description is fine too

Copy link
Member Author

@johnstcn johnstcn Feb 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just link to the design document for folks who are curious and who want to dig deeper.

enabled and on whether **Auto loading of the `shiftfs` kernel module`** is
enabled. These settings can be found under **Manage > Admin > Infrastructure**.

The below table documents the host paths that are mounted:

| Caching | Off | On | On | | Auto load `shiftfs` | N/A | Off | On |
|--------------------:|-----------|------------|------------| | `/usr/src` |
Read-only | Read-only | Read-write | | `/lib/modules` | Read-only | Read-only |
Read-write | | `/var/run` | N/A | Read-only | Read-only | | `/var/lib` | N/A |
Read-write | Read-write |

## Security

The container-based virtual machine deployment option leverages the Sysbox
Expand Down