diff --git a/docs/architecture/reproducibility/blockdags.rst b/docs/architecture/reproducibility/blockdags.rst index c6d866bc6..84f57b932 100644 --- a/docs/architecture/reproducibility/blockdags.rst +++ b/docs/architecture/reproducibility/blockdags.rst @@ -7,7 +7,17 @@ The fundamental primitive powering workflow signatures are Merkle trees and Bloc acyclic graphs (BlockDAGs). These data structures cryptographically compress provenance and structural information. We describe the primitives of our approach and then their combination. -The most relevant code directory is found under ``dlg.common.reproducibility`` +The most relevant code directory is found under ``dlg.common.reproducibility``. + +Provenance data is stored internally within the graph data-structure throughout translation and execution. + +In the logical graph structure (dictionary) this information is keyed under 'reprodata'. +In the physical graph (template) structure this information is appended to the end of the droplist. + +Following graph execution, the reprodata is written to a log file, alongside the associated execution logs ($DLG_ROOT/logs). + +If the specified rmode is 'NOTHING', no reprodata is appended at any stage in translation and execution. + Merkle Trees ------------ diff --git a/docs/architecture/reproducibility/rmodes.rst b/docs/architecture/reproducibility/rmodes.rst index f5378f41d..fbf523bb1 100644 --- a/docs/architecture/reproducibility/rmodes.rst +++ b/docs/architecture/reproducibility/rmodes.rst @@ -7,10 +7,14 @@ Each drop's provenance information defines what a workflow signature claims. Inspired and extending current workflow literature, we define seven R-modes. R-mode selection occurs when submitting a workflow to |daliuge| for initial filling and unrolling; |daliuge| handles everything else automatically. + Additionally, the ALL mode will generate a signature structure containing separate hash graphs for all supported modes, which is a good choice when experimenting with new workflow concepts or certifying a particular workflow version. +Conversely, the NOTHING option avoids all provenance collection and processing, which may be of performance interest. +For now, this is also the default option if no rmode is specified. + Rerunning --------- A workflow reruns another if they execute the same logical workflow; their logical components and @@ -75,4 +79,4 @@ A total replica repeats and reproduces a workflow execution. Total replicas allow for independent verification of results, adding direct credibility to results coming from a workflow. Moreover, if a workflow's original deployment environment is unavailable, a total replica is -the most robust assertion possibly placed on a workflow. \ No newline at end of file +the most robust assertion possibly placed on a workflow.