Skip to content

Define and document the OBI v1 support matrix #1757

@MrAlias

Description

@MrAlias

As part of the OBI v1.0 release contract, we need to explicitly define and document which environments are supported.

Today, support expectations are spread across code, docs, tests, and tribal knowledge. That is not sufficient for v1.

Goal

Produce a documented v1 support matrix that clearly states what OBI supports, what is best-effort, and what is out of scope.

Scope

The v1 support matrix should cover at least:

  • Linux kernel support expectations
  • supported CPU architectures
  • supported release artifacts and image platforms
  • supported deployment environments where relevant
  • supported language runtimes and library-version ranges where OBI makes compatibility claims
  • explicitly unsupported or development-only environments

Tasks

  • Define the kernel versions and kernel families that are part of the v1 support contract
  • Define supported CPU architectures for v1
  • Define supported release artifacts and container image platforms
  • Define supported runtime/library compatibility claims that are part of the v1 contract
  • Define which environments are explicitly outside the v1 compatibility contract
  • Document the support matrix in the appropriate user-facing location(s)
  • Link the published support matrix from the v1.0 release epic

Acceptance Criteria

  • A clear v1 support matrix exists in user-facing documentation
  • The matrix distinguishes supported, unsupported, and out-of-contract environments
  • Maintainers agree this matrix is the compatibility baseline for v1.0

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions