foundationdb: split into multiple, major-versioned packages to make upgrades user-controllable

Signed-off-by: Austin Seipp <aseipp@pobox.com>

4 files changed, 132 insertions, 80 deletions

diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix
index 443cc6d5e456..693d2fde9916 100644
--- a/nixos/modules/services/databases/foundationdb.nix
+++ b/nixos/modules/services/databases/foundationdb.nix
@@ -4,6 +4,7 @@ with lib;
 
 let
   cfg = config.services.foundationdb;
+  pkg = cfg.package;
 
   # used for initial cluster configuration
   initialIpAddr = if (cfg.publicAddress != "auto") then cfg.publicAddress else "127.0.0.1";
@@ -24,7 +25,7 @@ let
     group         = ${cfg.group}
 
     [fdbserver]
-    command        = ${pkgs.foundationdb}/bin/fdbserver
+    command        = ${pkg}/bin/fdbserver
     public_address = ${cfg.publicAddress}:$ID
     listen_address = ${cfg.listenAddress}
     datadir        = ${cfg.dataDir}/$ID
@@ -36,7 +37,7 @@ let
     storage_memory = ${cfg.storageMemory}
 
     ${optionalString (cfg.tls != null) ''
-      tls_plugin           = ${pkgs.foundationdb}/libexec/plugins/FDBLibTLS.so
+      tls_plugin           = ${pkg}/libexec/plugins/FDBLibTLS.so
       tls_certificate_file = ${cfg.tls.certificate}
       tls_key_file         = ${cfg.tls.key}
       tls_verify_peers     = ${cfg.tls.allowedPeers}
@@ -50,7 +51,7 @@ let
     ${fdbServers cfg.serverProcesses}
 
     [backup_agent]
-    command = ${pkgs.foundationdb}/libexec/backup_agent
+    command = ${pkg}/libexec/backup_agent
     ${backupAgents cfg.backupProcesses}
   '';
 in
@@ -59,6 +60,14 @@ in
 
     enable = mkEnableOption "FoundationDB Server";
 
+    package = mkOption {
+      type        = types.package;
+      description = ''
+        The FoundationDB package to use for this server. This must be specified by the user
+        in order to ensure migrations and upgrades are controlled appropriately.
+      '';
+    };
+
     publicAddress = mkOption {
       type        = types.str;
       default     = "auto";
@@ -314,7 +323,7 @@ in
     meta.doc         = ./foundationdb.xml;
     meta.maintainers = with lib.maintainers; [ thoughtpolice ];
 
-    environment.systemPackages = [ pkgs.foundationdb ];
+    environment.systemPackages = [ pkg ];
 
     users.extraUsers = optionalAttrs (cfg.user == "foundationdb") (singleton
       { name        = "foundationdb";
@@ -368,7 +377,7 @@ in
           ReadWritePaths        = lib.concatStringsSep " " (map (x: "-" + x) rwpaths);
         };
 
-      path = [ pkgs.foundationdb pkgs.coreutils ];
+      path = [ pkg pkgs.coreutils ];
 
       preStart = ''
         rm -f ${cfg.pidfile}   && \
diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml
index 045193f4b75b..def9cc436691 100644
--- a/nixos/modules/services/databases/foundationdb.xml
+++ b/nixos/modules/services/databases/foundationdb.xml
@@ -12,7 +12,7 @@
 
 <para><emphasis>Maintainer:</emphasis> Austin Seipp</para>
 
-<para><emphasis>Default version:</emphasis> 5.1.x</para>
+<para><emphasis>Available version(s):</emphasis> 5.1.x</para>
 
 <para>FoundationDB (or "FDB") is a distributed, open source, high performance,
 transactional key-value store. It can store petabytes of data and deliver
@@ -26,9 +26,17 @@ exceptional performance while maintaining consistency and ACID semantics
 
 <programlisting>
 services.foundationdb.enable = true;
+services.foundationdb.package = pkgs.foundationdb51; # FoundationDB 5.1.x
 </programlisting>
 </para>
 
+<para>The <option>services.foundationdb.package</option> option is required,
+and must always be specified. Because FoundationDB network protocols and
+on-disk storage formats may change between (major) versions, and upgrades must
+be explicitly handled by the user, you must always manually specify this
+yourself so that the NixOS module will use the proper version. Note that minor,
+bugfix releases are always compatible.</para>
+
 <para>After running <command>nixos-rebuild</command>, you can verify whether
 FoundationDB is running by executing <command>fdbcli</command> (which is added
 to <option>environment.systemPackages</option>):
diff --git a/pkgs/servers/foundationdb/default.nix b/pkgs/servers/foundationdb/default.nix
index 3397c2ba386e..b1745dd53716 100644
--- a/pkgs/servers/foundationdb/default.nix
+++ b/pkgs/servers/foundationdb/default.nix
@@ -1,103 +1,131 @@
 { stdenv, fetchurl, fetchFromGitHub
-, which, findutils, m4, gawk, python, openjdk, mono58, libressl_2_6
+, which, findutils, m4, gawk
+, python, openjdk, mono58, libressl_2_6
+, boost16x
 }:
 
 let
-  version = "5.1.7";
-  branch  = "release-5.1";
-  rev     = "9ad8d02386d4a6a5efecf898df80f2747695c627";
-  sha256  = "1rc472ih24f9s5g3xmnlp3v62w206ny0pvvw02bzpix2sdrpbp06";
+  makeFdb =
+    { version
+    , branch
+    , rev, sha256
 
-  # hysterical raisins dictate a version of boost this old. however,
-  # we luckily do not need to build anything, we just need the header
-  # files.
-  boost152 = stdenv.mkDerivation rec {
-    name = "boost-headers-1.52.0";
+    # fdb 6.0+ support boost 1.6x+, so default to it
+    , boost ? boost16x
+    }: stdenv.mkDerivation rec {
+        name = "foundationdb-${version}";
+        inherit version;
 
-    src = fetchurl {
-      url = "mirror://sourceforge/boost/boost_1_52_0.tar.bz2";
-      sha256 = "14mc7gsnnahdjaxbbslzk79rc0d12h1i681cd3srdwr3fzynlar2";
-    };
+        src = fetchFromGitHub {
+          owner = "apple";
+          repo  = "foundationdb";
+          inherit rev sha256;
+        };
 
-    buildPhase = ":";
-    configurePhase = ":";
-    installPhase = ''
-      mkdir -p $out/include/
-      cp -R boost $out/include/
-    '';
-  };
+        nativeBuildInputs = [ gawk which m4 findutils mono58 ];
+        buildInputs = [ python openjdk libressl_2_6 boost ];
 
-in stdenv.mkDerivation rec {
-  name = "foundationdb-${version}";
-  inherit version;
+        patches =
+          [ ./fix-scm-version.patch
+            ./ldflags.patch
+          ];
 
-  src = fetchFromGitHub {
-    owner = "apple";
-    repo  = "foundationdb";
-    inherit rev sha256;
-  };
+        postPatch = ''
+          substituteInPlace ./build/scver.mk \
+            --subst-var-by NIXOS_FDB_VERSION_ID "${rev}" \
+            --subst-var-by NIXOS_FDB_SCBRANCH   "${branch}"
 
-  nativeBuildInputs = [ gawk which m4 findutils boost152 mono58 ];
-  buildInputs = [ python openjdk libressl_2_6 ];
+          substituteInPlace ./Makefile \
+            --replace 'shell which ccache' 'shell true' \
+            --replace -Werror ""
 
-  patches =
-    [ ./fix-scm-version.patch
-      ./ldflags.patch
-    ];
+          substituteInPlace ./Makefile \
+            --replace libstdc++_pic libstdc++
 
-  postPatch = ''
-    substituteInPlace ./build/scver.mk \
-      --subst-var-by NIXOS_FDB_VERSION_ID "${rev}" \
-      --subst-var-by NIXOS_FDB_SCBRANCH   "${branch}"
+          substituteInPlace ./build/link-validate.sh \
+            --replace 'exit 1' '#exit 1'
 
-    substituteInPlace ./Makefile \
-      --replace 'shell which ccache' 'shell true' \
-      --replace -Werror ""
+          patchShebangs .
+        '';
 
-    substituteInPlace ./Makefile \
-      --replace libstdc++_pic libstdc++
+        enableParallelBuilding = true;
+        makeFlags = [ "all" "fdb_c" "fdb_java" "KVRELEASE=1" ];
 
-    substituteInPlace ./build/link-validate.sh \
-      --replace 'exit 1' '#exit 1'
+        configurePhase = ":";
+        installPhase = ''
+          mkdir -vp $out/{bin,libexec/plugins} $lib/{lib,share/java} $dev/include/foundationdb
 
-    patchShebangs .
-  '';
+          cp -v ./lib/libfdb_c.so     $lib/lib
+          cp -v ./lib/libfdb_java.so  $lib/lib
 
-  enableParallelBuilding = true;
-  makeFlags = [ "all" "fdb_c" "fdb_java" "KVRELEASE=1" ];
+          cp -v ./lib/libFDBLibTLS.so $out/libexec/plugins/FDBLibTLS.so
 
-  configurePhase = ":";
-  installPhase = ''
-    mkdir -vp $out/{bin,libexec/plugins} $lib/{lib,share/java} $dev/include/foundationdb
+          cp -v ./bindings/c/foundationdb/fdb_c.h           $dev/include/foundationdb
+          cp -v ./bindings/c/foundationdb/fdb_c_options.g.h $dev/include/foundationdb
 
-    cp -v ./lib/libfdb_c.so     $lib/lib
-    cp -v ./lib/libfdb_java.so  $lib/lib
+          cp -v ./bindings/java/foundationdb-client.jar     $lib/share/java
 
-    cp -v ./lib/libFDBLibTLS.so $out/libexec/plugins/FDBLibTLS.so
+          for x in fdbbackup fdbcli fdbserver fdbmonitor; do
+            cp -v "./bin/$x" $out/bin;
+          done
 
-    cp -v ./bindings/c/foundationdb/fdb_c.h           $dev/include/foundationdb
-    cp -v ./bindings/c/foundationdb/fdb_c_options.g.h $dev/include/foundationdb
+          ln -sfv $out/bin/fdbbackup $out/bin/dr_agent
+          ln -sfv $out/bin/fdbbackup $out/bin/fdbrestore
+          ln -sfv $out/bin/fdbbackup $out/bin/fdbdr
 
-    cp -v ./bindings/java/foundationdb-client.jar     $lib/share/java
+          ln -sfv $out/bin/fdbbackup $out/libexec/backup_agent
+        '';
 
-    for x in fdbbackup fdbcli fdbserver fdbmonitor; do
-      cp -v "./bin/$x" $out/bin;
-    done
+        outputs = [ "out" "lib" "dev" ];
 
-    ln -sfv $out/bin/fdbbackup $out/bin/dr_agent
-    ln -sfv $out/bin/fdbbackup $out/bin/fdbrestore
-    ln -sfv $out/bin/fdbbackup $out/bin/fdbdr
+        meta = with stdenv.lib; {
+          description = "Open source, distributed, transactional key-value store";
+          homepage    = https://www.foundationdb.org;
+          license     = licenses.asl20;
+          platforms   = platforms.linux;
+          maintainers = with maintainers; [ thoughtpolice ];
+       };
+    };
 
-    ln -sfv $out/bin/fdbbackup $out/libexec/backup_agent
-  '';
+  # hysterical raisins dictate a version of boost this old. however,
+  # we luckily do not need to build anything, we just need the header
+  # files.
+  boost152 = stdenv.mkDerivation rec {
+    name = "boost-headers-1.52.0";
+
+    src = fetchurl {
+      url = "mirror://sourceforge/boost/boost_1_52_0.tar.bz2";
+      sha256 = "14mc7gsnnahdjaxbbslzk79rc0d12h1i681cd3srdwr3fzynlar2";
+    };
+
+    configurePhase = ":";
+    buildPhase = ":";
+    installPhase = "mkdir -p $out/include && cp -R boost $out/include/";
+  };
+
+in with builtins; {
 
-  outputs = [ "out" "lib" "dev" ];
+  foundationdb51 = makeFdb {
+    version = "5.1.7";
+    branch  = "release-5.1";
+    rev     = "9ad8d02386d4a6a5efecf898df80f2747695c627";
+    sha256  = "1rc472ih24f9s5g3xmnlp3v62w206ny0pvvw02bzpix2sdrpbp06";
+    boost   = boost152;
+  };
+
+  foundationdb52 = makeFdb rec {
+    version = "5.2.0pre1488_${substring 0 8 rev}";
+    branch  = "master";
+    rev     = "18f345487ed8d90a5c170d813349fa625cf05b4e";
+    sha256  = "0mz30fxj6q99cvjzg39s5zm992i6h2l2cb70lc58bdhsz92dz3vc";
+    boost   = boost152;
+  };
 
-  meta = with stdenv.lib; {
-    description = "Open source, distributed, transactional key-value store";
-    homepage    = https://www.foundationdb.org;
-    license     = licenses.asl20;
-    platforms   = platforms.linux;
-    maintainers = with maintainers; [ thoughtpolice ];
+  foundationdb60 = makeFdb rec {
+    version = "6.0.0pre1636_${substring 0 8 rev}";
+    branch  = "master";
+    rev     = "1265a7b6d5e632dd562b3012e70f0727979806bd";
+    sha256  = "0z1i5bkbszsbn8cc48rlhr29m54n2s0gq3dln0n7f97gf58mi5yf";
   };
+
 }
diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix
index df7e97e4f226..11f0d4ae4239 100644
--- a/pkgs/top-level/all-packages.nix
+++ b/pkgs/top-level/all-packages.nix
@@ -2421,6 +2421,13 @@ with pkgs;
 
   fuseiso = callPackage ../tools/filesystems/fuseiso { };
 
+  fdbPackages = callPackage ../servers/foundationdb { stdenv = overrideCC stdenv gcc49; };
+
+  inherit (fdbPackages)
+    foundationdb51
+    foundationdb52
+    foundationdb60;
+
   foundationdb = callPackage ../servers/foundationdb { stdenv = overrideCC stdenv gcc49; };
 
   fuse-7z-ng = callPackage ../tools/filesystems/fuse-7z-ng { };