docs(kubevirt): add dedicated KubeVirt toolset documentation#815
docs(kubevirt): add dedicated KubeVirt toolset documentation#815lyarwood wants to merge 1 commit intocontainers:mainfrom
Conversation
Add docs/kubevirt.md covering prerequisites, enablement, available tools (vm_create, vm_lifecycle, vm_clone), and the vm-troubleshoot prompt. Update the toolset description to link to the new doc page and add a KubeVirt entry to the docs index, matching the pattern used by Kiali. Assisted-By: Claude <[email protected]> Signed-off-by: Lee Yarwood <[email protected]>
|
|
||
| No additional toolset-specific configuration is required. The server uses your existing Kubernetes credentials (from kubeconfig or in-cluster) to interact with the KubeVirt API. | ||
|
|
||
| ### Available tools |
There was a problem hiding this comment.
I understand that this is a brief overview of the available tools provided by the toolset.
In this case, it's fine to having to manually update them.
In case this is not the case, we can find a solution to automatically update the tools list. Just let me know if this is the case.
|
|
||
| Create a VirtualMachine in the cluster. The tool automatically resolves instance types, preferences, and container disk images based on the provided parameters. | ||
|
|
||
| - **Workload resolution** - Accepts OS names such as `fedora`, `ubuntu`, `centos`, `centos-stream`, `debian`, `rhel`, `opensuse`, `opensuse-tumbleweed`, and `opensuse-leap`. These are resolved to container disk images from `quay.io/containerdisks`. Full container disk image URLs are also accepted. If DataSources are available in the cluster, the tool will match against those first. |
There was a problem hiding this comment.
The code in pkg/toolsets/kubevirt/vm/create/tool.go (osMap) only maps versioned RHEL names (rhel8, rhel9, rhel10) — there is no plain rhel entry. Consider updating this to list the versioned names (e.g. rhel8, rhel9, rhel10) instead, or adding a default rhel alias in the code.
|
|
||
| ## Toolset Guides | ||
|
|
||
| - **[KubeVirt](kubevirt.md)** - KubeVirt virtual machine management tools |
There was a problem hiding this comment.
Nit: alphabetically "Kiali" comes before "KubeVirt" (i < u). Consider swapping the order to keep the list sorted.
manusa
left a comment
manusa
left a comment
There was a problem hiding this comment.
Overall looks good, thx!
Added a few comments for your consideration.
2 participants
Add docs/kubevirt.md covering prerequisites, enablement, available tools (vm_create, vm_lifecycle, vm_clone), and the vm-troubleshoot prompt. Update the toolset description to link to the new doc page and add a KubeVirt entry to the docs index, matching the pattern used by Kiali.