From d5eccebda520f6f6f7b155facc343261d06461c1 Mon Sep 17 00:00:00 2001 From: Austin Seipp Date: Sun, 5 Aug 2018 00:51:30 -0500 Subject: [PATCH] nixos/manual: wordsmithing on fdb chapter Signed-off-by: Austin Seipp --- .../services/databases/foundationdb.xml | 24 +++++++++---------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml index 0b305c3fdf18..f4090c492764 100644 --- a/nixos/modules/services/databases/foundationdb.xml +++ b/nixos/modules/services/databases/foundationdb.xml @@ -14,10 +14,8 @@ Available version(s): 5.1.x, 5.2.x, 6.0.x -FoundationDB (or "FDB") is a distributed, open source, high performance, -transactional key-value store. It can store petabytes of data and deliver -exceptional performance while maintaining consistency and ACID semantics -(serializable transactions) over a large cluster. +FoundationDB (or "FDB") is an open source, distributed, transactional +key-value store.
Configuring and basic setup @@ -31,7 +29,7 @@ services.foundationdb.package = pkgs.foundationdb52; # FoundationDB 5.2.x The option is required, -and must always be specified. Because FoundationDB network protocols and +and must always be specified. Due to the fact 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, @@ -70,18 +68,17 @@ fdb> -You can also now write programs using the available client libraries. -For example, the following Python program can be run in order to grab the cluster status, -as a quick example. (This example uses nix-shell shebang -support to automatically supply the necessary Python modules). +You can also write programs using the available client libraries. +For example, the following Python program can be run in order to grab the +cluster status, as a quick example. (This example uses +nix-shell shebang support to automatically supply the +necessary Python modules). a@link> cat fdb-status.py #! /usr/bin/env nix-shell #! nix-shell -i python -p python pythonPackages.foundationdb52 -from __future__ import print_function - import fdb import json @@ -340,8 +337,9 @@ only undergone fairly basic testing of all the available functionality. NixOS's FoundationDB module allows you to configure all of the most relevant configuration options for fdbmonitor, matching it -quite closely. For a complete list of all options, check man -configuration.nix. +quite closely. A complete list of options for the FoundationDB module may be +found here. You should +also read the FoundationDB documentation as well.