Skip to content

docs: update Kubernetes namespace default in Virtual Machine demo guide #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KUASWoodyLIN merged 1 commit into from
Jan 8, 2026
Merged

docs: update Kubernetes namespace default in Virtual Machine demo guide #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion src/content/docs/demos/01-virtual-machine.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,46 @@ import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';

This guide demonstrates how to create and provision a Virtual Machine (VM) within the OtterScale cluster for running workloads.

## Prepare Data Volume (Boot Image)

Before creating a Virtual Machine, you need to create a Data Volume (Persistent Volume Claim) that will serve as the bootable OS disk for the VM.

<Steps>

1. Navigate to the Data Volume section:

- Open your browser and go to:
```
<url>/scope/<scope-name>/service/data-volume
```

2. Create a new Data Volume for the VM boot disk:

- Click the **Create** button (plus icon) at the top of the Data Volume page
- A modal window titled "Create Data Volume" will appear

3. Configure the boot image Data Volume (PVC):

- **Name**: Enter a unique name for the boot disk (e.g., `ubuntu-20.04-vm-boot`)
- **Namespace**: Specify the Kubernetes namespace (defaults to `kubevirt`)
Copy link

@gemini-code-assist gemini-code-assist bot Jan 8, 2026

Choose a reason for hiding this comment

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

medium

While kubevirt is the correct default namespace here, this change introduces an inconsistency with other documentation. The guide src/content/docs/service/settings/03-data-volume.mdx still states that the default namespace for a Data Volume is default. To avoid user confusion, it would be best to update that file as well.

- **Size**: Set the capacity of the volume (e.g., 20 GB for a typical VM)
- **Boot Image**: Toggle this option to enable the boot image mode (this will display the source input field)
- **Source**: Enter the URL of the bootable OS image:
- Example: `https://cloud-images.ubuntu.com/focal/current/focal-server-cloudimg-amd64.img`
- You can use the "Cloud Image" button to browse common Ubuntu cloud images

4. Click **Confirm** to create the boot image Data Volume:

- The PVC will begin importing the OS image from the specified source
- Monitor the progress in the Data Volume list
- Wait until the **Phase** changes to **Succeeded** before proceeding to create the VM

</Steps>

<Aside type="tip">
The Data Volume creates a Persistent Volume Claim (PVC) containing the bootable OS image. This PVC will be used as the primary disk when creating the Virtual Machine. Ensure you select a valid cloud image URL that points directly to the disk image file (typically `.img` or `.qcow2` format).
</Aside>

## Create a Virtual Machine

<Aside type="tip">
Expand All @@ -30,7 +70,7 @@ Virtual Machines allow you to provision compute instances within your OtterScale
3. Configure Basic Settings:

- **Name**: Enter a unique name for the VM (e.g., `my-demo-vm`)
- **Namespace**: Specify the Kubernetes namespace (defaults to `default`)
- **Namespace**: Specify the Kubernetes namespace (defaults to `kubevirt`)
Copy link

@gemini-code-assist gemini-code-assist bot Jan 8, 2026

Choose a reason for hiding this comment

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

medium

This update to kubevirt as the default namespace is correct for consistency within this guide. However, the general documentation for creating Virtual Machines in src/content/docs/service/compute.mdx still lists default as the default namespace. Please consider updating that file too to ensure all documentation is aligned.

- **Instance Type**: Select a hardware profile from the dropdown list (displays CPU cores and Memory size)
- **Data Volume**: Select the bootable Data Volume (PVC) to use as the OS disk

Expand Down
Loading