. (prepare to publish first draft)

nxd-bom

@@ -18,10 +18,12 @@
 #
 # See COPYING file for full licensing terms.
 # See https://www.nexedi.com/licensing for rationale and options.
-"""Program nxd-bom generates bill of material for a software-release or slapos node
+"""Program nxd-bom generates bill of material for a software-release or slapos node.
 
 Usage: nxd-bom software   <path-to-installed-software>
        nxd-bom node       <slapos deploy-script>
+
+An example of generated bill of material is provided in example/ors-bom.txt .
 """
 
 from __future__ import print_function
@@ -148,6 +150,28 @@ def bom_software(installed_software_path): # -> {} name -> PkgInfo
 
 def bom_node(XXX):
     1/0
+    # TODO bom_node should:
+    #
+    # 1. retrieve list of software that slapos-node brings with itself
+    #    since slapos-node is built via buildout this could be extracted via
+    #    node_software from /opt/slapos/.installed.cfg once we fix slapos-node
+    #    package to preserve that .installed.cfg in the package itself.
+    #
+    # 2. retrieve list of base-OS packages that are installed by https://deploy.rapid.space/slapos
+    #    This can be computed as the difference in between two sets of base-OS packages:
+    #    b) set of base-OS packages after deploy.rapid.space/slapos was run, and
+    #    a) set of base-OS packages after minimal base-OS was installed.
+    #
+    #    this computation could be automated via
+    #    - preparing e.g. Debian 11 minimal chroot via debootstrap,
+    #    - taking snapshot for list of installed packages via `dpkg -l`,
+    #    - then deploying slapos-node in the chroot,
+    #    - taking snapshot for the list of installed package again,
+    #    - and finally computing the difference.
+    #
+    # Please see example/ors-bom.txt for "BOM(slapos-node)", "List of software
+    # that slapos-node brings with itself" and "List of base-OS packages
+    # installed by https://deploy.rapid.space/slapos" sections for what end result could look like.