docs(virtualization): document vm-default-images as opt-in package#538
docs(virtualization): document vm-default-images as opt-in package#538myasnikovdaniil wants to merge 1 commit into
Conversation
Add a "Default Image Collection (opt-in package)" section to the Golden Images page in v1.3/ and next/, covering the disabled-by-default status, storage footprint (~320Gi for the default 16-image set), enabling via bundles.enabledPackages, and overriding the image list through the cozystack.vm-default-images Package values. Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR adds documentation for an opt-in virtual machine default images package across two documentation versions. Both updates introduce a new section explaining how to enable ChangesVM Default Images Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for the vm-default-images opt-in package, which provides a curated set of pre-built Golden Images for virtualization. The documentation covers enabling the package, storage requirements, and configuration of the image list. Feedback was provided to correct the naming convention for DataVolumes from vm-default-images- to vm-image- to ensure consistency with Cozystack's standard resource identification.
| kubectl -n cozy-public get dv | ||
| ``` | ||
|
|
||
| DataVolumes provisioned by the package are named `vm-default-images-<image>` and are exposed to tenants as Golden Images named `<image>` (e.g. `ubuntu-24.04`, `debian-12`). |
There was a problem hiding this comment.
The naming convention for golden images in Cozystack typically requires the vm-image- prefix (as defined in the naming conventions table on line 25 and the script section on line 142) for them to be correctly identified and exposed to tenants. If the vm-default-images package follows this standard, the documentation should reflect the vm-image- prefix instead of vm-default-images- to avoid confusion.
| DataVolumes provisioned by the package are named `vm-default-images-<image>` and are exposed to tenants as Golden Images named `<image>` (e.g. `ubuntu-24.04`, `debian-12`). | |
| DataVolumes provisioned by the package are named vm-image-<image> and are exposed to tenants as Golden Images named <image> (e.g. ubuntu-24.04, debian-12). |
| To drop an image after the package is installed, remove it from `images[]` and delete the orphaned DataVolume: | ||
|
|
||
| ```bash | ||
| kubectl -n cozy-public delete dv vm-default-images-<name> |
There was a problem hiding this comment.
Update the deletion command to use the correct prefix for the DataVolume, consistent with the standard naming convention for golden images in Cozystack.
| kubectl -n cozy-public delete dv vm-default-images-<name> | |
| kubectl -n cozy-public delete dv vm-image-<name> |
| kubectl -n cozy-public get dv | ||
| ``` | ||
|
|
||
| DataVolumes provisioned by the package are named `vm-default-images-<image>` and are exposed to tenants as Golden Images named `<image>` (e.g. `ubuntu-24.04`, `debian-12`). |
There was a problem hiding this comment.
The naming convention for golden images in Cozystack typically requires the vm-image- prefix (as defined in the naming conventions table on line 25 and the script section on line 142) for them to be correctly identified and exposed to tenants. If the vm-default-images package follows this standard, the documentation should reflect the vm-image- prefix instead of vm-default-images- to avoid confusion.
| DataVolumes provisioned by the package are named `vm-default-images-<image>` and are exposed to tenants as Golden Images named `<image>` (e.g. `ubuntu-24.04`, `debian-12`). | |
| DataVolumes provisioned by the package are named vm-image-<image> and are exposed to tenants as Golden Images named <image> (e.g. ubuntu-24.04, debian-12). |
| To drop an image after the package is installed, remove it from `images[]` and delete the orphaned DataVolume: | ||
|
|
||
| ```bash | ||
| kubectl -n cozy-public delete dv vm-default-images-<name> |
There was a problem hiding this comment.
Update the deletion command to use the correct prefix for the DataVolume, consistent with the standard naming convention for golden images in Cozystack.
| kubectl -n cozy-public delete dv vm-default-images-<name> | |
| kubectl -n cozy-public delete dv vm-image-<name> |
1 participant
Summary
v1.3/andnext/.vm-default-imagesis disabled by default, the ~320Gi storage footprint of the default 16-image set, how to enable it viabundles.enabledPackages, and how to overridestorageClass/ theimages[]list through thecozystack.vm-default-imagesPackage.Test plan
hugo --buildDrafts --buildFuturebuilds without errors.{{% alert %}}shortcode renders toalert alert-warningmarkup in the generateddocs/v1.3/virtualization/vm-image/index.html./docs/v1.3/virtualization/vm-image/and/docs/next/virtualization/vm-image/.🤖 Generated with Claude Code
Summary by CodeRabbit