Skip to content

Document the supported platforms #1305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ProbstDJakob wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the supported platforms #1305

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 25 additions & 13 deletions image-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
- **`architecture`** *string*

This REQUIRED property specifies the CPU architecture.
Image indexes SHOULD use, and implementations SHOULD understand, values listed in the Go Language document for [`GOARCH`][go-environment2].
Image indexes SHOULD use, and implementations SHOULD understand, `architecture` values listed in the [Platforms section](#platforms) table.

- **`os`** *string*

This REQUIRED property specifies the operating system.
Image indexes SHOULD use, and implementations SHOULD understand, values listed in the Go Language document for [`GOOS`][go-environment2].
Comment thread
ProbstDJakob marked this conversation as resolved.
Image indexes SHOULD use, and implementations SHOULD understand, `os` values listed in the [Platforms sections](#platforms) table.

- **`os.version`** *string*

Expand All @@ -82,7 +82,7 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
- **`variant`** *string*

This OPTIONAL property specifies the variant of the CPU.
Image indexes SHOULD use, and implementations SHOULD understand, `variant` values listed in the [Platform Variants](#platform-variants) table.
Image indexes SHOULD use, and implementations SHOULD understand, `variant` values listed in the [Platforms section](#platforms) table.

- **`features`** *array of strings*

Expand All @@ -102,18 +102,30 @@ For the media type(s) that this document is compatible with, see the [matrix][ma

See [Pre-Defined Annotation Keys](annotations.md#pre-defined-annotation-keys).

## Platform Variants
## Platforms

When the variant of the CPU is not listed in the table, values are implementation-defined and SHOULD be submitted to this specification for standardization.
The following table lists the platforms which SHOULD be used by image indexes and implementations SHOULD understand those.
When the combination of architecture, variant, and os is not listed in the table, values are implementation-defined and SHOULD be submitted to this specification for standardization.
These values SHOULD match (or be similar to) their analog listed in [the Go Language document][go-environment2].

| ISA/ABI | `architecture` | `variant` | Go analog |
|------------|----------------|-----------------------|-------------|
| ARM 32-bit | `arm` | `v6`, `v7`, `v8` | `GOARM` |
| ARM 64-bit | `arm64` | `v8`, `v8.1`, … | `GOARM64` |
| POWER8+ | `ppc64le` | `power8`, `power9`, … | `GOPPC64` |
| RISC-V | `riscv64` | `rva20u64`, … | `GORISCV64` |
| x86-64 | `amd64` | `v1`, `v2`, `v3`, … | `GOAMD64` |
Variants marked as defaults SHOULD be assumed by implementations if the image index does not specify a `variant` for a manifest.
Defaults are subject to change at any time.
Copy link
Copy Markdown
Author

@ProbstDJakob ProbstDJakob Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if they should really be subject to change at any time, but that would be the case when relying on go and they would change the default.


| Description | `architecture` | `variant` | `os` |
|---------------------------|----------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| x86 | `386` | `softfloat`, `sse2` (default) | `android`, `freebsd`, `linux`, `netbsd`, `openbsd`, `plan9`, `windows` |
| x86-64 | `amd64` | `v1` (default), `v2`, `v3`, `v4` | `android`, `darwin`, `dragonfly`, `freebsd`, `illumos`, `linux`, `netbsd`, `openbsd`, `plan9`, `solaris`, `windows` |
| ARM 32-bit | `arm` | `v5`, `v6`, `v7` (default), `v8` | `android`, `freebsd`, `linux`, `netbsd`, `openbsd`, `plan9`, `windows` |
| ARM 64-bit | `arm64` | `v8` (default), `v8.1` | `android`, `darwin`, `ios`, `linux`, `openbsd`, `windows` |
| LoongArch 64-bit | `loong64` | | `linux` |
| MIPS 32-bit big endian | `mips` | `hardfloat` (default), `softfloat` | `linux` |
| MIPS 64-bit big endian | `mips64` | `hardfloat` (default), `softfloat` | `linux` |
| MIPS 64-bit little endian | `mips64le` | `hardfloat` (default), `softfloat` | `linux` |
| MIPS 32-bit little endian | `mipsle` | `hardfloat` (default), `softfloat` | `linux` |
| POWER8+ big endian | `ppc64` | `power8` (default), `power9` | `aix`, `linux` |
| POWER8+ little endian | `ppc64le` | `power8` (default), `power9` | `linux` |
| RISC-V | `riscv64` | `rva20u64` (default), `rva22u64`, `rva23u64` | `linux` |
| IBM z/Architecture | `s390x` | | `linux` |
| WebAssembly | `wasm` | comma separated list (defaults to empty list) composed of: `satconv`, `signext` | `js`, `wasip1` |
Comment thread
ProbstDJakob marked this conversation as resolved.

## Example Image Index

Expand Down