Skip to content

Commit aa11595

Browse files
authored
Merge pull request #347 from liulanzheng/update_build_doc
update doc for buildkit
2 parents babcf51 + 2553547 commit aa11595

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,8 @@ Accelerated Container Image is a __non-core__ sub-project of containerd.
5252

5353
What's more, standalone userspace image-convertor is faster than embedded image-convertor when used with our [customized libext2fs](https://github.com/data-accelerator/e2fsprogs). See [USERSPACE_CONVERTOR](https://github.com/containerd/accelerated-container-image/blob/main/docs/USERSPACE_CONVERTOR.md) for more details.
5454

55-
* [buildkit for overlaybd](https://github.com/data-accelerator/buildkit) (Experimental)
56-
57-
It is a customized buildkit for overlaybd images. It fetches the data of base images on demand without pulling whole data and uses overlaybd writable layer to build new layers.
55+
* buildkit
56+
BuildKit officially supports overlaybd image building since v0.22. Benefiting from the on-demand loading of the base image and the high-performance writable layer, image build speeds can be significantly improved. Compared to the image conversion approach, this method saves the time previously required for conversion. See more at [Overlaybd](https://github.com/moby/buildkit/blob/master/docs/overlaybd.md).
5857

5958
* [overlaybd - turboOCIv1](docs/TURBO_OCI.md)
6059

docs/QUICKSTART.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ sudo /opt/overlaybd/snapshotter/convertor -r registry.hub.docker.com/library/red
263263

264264
## Image build
265265

266-
Overlaybd images can be efficiently built from overlaybd images by using the [customized buildkit](https://github.com/data-accelerator/buildkit).
266+
Overlaybd images can be efficiently built from overlaybd images by using the [buildkit](https://github.com/moby/buildkit) v0.22+.
267267

268268
### Install
269269

@@ -280,12 +280,12 @@ sudo make install
280280
First, make sure the overlaybd-snapshotter and overlaybd-tcmu running.
281281

282282
```bash
283-
# use containerd worker with overlaybd snapshotter
284-
buildkitd --containerd-worker-snapshotter=overlaybd --oci-worker=false --containerd-worker=true
283+
# use oci worker with overlaybd snapshotter
284+
buildkitd --oci-worker-snapshotter=overlaybd --oci-worker-proxy-snapshotter-path=/run/overlaybd-snapshotter/overlaybd.sock
285285
```
286286

287287
Then, write your Dockerfile and run buildctl to build images.
288-
The `FROM` if Dockerfile must be an overlaybd image.
288+
The `FROM` image in Dockerfile must be an overlaybd image.
289289

290290
```bash
291291
buildctl build \

0 commit comments

Comments
 (0)