public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/manual: wordsmithing on fdb chapter

Browse Source 
Signed-off-by: Austin Seipp <aseipp@pobox.com>
This commit is contained in:
Austin Seipp 2018-08-05 00:51:30 -05:00
parent 78e2e32972
commit d5eccebda5
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
nixos/modules/services/databases/foundationdb.xml
View File

@ -14,10 +14,8 @@
<para><emphasis>Available version(s):</emphasis> 5.1.x, 5.2.x, 6.0.x</para> <para><emphasis>Available version(s):</emphasis> 5.1.x, 5.2.x, 6.0.x</para>
<para>FoundationDB (or "FDB") is a distributed, open source, high performance, <para>FoundationDB (or "FDB") is an open source, distributed, transactional
transactional key-value store. It can store petabytes of data and deliver key-value store.</para>
exceptional performance while maintaining consistency and ACID semantics
(serializable transactions) over a large cluster.</para>
<section><title>Configuring and basic setup</title> <section><title>Configuring and basic setup</title>
@ -31,7 +29,7 @@ services.foundationdb.package = pkgs.foundationdb52; # FoundationDB 5.2.x
</para> </para>
<para>The <option>services.foundationdb.package</option> option is required, <para>The <option>services.foundationdb.package</option> 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 on-disk storage formats may change between (major) versions, and upgrades must
be explicitly handled by the user, you must always manually specify this 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, yourself so that the NixOS module will use the proper version. Note that minor,
@ -70,18 +68,17 @@ fdb>
</programlisting> </programlisting>
</para> </para>
<para>You can also now write programs using the available client libraries. <para>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, For example, the following Python program can be run in order to grab the
as a quick example. (This example uses <command>nix-shell</command> shebang cluster status, as a quick example. (This example uses
support to automatically supply the necessary Python modules). <command>nix-shell</command> shebang support to automatically supply the
necessary Python modules).
<programlisting> <programlisting>
a@link> cat fdb-status.py a@link> cat fdb-status.py
#! /usr/bin/env nix-shell #! /usr/bin/env nix-shell
#! nix-shell -i python -p python pythonPackages.foundationdb52 #! nix-shell -i python -p python pythonPackages.foundationdb52
from __future__ import print_function
import fdb import fdb
import json import json
@ -340,8 +337,9 @@ only undergone fairly basic testing of all the available functionality.</para>
<para>NixOS's FoundationDB module allows you to configure all of the most <para>NixOS's FoundationDB module allows you to configure all of the most
relevant configuration options for <command>fdbmonitor</command>, matching it relevant configuration options for <command>fdbmonitor</command>, matching it
quite closely. For a complete list of all options, check <command>man quite closely. A complete list of options for the FoundationDB module may be
configuration.nix</command>.</para> found <link linkend="opt-services.foundationdb.enable">here</link>. You should
also read the FoundationDB documentation as well.</para>
</section> </section>