Add docs for sw.os and sw.kernel container contract labels
#3259
+22
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Dec 11, 2025
cywang117
force-pushed
the
os-kernel-contracts
branch
from
dcc8ee2 to
8d127b8
Compare
Contributor
|
Website deployed to CF Pages, 👀 preview link https://dcc1d712.balenacloud-docs.pages.dev |
cywang117
force-pushed
the
os-kernel-contracts
branch
from
8d127b8 to
0049dab
Compare
pipex
reviewed
Dec 19, 2025
cywang117
force-pushed
the
os-kernel-contracts
branch
from
0049dab to
1d45988
Compare
pipex
reviewed
Dec 19, 2025
| io.balena.features.requires.arch.sw: 'aarch64' | ||
| ``` | ||
|
|
||
| {{ $names.company.upper }} also supports specifying OS and kernel slug and version requirements. Multiple OS or kernel slugs may be specified at a time. |
Contributor
There was a problem hiding this comment.
This is a bit misleading, we don't support multiple OSs (yet)
Suggested change
| {{ $names.company.upper }} also supports specifying OS and kernel slug and version requirements. Multiple OS or kernel slugs may be specified at a time. | |
| {{ $names.company.upper }} also supports specifying version requirements for the Linux kernel and balenaOS. |
| ``` | ||
|
|
||
| {{ $names.company.upper }} also supports specifying OS and kernel slug and version requirements. Multiple OS or kernel slugs may be specified at a time. | ||
| | Label | Type | Description | Valid from Supervisor | |
Contributor
There was a problem hiding this comment.
Why create a different table? I would add these requirements to the table above and maybe add a separate paragraph and example
Also, this has a Type column which is not really necessary as the use of contracts is an implementation detail.
Contributor
Author
There was a problem hiding this comment.
Combined table into existing table, I've also removed all mentions of "multiple OS" and references to the sw.os contract type.
Change-type: patch Signed-off-by: Christina Ying Wang <[email protected]>
cywang117
force-pushed
the
os-kernel-contracts
branch
from
1d45988 to
c80e4fb
Compare
pipex
approved these changes
Dec 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates-to: balena-io-modules/balena-compose#117
Relates-to: balena-os/balena-supervisor#2444
Change-type: patch