From a424e837497caa0d7b842b25aead190465733669 Mon Sep 17 00:00:00 2001 From: Kohei Tokunaga Date: Thu, 19 May 2022 09:48:31 +0900 Subject: [PATCH] README: Add doc about `nerdctl builder debug` Signed-off-by: Kohei Tokunaga --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7290155b..5a6242e1 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,18 @@ hi Available from https://github.com/ktock/buildg/releases -### Building using make +### Rootless mode + +Install and use [`buildg.sh`](./extras/buildg.sh). +[RootlessKit](https://github.com/rootless-containers/rootlesskit) and [slirp4netns](https://github.com/rootless-containers/slirp4netns) are needed. + +``` +$ buildg.sh debug /path/to/context +``` + +The doc in BuildKit project for troubleshooting: https://github.com/moby/buildkit/blob/master/docs/rootless.md#troubleshooting + +### Building binary using make Go 1.18+ is needed. @@ -130,17 +141,14 @@ $ make $ sudo make install ``` -### Rootless mode +### nerdctl -Install and use [`buildg.sh`](./extras/buildg.sh). -[RootlessKit](https://github.com/rootless-containers/rootlesskit) and [slirp4netns](https://github.com/rootless-containers/slirp4netns) are needed. +[nerdctl](https://github.com/containerd/nerdctl) project provides buildg as a subcommand since v0.20.0: https://github.com/containerd/nerdctl/blob/v0.20.0/docs/builder-debug.md ``` -$ buildg.sh debug /tmp/mybuild +$ nerdctl builder debug /path/to/build/context ``` -The doc in BuildKit project for troubleshooting: https://github.com/moby/buildkit/blob/master/docs/rootless.md#troubleshooting - ## Motivation Debugging a large and complex Dockerfile isn't easy and can take a long time.