docs(platform): Document on-demand instance template creation#128
Open
JeromeJaggi wants to merge 1 commit into
Open
docs(platform): Document on-demand instance template creation#128JeromeJaggi wants to merge 1 commit into
JeromeJaggi wants to merge 1 commit into
Conversation
Add an On-demand template creation section explaining how to use prepare=true and create_args so that templates get created the first time a node needs them, avoiding manual snapshot copying between nodes when a service runs on more than one host. Signed-off-by: Jerome Jaggi <jerome@unikraft.io>
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
1 participant
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
Adds an "On-demand template creation" sub-section to the Instance Templates section of
pages/platform/instances.mdx, explaining how customers can useprepare: truetogether withcreate_argsso that the platform creates a template the first time it's needed on a node.This is the recommended pattern when a service runs on more than one node and avoids having to manually copy template snapshot files between hosts.
Background
The feature exists today but wasn't surfaced anywhere in the narrative documentation — only in the OpenAPI schema. A customer recently asked how to handle templated snapshots in horizontal scaling and the answer wasn't findable. This PR closes that gap.
What's added
### On-demand template creationsub-section under## Instance templatesprepare,create_argsVerification
make lintpasses with 0 errors, 0 warnings, 0 suggestions for the modified fileThis PR was created by an AI agent.