github.com/pdtpartners/nix-snapshotter

Welcome to the v0.4.0 release of nix-snapshotter!

Highlights

• Satisfy gRPC forward-compatibility requirement introduced in newer versions of k8s.io/cri-api to unblock updating nix-snapshotter to work with latest k3s.

Migration guide v0.3.0 -> v0.4.0

• The NixOS k3s module now (as of 2024) accepts a list of strings for extraFlags, so we've deprecated the unnecessary moreFlags option.

# v0.3.0
services.k3s.moreFlags = [
  "--container-runtime-endpoint unix:///run/containerd/containerd.sock"
];

# v0.4.0
services.k3s.extraFlags = [
  "--container-runtime-endpoint unix:///run/containerd/containerd.sock"
];

Contributors

• Edgar Lee
• Joseph Goulden
• Joshua Perry

Dependency Changes

• None

Welcome to the v0.3.0 release of nix-snapshotter!

Highlights

• New images built with pkgs.nix-snapshotter.buildImage now only has a single annotation per layer instead of an annotation per store path. The single annotation now is a nix store path to a closure-info file that references all the store paths, allowing a single substitution and gc root to be realised by nix-snapshotter and should significantly speed up preparing layers with a large number of store paths
  • Nix-snapshotter remains compatible with images created with prior releases but images created before v0.3.0 may become incompatible when we cut v1.0.0.
• Nix-snapshotter bumped to containerd v2 golang API, allowing it to be embedded in k3s HEAD as it has also moved on to containerd v2. This was blocking work as embedding requires k3s to vendor nix-snapshotter and the containerd versions need to match.

Contributors

• Edgar Lee

Dependency Changes

• None

Welcome to the v0.2.2 release of nix-snapshotter!

Highlights

• Small release for bumping to NixOS 25.05 compatibility, which includes updating our patch for k3s to include nix-snapshotter support

Contributors

• Edgar Lee
• Srini Muthu
• Robbie Buxton

Dependency Changes

• NixOS 24.05 -> 25.05

Welcome to the v0.2.1 release of nix-snapshotter!

Highlights

• Support for gVisor
• Various bug fixes

New options (NixOS & Home Manager)

• New options for containerd & containerd.rootless

  config.virtualisation.containerd = {
    enable = true;
    # Register gvisor's runsc as a container runtime.
    gVisorIntegration = true;
    # Use runsc as the default container runtime.
    defaultRuntime = "runsc";
  }

Contributors

• bglgwyng
• Christian Kögler
• Edgar Lee
• Ian Becker
• Robbie Buxton
• Yureka

Dependency Changes

• NixOS 23.11 -> 24.05

Welcome to the v0.2.0 release of nix-snapshotter!

Highlights

• Provides NixOS & Home Manager modules for rootless Kubernetes (k3s) + nix-snapshotter
• Separate nix run .#vm and nix run .#vm-rootless
• Separate preload-container service into independent modules
• Pin k3s to v1.27.9+k3s1 with patches to enable embedded nix-snapshotter
  • k3s PR to support nix-snapshotter: k3s-io/k3s#9319

New options (NixOS & Home Manager)

• Services preload-containerd & preload-containerd.rootless:

  config.services.preload-containerd = {
    enable = true;
    targets = [{
      archives = [ pkgs.nix-snapshotter.buildImage { /* ... */ } ];
      namespace = "k8s.io";
      address = "/run/k3s/containerd/containerd.sock";
    }];
  };

• New options for k3s & new service k3s.rootless:

  config.services.k3s = {
    enable = true;
    # Sets the snapshotter for embedded containerd.
    snapshotter = "nix";
    # Sets KUBECONFIG env var to point to k3s.
    setKubeConfig = true;
    # Sets CONTAINERD_* env vars to point to k3s embedded containerd.
    setEmbeddedContainerd = true;
  }

• New options for containerd & containerd.rootless:

  config.virtualisation.containerd = {
    enable = true;
    # Enable integration with nix-snapshotter.
    nixSnapshotterIntegration = true;
    # Set the CONTAINERD_* env vars, but also set automatically by
    # `nixSnapshotterIntegration` or by `services.k3s.setEmbeddedContainerd`.
    setAddress = "/run/containerd/containerd.sock";
    setNamespace = "default";
    setSnapshotter = "nix";
  }

• New option only for NixOS module containerd:

  config.virtualisation.containerd = {
    enable = true;
    # Enable integration with k3s. This is mutually exclusive with setting
    # `services.k3s.snapshotter` and `services.k3s.setEmbeddedContainerd`.
    k3sIntegration = true;
  };

Migration guide v0.1.x -> v0.2.0

• Removed options.services.nix-snapshotter.setContainerdSnapshotter

  # v0.1.x
  services.nix-snapshotter = {
    enable = true;
    setContainerdSnapshotter = true;
  };
  
  # v0.2.0 (same for rootless)
  virtualisation.containerd = {
    enable = true;
    nixSnapshotterIntegration = true;
  };
  services.nix-snapshotter = {
    enable = true;
  };

• Removed options.services.nix-snapshotter.preloadContainerdImages

  # v0.1.x
  services.nix-snapshotter = {
    enable = true;
    preloadContainerdImages = [ pkgs.nix-snapshotter.buildImage { /* ... */ } ];
  };
  
  # v0.2.0 (same for rootless)
  virtualisation.containerd = {
    enable = true;
    nixSnapshotterIntegration = true;
  }
  services.nix-snapshotter = {
    enable = true;
  };
  services.preload-containerd = {
    targets = [{
      archives = [ pkgs.nix-snapshotter.buildImage { /* ... */ } ];
    }];
  };

Contributors

• Edgar Lee

Dependency Changes

• None

Welcome to the v0.1.2 release of nix-snapshotter!

New features

• Provide pkg/plugin package to compile containerd with builtin support for nix-snapshotter (#112 )
• Add new configuration option external_builder to provide an external executable as a NixBuilder (#113)

Please try it out and report any issues at:
https://github.com/pdtpartners/nix-snapshotter/issues

Contributors

• Edgar Lee

Dependency Changes

• None

Welcome to the v0.1.1 release of nix-snapshotter!

Bug fixes

• Correctly invokes nix build to substitute missing store paths (#107)
• Enable k3s to use nix-snapshotter as an image-service-endpoint to resolve nix:0/<nix-store-path> image references (#110)

Please try it out and report any issues at:
https://github.com/pdtpartners/nix-snapshotter/issues

Contributors

• Edgar Lee
• Antoine Roy-Gobeil
• Robbie Buxton
• Graham Bennett
• Cameron Smith

Dependency Changes

• github:edolstra/flake-compat bumped
• github:hercules-ci/flake-parts bumped
• github:NixOS/nixpkgs/nixos-unstable changed to github:NixOS/nixpkgs/nixos-23.11

Welcome to the v0.1.0 release of nix-snapshotter!

This is the first public release of nix-snapshotter. Please try it out and report any issues at:
https://github.com/pdtpartners/nix-snapshotter/issues

Contributors

• Edgar Lee
• Robbie Buxton
• Graham Bennett