Skip to content

docs(virtualization): update vm-image guide for golden images / vm-default-images#520

Open
myasnikovdaniil wants to merge 1 commit intomainfrom
daniil/golden-images-vm-disk-source
Open

docs(virtualization): update vm-image guide for golden images / vm-default-images#520
myasnikovdaniil wants to merge 1 commit intomainfrom
daniil/golden-images-vm-disk-source

Conversation

@myasnikovdaniil
Copy link
Copy Markdown
Contributor

@myasnikovdaniil myasnikovdaniil commented Apr 29, 2026

Summary

  • Fix DataVolume name prefix: vm-image-<name>vm-default-images-<name> (matches the actual prefix used by the vm-disk Helm chart and vm-default-images package)
  • Update image catalog to the full vm-default-images package list (16 images: Ubuntu 20.04/22.04/24.04, Debian 12/13, Rocky 8/9/10, AlmaLinux 8/9/10, CentOS Stream 9/10, openSUSE Leap 15.6/16.0, Alpine 3.21)
  • Add "Default Image Collection" section explaining the vm-default-images system package that auto-provisions images
  • Fix kubectl tracking examples and VMDisk source example (ubuntuubuntu-24.04 with explicit storage: 20Gi)

Changes land in both v1.3/ and next/.

Test plan

  • Netlify deploy preview renders vm-image.md correctly for both /docs/v1.3/ and /docs/next/
  • DataVolume name examples match actual cluster behavior

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated golden image documentation with improved naming conventions and enhanced resource identification for better clarity
    • Added new section documenting the collection of pre-configured default operating system images available for immediate use
    • Redesigned guidance for using golden images with explicit, detailed instructions for creating virtual machine disks and attaching them to instances

…s package

Fix incorrect vm-image- prefix (actual prefix is vm-default-images-),
add the full default image collection from the vm-default-images system
package (ubuntu-20.04 through alpine-3.21), and update all kubectl
examples and the VMDisk source.image.name to match v1.3.0 behavior.

Apply to both v1.3/ and next/.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 29, 2026

Deploy Preview for cozystack ready!

Name Link
🔨 Latest commit 12df12a
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/69f1e3acf0a7ff00086a575d
😎 Deploy Preview https://deploy-preview-520--cozystack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f665bc51-d3b8-4e4a-b54b-58b34362ef85

📥 Commits

Reviewing files that changed from the base of the PR and between bc2745e and 12df12a.

📒 Files selected for processing (2)
  • content/en/docs/next/virtualization/vm-image.md
  • content/en/docs/v1.3/virtualization/vm-image.md

📝 Walkthrough

Walkthrough

Documentation updates to VM image guidance across two version branches, replacing vm-image-<image> naming conventions with vm-default-images-<image> in the cozy-public DataVolume prefix. Adds "Default Image Collection" section and reorganizes golden image workflow from creation examples to custom image addition and explicit VMDisk attachment steps.

Changes

Cohort / File(s) Summary
VM Image Documentation
content/en/docs/next/virtualization/vm-image.md, content/en/docs/v1.3/virtualization/vm-image.md
Updated DataVolume naming convention from vm-image-<image> to vm-default-images-<image>, added "Default Image Collection" section describing the system package and default images, replaced "Creating Golden Images" with "Adding Custom Golden Images" guidance, and rewrote "Using Golden Images" with explicit VMDisk creation and VMInstance attachment workflow steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A documentation hop—
Naming schemes now unified,
Images flow with grace so clear,
From collection to disk to machine,
One consistent path appears!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating the vm-image documentation guide to reflect the new vm-default-images naming convention and structure for golden images.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch daniil/golden-images-vm-disk-source

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.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation for virtual machine images in Cozystack, introducing the vm-default-images system package and its curated collection of OS images. It updates resource naming conventions to use the vm-default-images- prefix and provides revised examples for adding custom golden images and creating VMDisk resources. I have no feedback to provide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant