containerd · yuchen0cc · May 12, 2023 · May 12, 2023
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,55 @@
+# Overlaybd
+
+Overlaybd (overlay block device) is a novel layering block-level image format, which is design for container, secure container and applicable to virtual machine. And it is an open-source implementation of paper [DADI: Block-Level Image Service for Agile and Elastic Application Deployment. USENIX ATC'20"](https://www.usenix.org/conference/atc20/presentation/li-huiba).
+
+Overlaybd was first proposed by Alibaba Cloud and widely used in Alibaba cloud services. It became a sub-project of containerd in 2021.
+
+
+# Components
+
+## Overlaybd service
+
+[GitHub](https://github.com/containerd/overlaybd)
+
+Sub-project of containerd, contains the storage service of overlaybd image format, provideing a merged view of a sequence of block-based layers as a virtual block device.
+Now this service contains an implementation of overlaybd based on [TCMU](https://www.kernel.org/doc/Documentation/target/tcmu-design.txt), and will provide an implementation based on [ublk](https://docs.kernel.org/block/ublk.html) in the future.
+
+This service is based on [PhotonLibOS](https://github.com/alibaba/PhotonLibOS), which is a high-efficiency LibOS framework.
+
+## Accelerated container image
+
+[GitHub](https://github.com/containerd/accelerated-container-image)
+[Getting started](https://github.com/containerd/accelerated-container-image/blob/main/docs/QUICKSTART.md)
+
+Sub-project of containerd, which is a solution of remote container image by fetching image data on-demand without downloading and unpacking the whole image before the container starts. This repositry contains a containerd snapshotter and image conversion tools for overlaybd.
+
+## P2P data distribution
+
+[GitHub](https://github.com/data-accelerator/dadi-p2proxy)
+
+Use p2p protocol to speed up HTTP file download for registry in large-scale clusters.
+
+<br>
+
+# Key features
+
+## High Performace
+
+Overlaybd is a block-device-based image format, which has much lower complexity than filesystem-based implementations. For example, cross-layer hardlink and non-copy commands like chown are very complex for filesystem-based image without copying up, but is natively supported by overlaybd.
+
+<img src="assets/cold_startup_latency.png" style="width: 30%; margin-right: 2%"/>
+<img src="assets/warm_startup_latency.png" style="width: 30%; margin-right: 2%"/>
+<img src="assets/startup_latency_with_prefetch.png" style="width: 30%"/>
+<img src="assets/batch_code_startup_latency.png" style="width: 30%; margin-right: 2%"/>
+<img src="assets/time_pull_image.png" style="width: 30%; margin-right: 2%"/>
+<img src="assets/time_launch_app.png" style="width: 30%"/>
+
+## High Reliability
+
+Overlaybd outputs virtual block devices through TCMU, which is a linux kernel module and widely supported in most operation systems.
+Overlaybd backstore can recover from failures or crashes, which is difficult for FUSE-based image formats.
+
+
+# Community
+
+For sync communication catch us in the #overlaybd slack channels on Cloud Native Computing Foundation's (CNCF) slack - cloud-native.slack.com. Everyone is welcome to join and chat. [Get Invite to CNCF slack.](https://communityinviter.com/apps/cloud-native/cncf)
diff --git a/docs/assets/batch_code_startup_latency.png b/docs/assets/batch_code_startup_latency.png
diff --git a/docs/assets/cold_startup_latency.png b/docs/assets/cold_startup_latency.png
diff --git a/docs/assets/startup_latency_with_prefetch.png b/docs/assets/startup_latency_with_prefetch.png
diff --git a/docs/assets/time_launch_app.png b/docs/assets/time_launch_app.png
diff --git a/docs/assets/time_pull_image.png b/docs/assets/time_pull_image.png
diff --git a/docs/assets/warm_startup_latency.png b/docs/assets/warm_startup_latency.png
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Overlaybd</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/dark.css" />
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: ''
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>