docs: Warm-plug volume support#203
Conversation
danielvallance
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
| The platform supports **warm-plug** volume operations. | ||
| This lets you attach volumes in more lifecycle states than before, but with important timing constraints. | ||
|
|
||
| ### What is supported |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'what's' instead of 'What is'.
| The platform supports **warm-plug** volume operations. | ||
| This lets you attach volumes in more lifecycle states than before, but with important timing constraints. | ||
|
|
||
| ### What is supported |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[write-good.Passive] 'is supported' may be passive voice. Use active voice if you can.
| ### What is supported | ||
|
|
||
| - You can attach a volume to an instance created from a snapshot (for example, from a template). | ||
| - You can attach a volume to an instance that is currently `running`. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'that's' instead of 'that is'.
|
|
||
| ### Current behavior and limitations | ||
|
|
||
| - Attaching to a `running` instance is not applied instantly. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
| ### Current behavior and limitations | ||
|
|
||
| - Attaching to a `running` instance is not applied instantly. | ||
| - The attach operation is scheduled and completes on the next scale-to-zero cycle. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[write-good.Passive] 'is scheduled' may be passive voice. Use active voice if you can.
| - The attach operation is scheduled and completes on the next scale-to-zero cycle. | ||
| - This is warm-plug support, not full hot-plug support. | ||
| - Detaching a volume still requires the instance to be fully shut down (not only scaled to zero). | ||
| - If you request detach while the instance is not yet shut down, the platform schedules the update and applies it automatically once shutdown happens. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
| - `/v1/volumes/attach` | ||
| - `/v1/volumes/detach` | ||
|
|
||
| The instance `PATCH` endpoint does not currently support volume operations. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.
| - Detaching a volume still requires the instance to be fully shut down (not only scaled to zero). | ||
| - If you request detach while the instance is not yet shut down, the platform schedules the update and applies it automatically once shutdown happens. | ||
|
|
||
| ### API usage note |
There was a problem hiding this comment.
the clis don't support this?
Closes: FIELD-594 Signed-off-by: Daniel Vallance <daniel@unikraft.com>
danielvallance
force-pushed
the
danielvallance/warm_plug_volumes
branch
from
c5353a1 to
219a6b3
Compare
danielvallance
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
danielvallance
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
3 participants
Closes: FIELD-594