Release-as-Knowledge · Manifesto v1

Release
as Knowledge

Ship knowledge with the artifact, not just the binary · R2K v1

The past decade pipelined our code — git, CI/CD, registries, helm. The next decade will pipeline everything around code.

"

The knowledge in your team's heads ships when a new version goes out ──
but that knowledge does not travel with the image.

The R2K Thesis

Adoption Path

The 4-Step Path

From "ship a binary" to "ship knowledge" — R2K v1 unfolds as four incrementally-adoptable steps. Each has its own tooling and validation.

STEP 1

LABEL

Identify · 5 lines of Dockerfile

Attach OCI standard labels (org.opencontainers.image.*) and R2K labels (com.releaseasknowledge.*) to declare release identity.

STEP 2

Snapshot

Trust · automated collection

At build time, dump OpenAPI / DB schema / config / SBOM into /r2k/, with /r2k/index.yaml as the entry index.

STEP 3

Diff

Understand · plugin SPI

Diff two releases' snapshots across assets, producing a unified change.yaml. One plugin per asset class.

STEP 4

Insight

Share · cross-asset correlation

Correlate diffs across assets into risk insight. Plug in LLMs, rule engines, or policy-as-code; emit an R2K badge.

The Manifesto

Eight Principles

R2K is not a product. Not a tool. Not a vendor. It is a thesis with eight principles — a description of how software releases should work, and rarely do.

01

Artifact carries facts, not intelligence

The OCI image stores L1 (LABEL) + L2 (snapshots: API spec, DB schema, config) — these are facts. L3 (Change Manifest) is intelligence — computed from facts, not baked into the image.

git: commits store snapshots; diffs are computed.
SBOM: stores component lists; vulnerability scans are computed.
R2K does to OCI images what git does to source code.

02

Knowledge ships with the artifact

API spec, config schema, migration plan, SBOM should ship, version, and circulate alongside the image — collected automatically at build time, not written by hand after the fact.

03

Implicit must become explicit

Knowledge like "which API broke", "which migration is dangerous", "which config is now required" cannot live in engineers' heads or PR descriptions. It must be structurally extracted at build time and made machine-readable.

04

Standards over invention

Use OCI Referrers when you can. Use CycloneDX when you can. Use OpenAPI when you can. R2K integrates the outputs of existing industry tools — it does not reinvent them.

05

Designed for non-developers

R2K serves support, sales, customer DevOps, auditors, and compliance teams — not developers (who already have git, PRs, Slack). Every output assumes the reader cannot read code or git logs.

06

Layered by query frequency

High-frequency lightweight queries (version, case_type) use LABEL indexes (~50ms). Low-frequency heavy queries (SBOM, test report) use metadata layers (~300ms). Full deep queries use the Change Manifest.

07

Compatible with existing pipelines

R2K does not require a CI/CD rewrite. Start with 5 lines of Dockerfile at Level 1 — every level has independent value, adoption is incremental.

08

Manifests are the lingua franca

Change Manifest, License Manifest, Network Contract — structured yaml/json bridges tools, organizations, and human/machine readability. More precise than release notes, more current than wikis, more traceable than Slack threads.

Compliance Tiers

Four Levels

Like SLSA, R2K is adopted gradually. Each level stands alone — "We are R2K Level 2" is as legitimate as "We are SLSA Level 3".

L1 · IDENTIFY

Identity · Identify

Docker LABEL · build-arg

All production images carry OCI standard labels (org.opencontainers.image.*) plus the R2K namespace (com.releaseasknowledge.*); any scanner reads them in milliseconds.

Cost1–2 weeks
Win90% queries instant
L2 · TRUST

State · Trust

