Package com.eqixiac.equinix.design.record
package com.eqixiac.equinix.design.record
The Design Decision Record: the one document an architect hands to a review board for a
DesignSpec. It chains the design engines (Metro Optimizer, resilience
analysis, growth and value models, deployment plan) and records what was decided, why, on what evidence, and
what would change the decision.
DesignDecisionRecord adr = DesignDecisionRecorder.forSpec(fabric, spec).record();
Files.writeString(Path.of("adr-0007.md"), adr.toMarkdown());
Files.writeString(Path.of("adr-0007.json"), adr.toJson());
// next quarter
DesignDecisionRecord again = DesignDecisionRecorder.forSpec(fabric, spec).record();
System.out.println(DesignDecisionRecord.compare(DesignDecisionRecord.fromJson(saved), again).toMarkdown());
Every section is optional and says when it was skipped or failed and why; one section failing never loses
the record. Results already computed can be supplied (DesignDecisionRecorder.optimization,
DesignDecisionRecorder.resilience, ...) and are rejected when they were computed for another spec.
-
ClassDescriptionWhat changed between two
DesignDecisionRecords, for example the same design re-run a quarter later: the spec, the recommendation and its objective values, the cost, the resilience verdicts and the findings.A Design Decision Record: what was decided for aDesignSpec, why, on what evidence, and what would change the decision.One option on the frontier.The options considered and rejected.One assumption.One workload's estimated availability, under planning assumptions.What one constraint did to the search.The requirements, restated from the spec in words.What the recommended design costs, and where each figure came from.One priced line.The recommended design.An exchange rate a line was converted at.The design priced month by month under the spec's growth, with a term recommendation per item.One item's growth and term decision.How to build and reproduce the design.The frontier option nearest the recommendation.One objective of the recommended design.A deployment plan in brief.What the record rests on.What pins the record's figures.The failure simulation of the recommended design.One finding.Finding severity, most severe first.Every finding, de-duplicated, most severe first.Egress savings of the private path.How firm the decision is.The TCO archetype comparison.The TCO and egress-savings view of the design's main cloud.An N-1 or N-2 verdict.The share of one objective's weight over which the recommendation holds.Produces aDesignDecisionRecord: runs the engines for a spec (Metro Optimizer, then resilience analysis, then the growth and value models where the spec gives enough input, then a deployment plan) and records their results section by section.One section of aDesignDecisionRecord: its content, or why there is none.Whether a section was produced.