Skip to content

Document steps to create a computeinstance#30

Open
achuzhoy wants to merge 1 commit intoosac-project:mainfrom
achuzhoy:vm-guide
Open

Document steps to create a computeinstance#30
achuzhoy wants to merge 1 commit intoosac-project:mainfrom
achuzhoy:vm-guide

Conversation

@achuzhoy
Copy link
Copy Markdown

@achuzhoy achuzhoy commented May 8, 2026

The guide aims with creating a computeinstance on
a subnet.

Summary by CodeRabbit

  • Documentation
    • Added a developer guide for creating and managing ComputeInstances (VMs) via the OSAC CLI: prerequisites, network and subnet setup, creating instances from manifests (including cloud-init user credentials, run strategy and ports), monitoring instance and VM lifecycle via CLI, and accessing the VM console.

@achuzhoy
Copy link
Copy Markdown
Author

achuzhoy commented May 8, 2026

cc @akshaynadkarni

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: eac63d97-a49d-40c3-9875-a484a66116f6

📥 Commits

Reviewing files that changed from the base of the PR and between 64fc295 and 44278d6.

📒 Files selected for processing (1)
  • guides/developer/computeinstance-guide.md
✅ Files skipped from review due to trivial changes (1)
  • guides/developer/computeinstance-guide.md

Walkthrough

This pull request adds a new developer guide (guides/developer/computeinstance-guide.md) documenting how to create and manage a ComputeInstance (virtual machine) using the OSAC CLI. The guide walks through six sequential steps: verifying prerequisites (OSAC CLI auth, ready tenant, and oc access), selecting a NetworkClass, provisioning a VirtualNetwork and Subnet with specified CIDR ranges, creating a ComputeInstance from a YAML manifest (including cloud-init user data for credentials), monitoring the deployment state, and accessing the instance console with login credentials.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 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: adding documentation for creating a ComputeInstance, which aligns with the guide's primary content.
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

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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
guides/developer/computeinstance-guide.md (1)

101-101: ⚡ Quick win

Pin the VM image to a stable version tag.

The example uses :latest, which is non-deterministic and can break over time. Official KubeVirt documentation and the containerdisks repository use version tags (e.g., quay.io/containerdisks/fedora:43) to ensure reproducibility. Update to a tested, specific version tag or image digest.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@guides/developer/computeinstance-guide.md` at line 101, The VM image is using
a non-deterministic tag (`source_ref: quay.io/containerdisks/fedora:latest`);
change the `source_ref` value to a pinned image tag or digest (for example
`quay.io/containerdisks/fedora:43` or
`quay.io/containerdisks/fedora@sha256:<digest>`) so the example is reproducible,
and update any surrounding example text that references `:latest` to reflect the
pinned tag/digest.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@guides/developer/computeinstance-guide.md`:
- Around line 105-121: Replace the insecure plaintext credentials in the
user_data cloud-init example by switching to SSH key authentication or a
mandatory secret placeholder: remove the hard-coded "user: kni" and "password:
redhat" entries in the user_data block and instead show an ssh_authorized_keys
template or refer to a required secret variable (with guidance to rotate and
inject per-deployment); update the example text and any occurrences (also at
lines referenced by the reviewer) to explicitly instruct using ssh keys or a
strong secret placeholder and include rotation guidance rather than publishing
reusable plaintext credentials.

---

Nitpick comments:
In `@guides/developer/computeinstance-guide.md`:
- Line 101: The VM image is using a non-deterministic tag (`source_ref:
quay.io/containerdisks/fedora:latest`); change the `source_ref` value to a
pinned image tag or digest (for example `quay.io/containerdisks/fedora:43` or
`quay.io/containerdisks/fedora@sha256:<digest>`) so the example is reproducible,
and update any surrounding example text that references `:latest` to reflect the
pinned tag/digest.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4e6d9856-dd94-42d9-91ff-bb3d947ab8a6

📥 Commits

Reviewing files that changed from the base of the PR and between 614f505 and 64fc295.

📒 Files selected for processing (1)
  • guides/developer/computeinstance-guide.md

Comment thread guides/developer/computeinstance-guide.md Outdated
Copy link
Copy Markdown
Contributor

@akshaynadkarni akshaynadkarni left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you.

The guide aims with creating a computeinstance on
a subnet.

Signed-off-by: Alexander Chuzhoy <achuzhoy@redhat.com>
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.

2 participants