Skip to content

Add a note about using nix-docker-builder when on macOS/Darwin #745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions modules/contributor/pages/testing-on-kubernetes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lfrancke @soenkeliebau This repo is private for now, are we okay to publish it? (Also, licensing.)


== Using

The build and deploy steps for installing and running the operator are defined in the `Tiltfile` in the operators repository.
Expand Down
Loading