docs: Add new feature documentation and stubs#115
Open
JeromeJaggi wants to merge 2 commits intoprod-stagingfrom
Open
docs: Add new feature documentation and stubs#115JeromeJaggi wants to merge 2 commits intoprod-stagingfrom
JeromeJaggi wants to merge 2 commits intoprod-stagingfrom
Conversation
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
unikraft-bot
reviewed
Apr 3, 2026
| - The mount script runs before a volume attaches to an instance. | ||
| - The unmount script runs after all instances detach from the volume. | ||
|
|
||
| This enables remote storage (NFS, iSCSI), encrypted volumes, and overlay filesystems. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'NFS' has no definition.
JeromeJaggi
force-pushed
the
jeromejaggi/docs-comprehensive-update
branch
from
a984ea9 to
1285c3b
Compare
JeromeJaggi
changed the title
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
JeromeJaggi
force-pushed
the
jeromejaggi/docs-comprehensive-update
branch
from
1285c3b to
28cd50e
Compare
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
JeromeJaggi
force-pushed
the
jeromejaggi/docs-comprehensive-update
branch
from
28cd50e to
8b4201c
Compare
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
JeromeJaggi
force-pushed
the
jeromejaggi/docs-comprehensive-update
branch
from
8b4201c to
e81fd0f
Compare
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
JeromeJaggi
force-pushed
the
jeromejaggi/docs-comprehensive-update
branch
from
e81fd0f to
af404cf
Compare
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
JeromeJaggi
force-pushed
the
jeromejaggi/docs-comprehensive-update
branch
from
af404cf to
2fd2008
Compare
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
Add inline ROMs, ROM lifecycle, volume lifecycle, instance logs, queued updates, COW checkpointing, volume hooks, K8s CRD specs, 10 diagrams, and feature stubs. Signed-off-by: Jerome Jaggi <[email protected]>
JeromeJaggi
force-pushed
the
jeromejaggi/docs-comprehensive-update
branch
from
2fd2008 to
ca82883
Compare
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
unikraft-bot
reviewed
Apr 4, 2026
| |---|---|---|---| | ||
| | `cloud.unikraft.v1.services/domain` | string | — | Custom domain for the Unikraft Cloud service. For multi-container pods, prefix with the container name (`cloud.unikraft.v1.services/domain.<containerName>`) to set a per-container domain, or use the global annotation to derive `<containerName>-<domain>` automatically. | | ||
|
|
||
| ## CRD reference |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'CRD reference' should use sentence-style capitalization.
| |---|---|---|---| | ||
| | `cloud.unikraft.v1.services/domain` | string | — | Custom domain for the Unikraft Cloud service. For multi-container pods, prefix with the container name (`cloud.unikraft.v1.services/domain.<containerName>`) to set a per-container domain, or use the global annotation to derive `<containerName>-<domain>` automatically. | | ||
|
|
||
| ## CRD reference |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'CRD' has no definition.
|
|
||
| The operator defines three CRDs in the `unikraft.com/v1alpha1` API group. | ||
|
|
||
| ### Instance CRD |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'Instance CRD' should use sentence-style capitalization.
|
|
||
| The operator defines three CRDs in the `unikraft.com/v1alpha1` API group. | ||
|
|
||
| ### Instance CRD |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'CRD' has no definition.
| Most spec fields don't change after creation. | ||
| Fields marked mutable accept in-place updates. | ||
|
|
||
| ### Service CRD |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'Service CRD' should use sentence-style capitalization.
| Most spec fields don't change after creation. | ||
| Fields marked mutable accept in-place updates. | ||
|
|
||
| ### Service CRD |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'CRD' has no definition.
|
|
||
| Service CRDs don't support in-place updates. | ||
|
|
||
| ### Volume CRD |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'Volume CRD' should use sentence-style capitalization.
|
|
||
| Service CRDs don't support in-place updates. | ||
|
|
||
| ### Volume CRD |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'CRD' has no definition.
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Comprehensive documentation update covering new and upcoming platform
features. All content sourced from platform code analysis.
New feature documentation
roms.mdx): files array, encoding options,ephemeral behavior, 16-file / 1KB limits
instances.mdx): queue behavior forrunning instances, supported properties, retry logic
snapshots.mdx): COW forkmechanism, async writes, dirty page tracking
volumes.mdx): custom scriptsfor remote storage and encrypted volumes
Feature stubs
snapshots.mdx)instances.mdx)live-migration.mdx, preview)sandbox-api.mdx, in development)Files changed
pages/features/roms.mdx(modified)pages/features/snapshots.mdx(modified)pages/platform/instances.mdx(modified)pages/platform/volumes.mdx(modified)pages/features/live-migration.mdx(new)pages/features/sandbox-api.mdx(new)Review guidance
This PR is intended as a single preview deployment for CEO review
of all new documentation before splitting into individual PRs for
merge.