diff --git a/morph/README.rst b/morph/README.rst index 6d26a1e52abe1a55ed4ec6bba9a198318ff6f37a..bdfe48454529c0ff13f7b30aa275b5a1726a2096 100644 --- a/morph/README.rst +++ b/morph/README.rst @@ -36,14 +36,17 @@ lib --- This contains Nix library code for defining the grids. -It has all the details of how each type of node in our grid is configured, and does know about morph (so defines deployment.secrets, and has the logic for collecting data defined by other nodes); and defines options (i.e. grid.*) for things specific to how we configure grids (i.e. grid.publicKeyPath), metadata about nodes that we use on other nodes (i.e. grid.monitoringvpnIPv4 which is used to define various things on the monitoring node). -Each top-level module here defines one type of node, with all (or at least most) of the configuration necessary for that node. +It has all the details of how each type of node in our grid is configured. +It knows about morph (so defines ``deployment.secrets`` and has the logic for collecting data defined by other nodes). +It defines options (i.e. ``grid.*``) for things specific to how we configure grids (e.g. ``grid.publicKeyPath``). +It defines metadata about nodes that we use on other nodes (e.g. ``grid.monitoringvpnIPv4`` which is used to define various things on the monitoring node). +Each top-level module here defines one type of node with all (or at least most) of the configuration necessary for that node. grid ---- Specific grid definitions live in subdirectories beneath this directory. -They consist almost exclusively setting options defined in morph/lib (and few options defined elsewhere), and then delegating to the morph/lib modules. +They consist almost exclusively setting options defined in ``morph/lib`` (and few options defined elsewhere) and then delegating to the ``morph/lib`` modules. private-keys ~~~~~~~~~~~~