Merge pull request #4 from AkihiroSuda/dev

Support flake
reproducible-containers · Dec 28, 2021 · 85458a3 · 85458a3
2 parents 95a6304 + 7acf3b3
commit 85458a3
Show file tree

Hide file tree

Showing 10 changed files with 143 additions and 16 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -34,3 +34,5 @@ jobs:
         sudo apt-get install -y moreutils
     - name: "Run the integration test"
       run: ./hack/test.sh
+    - name: "Show the local images"
+      run: docker images --no-trunc
diff --git a/README.md b/README.md
@@ -1,10 +1,11 @@
 # BuildKit-Nix: Nix as Dockerfiles (`docker build -f default.nix .`)
 
-BuildKit-Nix allows using Nix derivations (`default.nix`) as Dockerfiles.
+BuildKit-Nix allows using Nix derivations (`default.nix`, `flake.nix`) as Dockerfiles.
 
 ## Examples
 
-- [`./examples/nginx/default.nix`](./examples/nginx/default.nix)
+- [`./examples/nginx/default.nix`](./examples/nginx/default.nix): Nginx (Legacy)
+- [`./examples/nginx-flake/flake.nix`](./examples/nginx-flake/flake.nix): Nginx (Flake)
 
 ## Usage
 ### With Docker

diff --git a/cmd/buildkit-nix/helper.go b/cmd/buildkit-nix/helper.go
@@ -59,12 +59,25 @@ func helperAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	// nix-build creates a docker V1 tgz to /context/result .
-	nixBuildCmd := exec.CommandContext(ctx, "nix-build", "--option", "build-users-group", "", fullFilename)
+	flakeMode := filepath.Base(filename) == "flake.nix"
+	// nix creates a docker V1 tgz to /context/result .
+	var nixBuildCmd *exec.Cmd
+	if flakeMode {
+		nixBuildCmd = exec.CommandContext(ctx,
+			"nix",
+			"--extra-experimental-features", "nix-command",
+			"--extra-experimental-features", "flakes",
+			"build",
+			"--option", "build-users-group", "",
+			"/dockerfile",
+		)
+	} else {
+		nixBuildCmd = exec.CommandContext(ctx, "nix-build", "--option", "build-users-group", "", fullFilename)
+	}
 	nixBuildCmd.Dir = "/context"
 	nixBuildCmd.Stderr = cmd.OutOrStderr()
 	nixBuildCmd.Stdout = nixBuildCmd.Stderr
-	logrus.Infof("Running %v", nixBuildCmd.Args)
+	logrus.Infof("Running %v (flake mode: %v)", nixBuildCmd.Args, flakeMode)
 	if err := nixBuildCmd.Run(); err != nil {
 		return err
 	}

