feat: a stated choice must reach a requirement, and only pinned providers (iteration 9 step 3)
Some checks failed
validation / verify (push) Failing after 11s
Some checks failed
validation / verify (push) Failing after 11s
Case 08 named the customer's stated topology in its design and did not build it; every Check passed because none asked for it. - The catalogue marks the 26 fields that bind a design. The agreed scope lists the ones the customer stated; what was assumed for them does not bind. - A requirement says what it comes from. A submission of requirements is refused when one of the customer's own requirements, or a stated binding field, is named by none, or when the requirement carrying a choice is not a constraint with a condition. The existing chain then owes it a Check. - Generated code may use only the providers the bundle pins: a resource or a required_providers entry of any other is refused before Terraform runs. - The guide opens with how much of the design the customer stated, how much was assumed and how much is unknown. Not run with real models. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -37,6 +37,19 @@ Every non-functional requirement lists its `conditions`: one entry for each sepa
|
||||
|
||||
`kind` is `functional` or `non_functional`. Write one requirement per entry, so each can be checked on its own.
|
||||
|
||||
When the customer's scope is in your context, a requirement says what it comes from in `from`: the ids of the customer's own requirements, and the scope fields it carries.
|
||||
|
||||
```json
|
||||
{"id": "NFR-4", "kind": "non_functional",
|
||||
"text": "The network is a hub with spokes, joined to on-premises over a private 10Gbps connection.",
|
||||
"conditions": ["A hub network is connected to every spoke network.", "A dedicated 10Gbps connection joins the hub to on-premises."],
|
||||
"from": ["REQ-03", "networking.topology", "networking.hybrid_connectivity.type", "networking.hybrid_connectivity.bandwidth_gbps"]}
|
||||
```
|
||||
|
||||
- Every requirement the customer wrote (`scope.stated.intent.requirements`) is named in the `from` of the requirement that covers it.
|
||||
- Every field under `scope.binding` is a choice the customer stated that the design must honour. Each is named in the `from` of a non-functional requirement with at least one condition that shows it was honoured. Write the condition about what must exist or be set, in terms a Check can verify: "a hub network is connected to every spoke network", not "the topology is hub and spoke".
|
||||
- One requirement may carry several fields that belong together. A submission is refused while any is carried by none.
|
||||
|
||||
### `components.json` (technical decomposition)
|
||||
|
||||
A list of components and the requirement ids each serves. Every functional requirement must be served by at least one component.
|
||||
|
||||
@@ -5,7 +5,8 @@
|
||||
# before any work), important (asked when someone is present) or optional. A tier
|
||||
# may differ by the kind of engagement. `question` is what to ask the customer for
|
||||
# it. `default` guides the choice when the customer says "decide". `affects` says
|
||||
# what a wrong assumption would change.
|
||||
# what a wrong assumption would change. `binds: true` marks a choice a design must
|
||||
# honour: stated by the customer, it has to reach a requirement and its Checks.
|
||||
#
|
||||
# This catalogue names no Cloud provider. A provider's bundle adds allowed values
|
||||
# for the fields marked `provider_values`.
|
||||
@@ -66,15 +67,18 @@ fields:
|
||||
tier: essential
|
||||
question: Is this a new estate, an extension of an existing one, or a migration?
|
||||
estate.regions.primary:
|
||||
binds: true
|
||||
type: string
|
||||
tier: essential
|
||||
question: Which region should it run in?
|
||||
estate.regions.secondary:
|
||||
binds: true
|
||||
type: string
|
||||
question: Is there a second region, and which?
|
||||
default: None, unless availability or recovery targets need one.
|
||||
affects: resilience design and cost
|
||||
estate.regions.resiliency_tier:
|
||||
binds: true
|
||||
type: enum
|
||||
values: [single_region, warm_standby, active_active]
|
||||
tier: important
|
||||
@@ -82,6 +86,7 @@ fields:
|
||||
default: single_region
|
||||
affects: resilience design and cost
|
||||
estate.data_residency:
|
||||
binds: true
|
||||
type: string
|
||||
tier: essential
|
||||
question: Where must data stay?
|
||||
@@ -108,6 +113,7 @@ fields:
|
||||
default: A tenth of the user count.
|
||||
affects: scaling limits and cost
|
||||
workload.availability.target:
|
||||
binds: true
|
||||
type: string
|
||||
tier: {workload: essential, migration: essential, platform_foundation: important}
|
||||
question: What availability is required, as a percentage?
|
||||
@@ -121,12 +127,14 @@ fields:
|
||||
default: always
|
||||
affects: scaling to zero and support
|
||||
workload.availability.recovery_time:
|
||||
binds: true
|
||||
type: string
|
||||
tier: important
|
||||
question: How quickly must it recover from a failure?
|
||||
default: 4 hours
|
||||
affects: backup and standby design
|
||||
workload.availability.recovery_point:
|
||||
binds: true
|
||||
type: string
|
||||
tier: important
|
||||
question: How much recent data may be lost in a failure?
|
||||
@@ -137,15 +145,18 @@ fields:
|
||||
type: string
|
||||
question: "Which industry is the customer in?"
|
||||
compliance.frameworks:
|
||||
binds: true
|
||||
type: list
|
||||
tier: essential
|
||||
question: Which regulations or standards apply? An empty list if none.
|
||||
compliance.data_classification:
|
||||
binds: true
|
||||
type: enum
|
||||
values: [public, internal, confidential, restricted]
|
||||
tier: essential
|
||||
question: How sensitive is the data?
|
||||
compliance.encryption.type:
|
||||
binds: true
|
||||
type: enum
|
||||
values: [provider_managed, customer_managed]
|
||||
provider_values: true
|
||||
@@ -154,21 +165,25 @@ fields:
|
||||
default: provider_managed
|
||||
affects: key management design
|
||||
compliance.encryption.key_rotation_days:
|
||||
binds: true
|
||||
type: integer
|
||||
question: How often must keys rotate, in days?
|
||||
default: 90
|
||||
compliance.audit_logging.retention_days:
|
||||
binds: true
|
||||
type: integer
|
||||
tier: important
|
||||
question: How long must audit logs be kept, in days?
|
||||
default: 365
|
||||
affects: storage cost and log design
|
||||
compliance.audit_logging.immutable_retention_policy:
|
||||
binds: true
|
||||
type: boolean
|
||||
question: Must audit logs be undeletable for that time?
|
||||
default: false
|
||||
|
||||
networking.exposure:
|
||||
binds: true
|
||||
type: enum
|
||||
values: [internal_only, internet_facing]
|
||||
tier: important
|
||||
@@ -176,6 +191,7 @@ fields:
|
||||
default: internal_only
|
||||
affects: perimeter design
|
||||
networking.topology:
|
||||
binds: true
|
||||
type: enum
|
||||
provider_values: true
|
||||
tier: {platform_foundation: important}
|
||||
@@ -183,28 +199,34 @@ fields:
|
||||
default: The simplest topology that meets the requirements.
|
||||
affects: the whole network design
|
||||
networking.hybrid_connectivity.enabled:
|
||||
binds: true
|
||||
type: boolean
|
||||
tier: {platform_foundation: important, migration: important}
|
||||
question: Must it connect privately to on-premises or another cloud?
|
||||
default: false
|
||||
affects: network design and lead time
|
||||
networking.hybrid_connectivity.type:
|
||||
binds: true
|
||||
type: enum
|
||||
provider_values: true
|
||||
question: By what kind of connection?
|
||||
networking.hybrid_connectivity.bandwidth_gbps:
|
||||
binds: true
|
||||
type: number
|
||||
question: At what bandwidth, in Gbps?
|
||||
networking.egress_control.model:
|
||||
binds: true
|
||||
type: enum
|
||||
values: [direct, provider_managed, centralized_appliance]
|
||||
question: How must traffic to the internet be controlled?
|
||||
default: provider_managed
|
||||
affects: network design and cost
|
||||
networking.egress_control.appliance_vendor:
|
||||
binds: true
|
||||
type: string
|
||||
question: Which inspection appliance, if one is mandated?
|
||||
networking.cidr_allocations:
|
||||
binds: true
|
||||
type: text
|
||||
tier: {platform_foundation: important}
|
||||
question: Which IP ranges are allocated, and how large per environment?
|
||||
@@ -212,16 +234,19 @@ fields:
|
||||
affects: every network resource
|
||||
|
||||
governance.identity_source_of_truth:
|
||||
binds: true
|
||||
type: string
|
||||
tier: important
|
||||
question: Which identity provider do people sign in with?
|
||||
default: The Cloud provider's own identities.
|
||||
affects: access design
|
||||
governance.pipeline_authentication:
|
||||
binds: true
|
||||
type: string
|
||||
question: How do delivery pipelines authenticate?
|
||||
default: Short-lived federated credentials, no stored keys.
|
||||
governance.environment_tiers:
|
||||
binds: true
|
||||
type: records
|
||||
keys: [name]
|
||||
optional_keys: [archetype]
|
||||
@@ -294,10 +319,12 @@ fields:
|
||||
default: "USD"
|
||||
|
||||
constraints.products_required:
|
||||
binds: true
|
||||
type: list
|
||||
question: Which products has the customer mandated?
|
||||
default: None.
|
||||
constraints.products_forbidden:
|
||||
binds: true
|
||||
type: list
|
||||
question: Which products are ruled out?
|
||||
default: None.
|
||||
|
||||
Reference in New Issue
Block a user