add docs for custom diskimage feature #151
Conversation
Signed-off-by: Sibasish Behera <[email protected]>
|
cc @uzaxirr |
content/docs/compute/custom-image.md
Outdated
| - Use specialized operating systems not available in the default Civo marketplace | ||
| - Create instances with pre-configured applications and settings | ||
|
|
||
| :::note |
There was a problem hiding this comment.
I would move this up to the top and match the language of what is in the instance placement rules documentation, as that is CSE only as well.
There was a problem hiding this comment.
can you point to the docs please , i could not find it here
There was a problem hiding this comment.
content/docs/compute/custom-image.md
Outdated
| ``` | ||
|
|
||
| :::note | ||
| The name is prefixed with `cust-` to distinguish custom images from system images provided by Civo . |
There was a problem hiding this comment.
Should this be "the name will be prefixed with cust- once created?" As in, this is something the system does without requiring the user to do anything?
content/docs/compute/custom-image.md
Outdated
| | `--version` | Version of the operating system (required) | | ||
| | `--path` | Path to the disk image file (.raw or .qcow2) (required) | | ||
| | `--os` (optional) | Operating system type (defaults to "linux", can be "windows") | | ||
| | `--logo_path` (optional ) | Path to your logo file (SVG format) | |
There was a problem hiding this comment.
Logo file restrictions aside from format?
| <Tabs groupId="check-diskimage"> | ||
| <TabItem value="cli" label="Civo CLI"> | ||
|
|
||
| After uploading an image, it goes through several processing stages. You can check the status of your disk image with: |
There was a problem hiding this comment.
Should this have instructions on how to upload an image, like in https://www.civo.com/api/disk-images ?
There was a problem hiding this comment.
Its a part of create command in the cli , ie creating and upload is a single step process in the cli
There was a problem hiding this comment.
done its in note for create disk image section above
content/docs/compute/custom-image.md
Outdated
| - `upload_completed`: Upload finished, MD5 checksum verified | ||
| - `pending`: Image is being processed for distribution | ||
| - `available`: Image is ready to use for creating instances | ||
| - `upload_expired`: Upload not completed within 15 minutes |
There was a problem hiding this comment.
What happens if the instance ends up in this state?
There was a problem hiding this comment.
by instance i take it as the VM ? you can create a instance only when the image is in available state
so there would be no instance possible if state is upload_expired
There was a problem hiding this comment.
Sorry, I meant if the image ends up in an expired state. I noticed it's mentioned later so it woudl be good to have a quick reference.
content/docs/compute/custom-image.md
Outdated
| To see all your custom disk images: | ||
|
|
||
| ```console | ||
| $ civo diskimage list --local |
There was a problem hiding this comment.
t’s the flag used to list only the disk images uploaded by the user.
content/docs/compute/custom-image.md
Outdated
| +--------------------------------------+----------------------+--------------+---------+-----------+ | ||
| ``` | ||
|
|
||
| The `--local` flag filters the list to show only your custom uploaded disk images, excluding system images. |
There was a problem hiding this comment.
This is different than the type=custom on the API. Would be ideal to have the options be the same across the board.
There was a problem hiding this comment.
type only has one value that is custom , so do you want to go with --custom or --type custom
cc: @uzaxirr
There was a problem hiding this comment.
I don't really mind either way, but it shouldn't be local because that's not consistent with the API (and doesn't make sense to me either because why would it be "local"?)
content/docs/compute/custom-image.md
Outdated
|
|
||
| ### Upload expired or error state | ||
|
|
||
| If your upload expired or error state: |
There was a problem hiding this comment.
This should probably be "If your upload window expired, or the image is in an error state:"
Signed-off-by: Sibasish Behera <[email protected]>
Signed-off-by: Sibasish Behera <[email protected]>
No description provided.