/r2k/* snapshots · index.yaml

+ OpenAPI, DB schema, config, SBOM, and runtime manifest baked into /r2k/, with index.yaml listing every asset and its sha256 for tamper detection.

Cost2–3 weeks
WinAudit in real time
L3 · UNDERSTAND

Change · Understand

change.yaml · diff plugin SPI

+ Unified change.yaml across API/DB/Config/SBOM. L3 is derived intelligence — computed from L1+L2; Mode A pre-computed / Mode B on-demand (see below).

Cost6–8 weeks
Win30 min → 5 sec
L4 · SHARE

Distribution · Share

OCI Referrers · badge · cross-org

+ Fully OCI 1.1, R2K artifacts travel across organizations, customer-side reads them offline, and an R2K badge (Level + Mode) is published.

Cost4 weeks
WinCustomers + sales onboard
In One Line

L1 = Identify · L2 = Trust · L3 = Understand · L4 = Share

Turns "shipping software" into "shipping interpretable change intelligence".

L3 AB Plan

Two Modes for L3

L3 is derived intelligence — but when it gets derived has two legitimate options. R2K v1 introduces Mode A / Mode B so the same spec serves air-gap ISVs and SaaS vendors alike.

MODE A

Pre-computed

Computed in CI · attached to image

CI computes the Change Manifest ahead of time and attaches it to the image. Customer side needs no Diff Engine service.

  • Manifest ships with the image
  • CI default: from = previous version
  • Customer reads stored manifest

Fit Air-gap on-prem ISVs; customer DevOps cannot reach back to vendor

Cost from→to pair is locked; rule upgrades require rebuild

MODE B

On-demand

Computed at query time

CI attaches only L1+L2 snapshots; the Diff Engine computes at query time. Any from→to combination is queryable.

  • Manifest not in the image (cacheable)
  • Old images auto-benefit from rule upgrades
  • Diff Engine service must be hosted

Fit SaaS, connected enterprise, open-source tools

Cost First query slightly slower (cacheable); host the Diff Engine

Recommended

Both modes side by side

For major releases, ship both: Mode A's default-pair manifest baked into the image (so air-gap customers can use it directly), and L2 snapshots kept complete (so connected customers can recompute any other combination via Mode B). The underlying mechanism is identical — what differs is when the manifest is computed.

Trade-off matrix

DimensionMode AMode BBoth
Air-gap friendly✓ Perfect✗ Service required
Arbitrary from→to✗ Locked✓ Full
Auto-benefit from rule updates✗ Needs rebuild✓ Automatic△ Partial
CI integration complexity✓ Simple✓ Simple△ Medium
Customer-side complexity✓ Simple△ Connection required△ Path-dependent
Best forISV / on-premSaaSHybrid

R2K as a framework does not prescribe which — but Principle 1 (facts vs intelligence) makes both modes legitimate. The choice depends on whether your customer side can reach your service.

Distinction

What R2K Isn't

Clear boundaries make a thesis useful. R2K overlaps with several existing concepts but solves a different problem.

vs.
That concept solves...
R2K solves...
SBOM
Software bill of materials — primarily for security & compliance teams.
SBOM is a subset of R2K (contained in L2). R2K covers more dimensions and targets non-developers.
SLSA
How this image was built and whether it was tampered with — supply chain security.
What this image means for users — change communication.
Release Notes
A human-written narrative byproduct, for human readers to skim.
An automated, structured, machine-readable primary artifact — release notes are derived from it.
Documentation
Hand-written; perpetually out of sync with the version it claims to describe.
Ships with the image and stays in sync; produced automatically at build time.
Helm Chart
A declarative deploy spec — tells you "how to deploy".
A descriptive release manifest — tells you "what changed in this release".
Reading List

Articles to Share

Want to go deeper into R2K? Here's a curated reading list — spec, narrative essays, and platform-specific re-tellings. Cite freely, share widely, push back hard.

Page 1 of 1
Author

Written By

Ted Enjtorian
R2K Framework Observer · Primary Author

A software systems architect with 20+ years of experience. Watched CI/CD, containers, SBOM, OpenAPI, and observability each mature into their own standards over the past decade — but one thing was never formalized: "What changed in this release, and what does it mean?"

R2K's design intent is not to invent new tools, but to name a semantic layer that already exists implicitly in every production system — integrating existing standards (OCI, CycloneDX, OpenAPI, Atlas …) and cleanly separating facts (L1+L2) from intelligence (L3+L4).

Get Involved

Five Ways to Join

A manifesto without action is decoration. Pick the path that fits where you are right now.