481 lines
13 KiB
JSON
481 lines
13 KiB
JSON
{
|
|
"format": 1,
|
|
"seat": "container-image-registry",
|
|
"scope": "mesh",
|
|
"grain": "whole",
|
|
"domain": "Delivery",
|
|
"decision": "novox/hq ADR 0605",
|
|
"description": "The mesh's container images, in the one artifact store: the OCI distribution protocol's read side, an image's tags and mirroring an outside image.",
|
|
"includes": [
|
|
"registry"
|
|
],
|
|
"verbs": [
|
|
{
|
|
"name": "mirror",
|
|
"description": "Copy an outside image into the store by its pinned digest; emits published or refused.",
|
|
"callers": "mesh-build-image's holder of the image build seat",
|
|
"input": {
|
|
"type": "object",
|
|
"properties": {
|
|
"source": {
|
|
"type": "string",
|
|
"description": "the outside image's reference"
|
|
},
|
|
"digest": {
|
|
"type": "string",
|
|
"description": "its pinned digest, sha256:<hex>"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the name it is kept under"
|
|
}
|
|
},
|
|
"required": [
|
|
"source",
|
|
"digest",
|
|
"name"
|
|
]
|
|
},
|
|
"answer": {
|
|
"type": "object",
|
|
"properties": {
|
|
"reference": {
|
|
"type": "string",
|
|
"description": "the reference the seat answers"
|
|
},
|
|
"digest": {
|
|
"type": "string",
|
|
"description": "the digest stored"
|
|
}
|
|
},
|
|
"required": [
|
|
"reference",
|
|
"digest"
|
|
]
|
|
},
|
|
"optional": true
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"description": "The tags of one image and the digest each names.",
|
|
"callers": "any caller whose role grants it",
|
|
"input": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the image"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
]
|
|
},
|
|
"answer": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the image"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tag": {
|
|
"type": "string",
|
|
"description": "the tag"
|
|
},
|
|
"digest": {
|
|
"type": "string",
|
|
"description": "its digest"
|
|
}
|
|
},
|
|
"required": [
|
|
"tag",
|
|
"digest"
|
|
]
|
|
},
|
|
"description": "every tag"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"tags"
|
|
]
|
|
},
|
|
"optional": true
|
|
},
|
|
{
|
|
"name": "hold",
|
|
"description": "Keep one untagged bundle, archive or copied base from removal by retention, as the artifact sweep's rules keep it (ADR 0617 §2); never an image of the holder's own. Emits held.",
|
|
"callers": "the module that runs the artifact sweep alone",
|
|
"input": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the name"
|
|
},
|
|
"digest": {
|
|
"type": "string",
|
|
"description": "the digest"
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "which of the sweep's rules keeps it"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"digest",
|
|
"reason"
|
|
]
|
|
},
|
|
"answer": {
|
|
"type": "object",
|
|
"properties": {
|
|
"held": {
|
|
"type": "boolean",
|
|
"description": "it is held"
|
|
},
|
|
"since": {
|
|
"type": "string",
|
|
"description": "when the hold began, RFC 3339"
|
|
}
|
|
},
|
|
"required": [
|
|
"held"
|
|
]
|
|
},
|
|
"optional": true
|
|
},
|
|
{
|
|
"name": "release",
|
|
"description": "Let a hold go; emits released. A release of what is not held answers released false and emits nothing, never an error: the outcome asked holds already. By hand only through the holder's own tool, the operator's session as the proved caller, recorded as a hand act.",
|
|
"callers": "the module that runs the artifact sweep; the operator's session through the holder's tool",
|
|
"input": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the name"
|
|
},
|
|
"digest": {
|
|
"type": "string",
|
|
"description": "the digest"
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "why it is let go"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"digest",
|
|
"reason"
|
|
]
|
|
},
|
|
"answer": {
|
|
"type": "object",
|
|
"properties": {
|
|
"released": {
|
|
"type": "boolean",
|
|
"description": "a hold was let go; false when there was none"
|
|
}
|
|
},
|
|
"required": [
|
|
"released"
|
|
]
|
|
},
|
|
"optional": true
|
|
},
|
|
{
|
|
"name": "list",
|
|
"description": "What the store holds of one repository, or of every repository the seat holds when none is named: every image manifest and index, each with its digest, whether it is an index (and the manifests an index names), the tags naming it, its size and whether it is held. Read from the store itself, so a manifest no tag names is listed too; it reads only (ADR 0632 §3).",
|
|
"callers": "any caller whose role grants it",
|
|
"input": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the repository, <module>/<artifact>; every repository of the seat when not given"
|
|
}
|
|
}
|
|
},
|
|
"answer": {
|
|
"type": "object",
|
|
"properties": {
|
|
"repositories": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/defs/Repository"
|
|
},
|
|
"description": "each repository named, in order of its name"
|
|
}
|
|
},
|
|
"required": [
|
|
"repositories"
|
|
]
|
|
},
|
|
"optional": true
|
|
}
|
|
],
|
|
"events": [
|
|
{
|
|
"name": "held",
|
|
"body": {
|
|
"$ref": "#/defs/Hold"
|
|
}
|
|
},
|
|
{
|
|
"name": "released",
|
|
"body": {
|
|
"$ref": "#/defs/Hold"
|
|
}
|
|
}
|
|
],
|
|
"family": {
|
|
"name": "container-image-registry.events",
|
|
"max-age-days": 7
|
|
},
|
|
"defs": {
|
|
"Hold": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the name"
|
|
},
|
|
"digest": {
|
|
"type": "string",
|
|
"description": "the digest"
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "why"
|
|
},
|
|
"holder": {
|
|
"type": "string",
|
|
"description": "the module holding the seat"
|
|
},
|
|
"by": {
|
|
"type": "string",
|
|
"description": "the caller the holder proved"
|
|
},
|
|
"at": {
|
|
"type": "string",
|
|
"description": "when, RFC 3339"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"digest",
|
|
"holder"
|
|
],
|
|
"description": "the body of held and released"
|
|
},
|
|
"Repository": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the repository"
|
|
},
|
|
"manifests": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/defs/Listed"
|
|
},
|
|
"description": "each manifest it holds, by digest"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"manifests"
|
|
]
|
|
},
|
|
"Listed": {
|
|
"type": "object",
|
|
"properties": {
|
|
"digest": {
|
|
"type": "string",
|
|
"description": "the manifest's digest, sha256:<hex>"
|
|
},
|
|
"index": {
|
|
"type": "boolean",
|
|
"description": "it is an index, naming a manifest per platform"
|
|
},
|
|
"platforms": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "for an index, the digests of the manifests it names"
|
|
},
|
|
"artifact": {
|
|
"type": "string",
|
|
"description": "for a manifest keeping one bundle or archive, the digest of that blob: what a reference names it by"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "the tags naming it, none for an untagged one"
|
|
},
|
|
"size": {
|
|
"type": "integer",
|
|
"description": "its bytes: its own content and every blob it names"
|
|
},
|
|
"held": {
|
|
"type": "boolean",
|
|
"description": "a hold keeps it from retention"
|
|
}
|
|
},
|
|
"required": [
|
|
"digest",
|
|
"index",
|
|
"size",
|
|
"held"
|
|
]
|
|
}
|
|
},
|
|
"states": [
|
|
{
|
|
"name": "holds",
|
|
"template": "state",
|
|
"history": 1,
|
|
"description": "the bundles, archives and copied bases kept from retention's removal",
|
|
"key-forms": [
|
|
{
|
|
"key": "<seat>.<name>.<digest>",
|
|
"value": {
|
|
"type": "object",
|
|
"description": "one hold: an untagged bundle, archive or copied base kept from retention's removal",
|
|
"properties": {
|
|
"seat": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
},
|
|
"digest": {
|
|
"type": "string"
|
|
},
|
|
"by": {
|
|
"type": "string"
|
|
},
|
|
"why": {
|
|
"type": "string"
|
|
},
|
|
"since": {
|
|
"type": "string",
|
|
"description": "when (RFC 3339 time)"
|
|
}
|
|
},
|
|
"required": [
|
|
"seat",
|
|
"name",
|
|
"kind",
|
|
"digest",
|
|
"by",
|
|
"since"
|
|
]
|
|
},
|
|
"description": "one hold"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "windows",
|
|
"template": "state",
|
|
"history": 1,
|
|
"description": "the direct-write windows, one per caller",
|
|
"key-forms": [
|
|
{
|
|
"key": "<caller>",
|
|
"value": {
|
|
"type": "object",
|
|
"description": "the direct-write window of one caller: open while a node holds it open",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "the caller whose window it is"
|
|
},
|
|
"open": {
|
|
"type": "boolean"
|
|
},
|
|
"holding": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "the nodes holding it open"
|
|
},
|
|
"since": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string",
|
|
"description": "when (RFC 3339 time)"
|
|
},
|
|
"description": "node to when it began to hold"
|
|
},
|
|
"closed": {
|
|
"type": "string",
|
|
"description": "when it last closed (RFC 3339 time)"
|
|
},
|
|
"last_holding": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dropped": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"node": {
|
|
"type": "string"
|
|
},
|
|
"by": {
|
|
"type": "string"
|
|
},
|
|
"why": {
|
|
"type": "string"
|
|
},
|
|
"at": {
|
|
"type": "string",
|
|
"description": "when (RFC 3339 time)"
|
|
}
|
|
},
|
|
"required": [
|
|
"node"
|
|
]
|
|
},
|
|
"description": "retired nodes dropped by hand"
|
|
},
|
|
"why": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "of each node holding the window, why it holds it"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
]
|
|
},
|
|
"description": "one caller's window"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|