From bf110e872083453fb8fe14174a473760b73234e4 Mon Sep 17 00:00:00 2001 From: woody_lin Date: Wed, 7 Jan 2026 13:35:08 +0800 Subject: [PATCH 1/2] docs: add Virtual Machine demo guide for creating and provisioning VMs in OtterScale --- src/content/docs/demos/05-virtual-machine.mdx | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 src/content/docs/demos/05-virtual-machine.mdx diff --git a/src/content/docs/demos/05-virtual-machine.mdx b/src/content/docs/demos/05-virtual-machine.mdx new file mode 100644 index 0000000..dd79670 --- /dev/null +++ b/src/content/docs/demos/05-virtual-machine.mdx @@ -0,0 +1,78 @@ +--- +title: Virtual Machine Demo +description: Create and provision a Virtual Machine within the OtterScale cluster. +--- + +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. + +## Create a Virtual Machine + + + + + +1. Navigate to the Compute section: + + Open your browser and go to: + ``` + /scope//compute + ``` + +2. Create a new Virtual Machine: + + - Click the **Create** button (plus icon) at the top of the Compute page + - A modal window titled "Create Virtual Machine" will appear + +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`) + - **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 + +4. Configure Advanced Settings (Optional): + + - Expand the "Advanced" section to configure a **Startup Script** (Cloud-Init user data) + - This allows you to bootstrap the instance with custom initialization commands + +5. Review and Confirm: + + - Review all the configuration settings + - Click **Confirm** to launch the Virtual Machine + + + +## Monitor the Virtual Machine + +Once the VM is created, you can monitor its status in the Compute page: + + + +1. View the VM in the Compute list: + + - Locate your newly created VM by name in the table + - Check the **Status** column to see the current state (e.g., Running, Stopped) + +2. Access VM resources: + + - **Machine**: Click to view which physical node is hosting your VM + - **Disk**: Expand to view and manage attached storage volumes + - **Ports**: Expand to view and manage network port configurations + - **Metrics**: Monitor real-time CPU, Memory, and Storage usage + - **VNC**: Access the VM console directly through VNC + + + +## Next Steps + +Explore other demo applications and services to enhance your infrastructure: + + + + + + \ No newline at end of file From 509578a8ea8f7195a34df19c23b4f9a6e65d8037 Mon Sep 17 00:00:00 2001 From: woody_lin Date: Wed, 7 Jan 2026 23:34:10 +0800 Subject: [PATCH 2/2] docs: add demo guides for Virtual Machine, Coder, JupyterHub, and PostgreSQL deployments --- src/content/docs/demos/01-virtual-machine.mdx | 154 ++++++++++++++++++ .../docs/demos/{01-coder.mdx => 02-coder.mdx} | 6 +- .../{02-jupyterhub.mdx => 03-jupyterhub.mdx} | 6 +- src/content/docs/demos/04-llm-model.mdx | 2 +- .../{03-postgres.mdx => 05-postgres.mdx} | 2 +- src/content/docs/demos/05-virtual-machine.mdx | 78 --------- 6 files changed, 162 insertions(+), 86 deletions(-) create mode 100644 src/content/docs/demos/01-virtual-machine.mdx rename src/content/docs/demos/{01-coder.mdx => 02-coder.mdx} (94%) rename src/content/docs/demos/{02-jupyterhub.mdx => 03-jupyterhub.mdx} (93%) rename src/content/docs/demos/{03-postgres.mdx => 05-postgres.mdx} (99%) delete mode 100644 src/content/docs/demos/05-virtual-machine.mdx diff --git a/src/content/docs/demos/01-virtual-machine.mdx b/src/content/docs/demos/01-virtual-machine.mdx new file mode 100644 index 0000000..0d6c506 --- /dev/null +++ b/src/content/docs/demos/01-virtual-machine.mdx @@ -0,0 +1,154 @@ +--- +title: Virtual Machine +description: Create and provision a Virtual Machine within the OtterScale cluster. +--- + +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. + +## Create a Virtual Machine + + + + + +1. Navigate to the Compute section: + + Open your browser and go to: + ``` + /scope//compute + ``` + +2. Create a new Virtual Machine: + + - Click the **Create** button (plus icon) at the top of the Compute page + - A modal window titled "Create Virtual Machine" will appear + +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`) + - **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 + +4. Configure Advanced Settings (Optional): + + - Expand the "Advanced" section to configure a **Startup Script** (Cloud-Init user data) + - This allows you to bootstrap the instance with custom initialization commands + - Example configuration for user setup and SSH access: + + ``` + #cloud-config + users: + - name: phison + sudo: ['ALL=(ALL) NOPASSWD:ALL'] + groups: sudo + shell: /bin/bash + chpasswd: + list: | + phison:phison_8299 + expire: false + ssh_pwauth: true + ``` + +5. Review and Confirm: + + - Review all the configuration settings + - Click **Confirm** to launch the Virtual Machine + +6. Wait for VM Initialization: + + - The VM will begin provisioning and cloning a Data Volume for its use + - Monitor the **Status** column to track the initialization progress + - Wait until the status changes to **Running** + + + +## Monitor the Virtual Machine + +Once the VM is created, you can monitor its status in the Compute page: + + + +1. View the VM in the Compute list: + + - Locate your newly created VM by name in the table + - Check the **Status** column to see the current state (e.g., Running, Stopped) + +2. Access VM resources: + + - **Machine**: Click to view which physical node is hosting your VM + - **Disk**: Expand to view and manage attached storage volumes + - **Ports**: Expand to view and manage network port configurations + - **Metrics**: Monitor real-time CPU, Memory, and Storage usage + - **VNC**: Access the VM console directly through VNC + + + +## Configure Service for VM Access + +To enable external access to your Virtual Machine, configure a service to expose its ports: + + + +1. Add a service port for SSH access: + + - In the Compute page, locate your VM in the table + - Click on the **Ports** column to expand the port management section + - Click **Add Port** to create a new service port + - Configure the port settings: + - **Protocol**: `tcp` + - **Port**: `22` (SSH service port on the VM) + - **NodePort**: (leave empty for automatic assignment or specify a fixed port) + - The system will automatically assign a NodePort (e.g., `30022`) for external access + +2. Note the NodePort: + + - Record the assigned NodePort from the Ports section + - This is the port you'll use to connect to the VM from outside the cluster + + + +## Access Your Virtual Machine + +Once the VM is running, fully initialized, and the service port is configured: + + + +1. Wait for cloud-init initialization: + + - The VM will automatically execute the cloud-init configuration + - The system user `phison` will be created with sudo privileges + - The password will be set as configured in the cloud-config + +2. Connect to the VM: + + - Use SSH to connect to your VM from external hosts + - Connection example: + ``` + ssh -p phison@ + ``` + - Or use VNC to connect directly through the web interface + - Login credentials: + - **Username**: `phison` + - **Password**: `phison_8299` + +3. Start using your VM: + + - You now have full access to configure and use the Virtual Machine + - The user has sudo privileges for system administration tasks + + + + +## Next Steps + +Explore other demo applications and services to enhance your infrastructure: + + + + + diff --git a/src/content/docs/demos/01-coder.mdx b/src/content/docs/demos/02-coder.mdx similarity index 94% rename from src/content/docs/demos/01-coder.mdx rename to src/content/docs/demos/02-coder.mdx index 704fff0..c8f26b8 100644 --- a/src/content/docs/demos/01-coder.mdx +++ b/src/content/docs/demos/02-coder.mdx @@ -1,5 +1,5 @@ --- -title: Coder Demo +title: Coder description: Deploy Coder for cloud-based VS Code IDE environments with support for both Go and Python backends. --- @@ -65,6 +65,6 @@ Once Coder is deployed and running: Explore other demo applications to enhance your infrastructure: - + - \ No newline at end of file + \ No newline at end of file diff --git a/src/content/docs/demos/02-jupyterhub.mdx b/src/content/docs/demos/03-jupyterhub.mdx similarity index 93% rename from src/content/docs/demos/02-jupyterhub.mdx rename to src/content/docs/demos/03-jupyterhub.mdx index c2cc9b0..b1d9018 100644 --- a/src/content/docs/demos/02-jupyterhub.mdx +++ b/src/content/docs/demos/03-jupyterhub.mdx @@ -1,5 +1,5 @@ --- -title: JupyterHub Demo +title: JupyterHub description: Deploy JupyterHub for multi-user Jupyter notebook environments. --- @@ -68,6 +68,6 @@ Once JupyterHub is deployed and running: Explore other demo applications to enhance your infrastructure: - + - \ No newline at end of file + \ No newline at end of file diff --git a/src/content/docs/demos/04-llm-model.mdx b/src/content/docs/demos/04-llm-model.mdx index 1330e5c..3b2e1ef 100644 --- a/src/content/docs/demos/04-llm-model.mdx +++ b/src/content/docs/demos/04-llm-model.mdx @@ -1,5 +1,5 @@ --- -title: LLM Model Demo +title: LLM Model description: Deploy and test LLM models integrated with OpenAI API. --- diff --git a/src/content/docs/demos/03-postgres.mdx b/src/content/docs/demos/05-postgres.mdx similarity index 99% rename from src/content/docs/demos/03-postgres.mdx rename to src/content/docs/demos/05-postgres.mdx index 039d597..d140fc9 100644 --- a/src/content/docs/demos/03-postgres.mdx +++ b/src/content/docs/demos/05-postgres.mdx @@ -1,5 +1,5 @@ --- -title: PostgreSQL Demo +title: PostgreSQL description: Deploy PostgreSQL database using Helm charts from the registry. --- diff --git a/src/content/docs/demos/05-virtual-machine.mdx b/src/content/docs/demos/05-virtual-machine.mdx deleted file mode 100644 index dd79670..0000000 --- a/src/content/docs/demos/05-virtual-machine.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Virtual Machine Demo -description: Create and provision a Virtual Machine within the OtterScale cluster. ---- - -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. - -## Create a Virtual Machine - - - - - -1. Navigate to the Compute section: - - Open your browser and go to: - ``` - /scope//compute - ``` - -2. Create a new Virtual Machine: - - - Click the **Create** button (plus icon) at the top of the Compute page - - A modal window titled "Create Virtual Machine" will appear - -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`) - - **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 - -4. Configure Advanced Settings (Optional): - - - Expand the "Advanced" section to configure a **Startup Script** (Cloud-Init user data) - - This allows you to bootstrap the instance with custom initialization commands - -5. Review and Confirm: - - - Review all the configuration settings - - Click **Confirm** to launch the Virtual Machine - - - -## Monitor the Virtual Machine - -Once the VM is created, you can monitor its status in the Compute page: - - - -1. View the VM in the Compute list: - - - Locate your newly created VM by name in the table - - Check the **Status** column to see the current state (e.g., Running, Stopped) - -2. Access VM resources: - - - **Machine**: Click to view which physical node is hosting your VM - - **Disk**: Expand to view and manage attached storage volumes - - **Ports**: Expand to view and manage network port configurations - - **Metrics**: Monitor real-time CPU, Memory, and Storage usage - - **VNC**: Access the VM console directly through VNC - - - -## Next Steps - -Explore other demo applications and services to enhance your infrastructure: - - - - - - \ No newline at end of file