docs(features): Add instance templates reference#104
docs(features): Add instance templates reference#104JeromeJaggi wants to merge 1 commit intoprod-stagingfrom
Conversation
|
|
||
| ## Template creation modes | ||
|
|
||
| There are two modes for creating a template: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[write-good.ThereIs] Don't start a sentence with 'There are'.
|
|
||
| | Mode | Description | | ||
| |------|-------------| | ||
| | **Non-prepare (cold)** | The instance transitions directly from stopped to template state without starting. No snapshot is produced. | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[write-good.Passive] 'is produced' may be passive voice. Use active voice if you can.
|
|
||
| Use prepare templates when the template needs warm state (loaded code, initialized caches, established connections). | ||
|
|
||
| ## Named vs anonymous templates |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'Named vs anonymous templates' should use sentence-style capitalization.
| | Type | Description | | ||
| |------|-------------| | ||
| | **Named** | You provide a name. The template persists and is reusable. Concurrent requests for the same name converge to a single template. | | ||
| | **Anonymous** | No name. The template is ephemeral and Unikraft Cloud frees it after the child instance is cloned. | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[write-good.Passive] 'is cloned' may be passive voice. Use active voice if you can.
|
|
||
| ## Template chains | ||
|
|
||
| Templates can be nested up to **4 levels** deep. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[write-good.Passive] 'be nested' may be passive voice. Use active voice if you can.
|
|
||
| Create templates in two ways: | ||
|
|
||
| 1. **Nested creation** — Specify template parameters in the instance creation request (`POST /v1/instances`). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Dashes] Remove the spaces around ' — '.
| Create templates in two ways: | ||
|
|
||
| 1. **Nested creation** — Specify template parameters in the instance creation request (`POST /v1/instances`). | ||
| 2. **Direct conversion** — Convert an existing instance via `POST /v1/instances/templates/create`. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Dashes] Remove the spaces around ' — '.
| | Max vCPUs per instance | 32 | | ||
|
|
||
| Templates count against the user's instance quota. | ||
| There is no dedicated template limit. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[write-good.ThereIs] Don't start a sentence with 'There is'.
|
|
||
| * The `kraft cloud` [command-line tool reference](/cli/) | ||
| * Unikraft Cloud's [REST API reference](/api/platform/v1) | ||
| * [Autoscale](/features/autoscale) — Autoscale uses templates for scale-out |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Dashes] Remove the spaces around ' — '.
| * The `kraft cloud` [command-line tool reference](/cli/) | ||
| * Unikraft Cloud's [REST API reference](/api/platform/v1) | ||
| * [Autoscale](/features/autoscale) — Autoscale uses templates for scale-out | ||
| * [Snapshots](/features/snapshots) — Templates use the snapshot mechanism |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Dashes] Remove the spaces around ' — '.
JeromeJaggi
force-pushed
the
docs/instance-templates
branch
from
bc02fab to
ce45063
Compare
Signed-off-by: Jerome Jaggi <jerome@unikraft.io>
JeromeJaggi
force-pushed
the
docs/instance-templates
branch
from
ce45063 to
2de1d0b
Compare
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
2 participants
Summary
Files changed
pages/features/templates.mdx(new)