From c32da8fdae783bafc00a83aec8aa759a3fff6b7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Natalie=20Klestrup=20R=C3=B6ijezon?= Date: Thu, 5 Jun 2025 14:14:17 +0200 Subject: [PATCH] Add a note about using nix-docker-builder when on macOS/Darwin --- modules/contributor/pages/testing-on-kubernetes.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/modules/contributor/pages/testing-on-kubernetes.adoc b/modules/contributor/pages/testing-on-kubernetes.adoc index 5c60513ed..1955ba6cc 100644 --- a/modules/contributor/pages/testing-on-kubernetes.adoc +++ b/modules/contributor/pages/testing-on-kubernetes.adoc @@ -20,6 +20,7 @@ To shorten these, we have settled on a tool called https://github.com/kolloch/cr This tool uses the https://nixos.org/[Nix package manager] to cache intermediate build steps and only recompile what has actually changed, thus significantly shortening build times. == Installation + Due to the nature of how Nix works, all the setup steps are defined in the operator repositories and automatically applied when you start using this workflow. The only prerequisite you need to install is the actual Nix package manager - you can find installation instructions and additional documentation on the https://nixos.org/download.html[Nix website]. @@ -47,6 +48,12 @@ Please adjust the number of `cores` to your system and set the `max-jobs` to e.g Just installing Nix does not affect your system much, as it keeps all its configuration and installed packages separate from other package managers and you won't even notice it is there, unless you actually start using it. +=== macOS + +The Docker images need to be built on a Linux host. Nix can automatically delegate the build to a remote worker, but it must be configured to do so. + +https://github.com/stackabletech/nix-docker-builder can set this up for you. + == Using The build and deploy steps for installing and running the operator are defined in the `Tiltfile` in the operators repository.