Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
csegarragonz committed Feb 3, 2025
1 parent 0b4028f commit b46a1a4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ For further documentation, you may want to check these other documents:
* [CoCo Upgrade](./docs/upgrade_coco.md) - upgrade the current CoCo version.
* [Guest Components](./docs/guest_components.md) - instructions to patch components inside SC2 guests.
* [Host Kernel](./docs/host_kernel.md) - bump the kernel version in the host.
* [Image Pull](./docs/image_pull.md) - details on the image-pulling mechanisms supported in SC2.
* [K8s](./docs/k8s.md) - documentation about configuring a single-node Kubernetes cluster.
* [Kata](./docs/kata.md) - instructions to build our custom Kata fork and `initrd` images.
* [Key Broker Service](./docs/kbs.md) - docs on using and patching the KBS.
Expand Down
23 changes: 23 additions & 0 deletions docs/image_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ the cVM.
Albeit secure, this mechanism has high performance overheads as the image must
be pulled every single time, precluding any caching benefits.

To mitigate the performance overheads, we can convert the OCI image to a
Nydus image, that supports lazy loading of container data.

### Host Share

The host share mechanism mounts a container image from the host to the guest.
Expand All @@ -26,3 +29,23 @@ attestation.

We could mount encrypted images from the host to the guest, but we would be
losing on the de-duplication opportunities in the host.

### Usage

Each image pull mechanism is implemented as a different remote snapshotter
in containerd, all of them based on the [nydus-snapshotter](
https://github.com/containerd/nydus-snapshotter/) plus our modifications.

To switch between different image-pulling mechanisms, you only need to change
the snapshotter mode:

```bash
inv nydus-snapshotter.set-mode [guest-pull,host-share]
```

If you see any snapshotter related issues (either in the `containerd` or the
`nydus-snapshotter` journal logs), you can purge the snapshotters:

```bash
inv nydus-snapshotter.purge
```

0 comments on commit b46a1a4

Please sign in to comment.