From 0d21db6bf5fb869f515a9b1ca26ecce172871ff0 Mon Sep 17 00:00:00 2001 From: Maksym Pavlenko Date: Wed, 5 Aug 2026 17:46:25 -0700 Subject: [PATCH] docs: reflow the erofs tar index mode section Wrap the four long paragraphs at 80 columns to match the rest of the file. No text changes. Signed-off-by: Maksym Pavlenko --- docs/snapshotters/erofs.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/snapshotters/erofs.md b/docs/snapshotters/erofs.md index 06d5d33d3a..358b72a93f 100644 --- a/docs/snapshotters/erofs.md +++ b/docs/snapshotters/erofs.md @@ -329,16 +329,30 @@ with or without the EROFS differ. ## Tar Index Mode -The EROFS differ also supports a "tar index" mode that offers a unique approach to handling OCI image layers: +The EROFS differ also supports a "tar index" mode that offers a unique approach +to handling OCI image layers: -Instead of extracting the entire tar archive to create an EROFS filesystem, the tar index mode: +Instead of extracting the entire tar archive to create an EROFS filesystem, the +tar index mode: 1. Generates a tar index for the tar content 2. Appends the original tar content to the index 3. Creates a combined file: `[Tar index][Original tar content]` -The tar index can be stored in a registry alongside image layers, allowing nodes to fetch it directly when needed. Typically, the tar index is much smaller than a full EROFS blob, making it more efficient to store and transfer. If the tar index is not available in the registry, it can be generated on the node as a fallback. When integrating with dm-verity, the registry can also store the dm-verity Merkle tree and root hash signature together with the tar index, enabling nodes to retrieve all necessary artifacts without redundant computation. +The tar index can be stored in a registry alongside image layers, allowing nodes +to fetch it directly when needed. Typically, the tar index is much smaller than +a full EROFS blob, making it more efficient to store and transfer. If the tar +index is not available in the registry, it can be generated on the node as a +fallback. When integrating with dm-verity, the registry can also store the +dm-verity Merkle tree and root hash signature together with the tar index, +enabling nodes to retrieve all necessary artifacts without redundant +computation. -In addition, we have a tar diffID for each layer according to the OCI image spec, so we don't need to reinvent a new way to verify the image layer content for confidential containers but just calculate the sha256 of the original tar data (because erofs could just reuse the tar data with 512-byte fs block size and build a minimal index for direct mounting of tar) out of the tar index mode in the guest and compare it with each diffID. +In addition, we have a tar diffID for each layer according to the OCI image +spec, so we don't need to reinvent a new way to verify the image layer content +for confidential containers but just calculate the sha256 of the original tar +data (because erofs could just reuse the tar data with 512-byte fs block size +and build a minimal index for direct mounting of tar) out of the tar index mode +in the guest and compare it with each diffID. ### Configuration