Doc system test

registry map

Registry: map

Where artifacts and their versions live, how references between them are pinned at push, and who may push.

domain/

feature

  • Artifact version - One numbered release of an artifact: its own GUID (the version id), an integer version number, images and links.
  • Artifact - One of the four kinds of thing the registry holds: template, processor, plugin, conflict resolver; each owned by a user.
  • Push - cyanprint push: publish a new version of a template, template group, processor, plugin or resolver from cyan.yaml.
  • Search and stats - How artifacts are searched, and what stars, downloads and dependency counts mean.
  • User and API token - A registry account (external id plus username) and the named, revocable API tokens the CLI pushes with.

architecture/

design

  • Registry deployment - How the registry runs: a Helm chart for the API, a separate Helm chart for the migration job, both set by LANDSCAPE.

surface

  • Registry config options - The registry's settings: named option groups (database, cache, storage, auth and more), each with defaults, checked at start.
  • Registry errors - The typed problems the registry returns, as problem-details JSON: validation error, entity not found, unauthorized and others.
  • Registry UI - The web catalog (argon): browse and search the four artifact kinds, see versions and links, manage API tokens.

implementation/

algorithm

  • Registry migrations - How the migration job prepares the database and the file bucket before the registry serves.
  • Reference pinning - How push turns username/name[:version] references into fixed version ids, with a missing or 0 version meaning the latest at push time.
  • Run-time name lookup - How the coordinator turns a processor or plugin name in a Cyan into a version id, staying inside the template's declared versions.