This commit is contained in:
@@ -92,14 +92,23 @@ A Check is a statement that is true or false of the infrastructure code. Name th
|
||||
|
||||
Split a broad recommendation into several Checks, one per setting. A Check that the validator cannot verify from the code is sent back to you.
|
||||
|
||||
A Check must name a setting its Element's resource type really has. Two similar resource types often differ: a setting of a long-running service may not exist on a batch job. A Check on a setting the resource type lacks is sent back to you.
|
||||
|
||||
The tables of Elements, Relationships and Checks, and the diagram, are written from this file when you submit. Write the graph once, here.
|
||||
|
||||
### `implementation.json` (deployment guidance)
|
||||
|
||||
One entry per Check in the Target architecture, saying where the code satisfies it. `file` is an attached file; `address` is the resource address and argument.
|
||||
|
||||
```json
|
||||
[{"check": "K-1", "file": "terraform/main.tf", "address": "google_cloud_run_v2_service.ingest.ingress"}]
|
||||
[
|
||||
{"check": "K-1", "file": "terraform/main.tf", "address": "google_cloud_run_v2_service.ingest.ingress"},
|
||||
{"check": "K-7", "unimplementable": "google_cloud_run_v2_job has no startup_cpu_boost argument; it exists only on a service."}
|
||||
]
|
||||
```
|
||||
|
||||
When a Check names a setting its resource type does not have, give it an `unimplementable` entry in place of `file` and `address`, saying what the resource type lacks. Write no code for it. The Target architecture is revised before anything is validated.
|
||||
|
||||
Implement every Element, Relationship and Check, and nothing the Target architecture does not ask for. When you believe the Target architecture is wrong or incomplete, say so with `needs_input`; do not quietly build something else.
|
||||
|
||||
### `verdicts.json` (validation results)
|
||||
|
||||
Reference in New Issue
Block a user