diff --git a/examples/nginx-flake/README.md b/examples/nginx-flake/README.md
@@ -0,0 +1,23 @@
+# Example: nginx (Flake)
+
+## Usage
+
+```bash
+export DOCKER_BUILDKIT=1
+docker build -t nginx-nix -f flake.nix .
+```
+
+```
+docker run -d -p 8080:80 --name nginx-nix nginx-nix
+```
+
+## Updating dependencies
+
+```bash
+nix flake update --override-input nixpkgs github:NixOS/nixpkgs/master
+```
+
+You might have to create `~/.config/nix/nix.conf` with the following content:
+```
+experimental-features = nix-command flakes
+```
diff --git a/examples/nginx-flake/flake.lock b/examples/nginx-flake/flake.lock
diff --git a/examples/nginx-flake/flake.nix b/examples/nginx-flake/flake.nix
@@ -0,0 +1,35 @@
+# syntax = ghcr.io/akihirosuda/buildkit-nix:latest
+
+{
+  outputs = { self, nixpkgs }:
+    let
+      pkgs = nixpkgs.legacyPackages.x86_64-linux;
+    in
+    with pkgs; {
+      defaultPackage.x86_64-linux = dockerTools.buildImage {
+        name = "nginx";
+        tag = "nix";
+        contents = [
+          # fakeNss creates /etc/passwd and /etc/group (https://github.com/NixOS/nixpkgs/blob/e548124f/pkgs/build-support/docker/default.nix#L741-L763)
+          dockerTools.fakeNss
+          bash
+          coreutils
+          nginx
+          (writeTextDir "${pkgs.nginx}/html/index.html" ''
+            <html><body>hello nix</body></html>
+          '')
+        ];
+        # Use extraCommands, not runAsRoot, to avoid dependency on KVM
+        extraCommands = "
+          grep -q ^nogroup etc/group || echo nogroup:x:65534: >>etc/group
+          mkdir -p var/log/nginx var/cache/nginx/client_body
+        ";
+        config = {
+          Cmd = [ "nginx" "-g" "daemon off; error_log /dev/stderr debug;" ];
+          ExposedPorts = {
+            "80/tcp" = { };
+          };
+        };
+      };
+    };
+}
diff --git a/examples/nginx/README.md b/examples/nginx/README.md
@@ -0,0 +1,19 @@
+# Example: nginx
+
+## Usage
+
+```bash
+export DOCKER_BUILDKIT=1
+docker build -t nginx-nix -f default.nix .
+```
+
+```
+docker run -d -p 8080:80 --name nginx-nix nginx-nix
+```
+
+## Updating dependencies
+
+```bash
+nix-env -i niv
+niv update
+```
diff --git a/examples/nginx/default.nix b/examples/nginx/default.nix
@@ -20,6 +20,7 @@ pkgs.dockerTools.buildImage{
     <html><body>hello nix</body></html>
     '')
   ];
+  # Use extraCommands, not runAsRoot, to avoid dependency on KVM
   extraCommands = "
     grep -q ^nogroup etc/group || echo nogroup:x:65534: >>etc/group
     mkdir -p var/log/nginx var/cache/nginx/client_body

diff --git a/examples/nginx/nix/sources.json b/examples/nginx/nix/sources.json
@@ -17,10 +17,10 @@
         "homepage": "",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "c64e26628b8b2cc958fe5cfad66c49f44473f8e3",
-        "sha256": "0i6ll77yszmkk0by94ayn47jjamdprvs3v0zhmbhg5pmnhcr5xcw",
+        "rev": "f03e55c9fc9d013adb2b4c6d61a2c78956c6ee6a",
+        "sha256": "03krwlw73lw4nmgj47ds1qmvcf1xpsl46g78b01kg7xklpiqwcxy",
         "type": "tarball",
-        "url": "https://github.com/NixOS/nixpkgs/archive/c64e26628b8b2cc958fe5cfad66c49f44473f8e3.tar.gz",
+        "url": "https://github.com/NixOS/nixpkgs/archive/f03e55c9fc9d013adb2b4c6d61a2c78956c6ee6a.tar.gz",
         "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
     }
 }
diff --git a/hack/test.sh b/hack/test.sh
@@ -18,12 +18,20 @@ image="127.0.0.1:5000/buildkit-nix:test-${version}-${timestamp}"
 "$DOCKER" build -t "$image" -f bootstrap.Dockerfile .
 "$DOCKER" push "$image"
 
-(
-	cd "${td}/examples/nginx"
-	sed -i '1 s/^ *# *syntax *=.*$//' default.nix
+for f in "${td}"/examples/*; do
+	name="$(basename "${f}")"
+	echo "===== ${name} ====="
 	(
-		echo "# syntax = ${image}"
-		cat default.nix
-	) | sponge default.nix
-	"$DOCKER" build -t nginx-nix -f default.nix .
-)
+		cd "$f"
+		df="default.nix"
+		if [[ -e "flake.nix" ]]; then
+			df="flake.nix"
+		fi
+		sed -i '1 s/^ *# *syntax *=.*$//' "${df}"
+		(
+			echo "# syntax = ${image}"
+			cat "${df}"
+		) | sponge "${df}"
+		"$DOCKER" build -t "${name}" -f "${df}" .
+	)
+done