Documentation Index
Fetch the complete documentation index at: https://docs.xloud.tech/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Xloud Bare Metal provisioning treats physical servers as first-class cloud resources. Administrators enroll nodes by registering their management interface credentials, then users can provision bare metal instances through the same workflow as virtual machines.Prerequisites
- Administrator access to the Xloud Dashboard (admin view)
- Bare metal service (Ironic) enabled on the platform
- IPMI access to the physical servers
- Deploy kernel and ramdisk images uploaded to the image service
View Bare Metal Nodes
- Dashboard
- CLI
Navigate to Compute > Bare Metal Nodes in the admin sidebar. This page
is only visible when the Ironic endpoint is enabled.
Filter by Name, Power State, or Provision State.
| Column | Description |
|---|---|
| Node ID/Name | Node identifier (clickable to view details) |
| Ironic Instance Name | Name of the instance provisioned on this node |
| Power State | Power on, power off, or unknown |
| Provision State | Available, active, deploying, etc. |
| Maintained | Whether the node is in maintenance mode (with reason tooltip) |
| Number of Ports | Network ports registered for this node |
| Driver | Management driver (e.g., ipmi) |
| Created At | Registration timestamp |
Register a Bare Metal Node
The Dashboard provides a 3-step wizard for node registration.- Dashboard
- CLI
Step 1 — Node Info
| Field | Type | Required | Description |
|---|---|---|---|
| Name | Text | No | Optional node name |
| Driver | Dropdown | Yes | Management driver (ipmi) |
| Properties | Key-value pairs | Yes | Must include: cpus, memory_mb, local_gb, cpu_arch |
| Extra | Key-value pairs | No | Additional metadata |
| Standard Traits | Multi-select | No | Standard resource traits |
| Custom Traits | Dynamic list | No | Custom traits (must match CUSTOM_[A-Z0-9_]{1,248}) |
| Resource Class | Text | No | Node resource class |
Step 2 — Drive Info (Interfaces)
Configure hardware interfaces:
| Field | Default | Options |
|---|---|---|
| Boot Interface | pxe | pxe, ipxe, fake |
| Console Interface | no-console | no-console |
| Network Interface | noop | flat, noop |
| RAID Interface | no-raid | no-raid, agent |
| Storage Interface | noop | noop |
| Vendor Interface | ipmitool | ipmitool |
Step 3 — Driver Info (IPMI Credentials)
| Field | Type | Required | Description |
|---|---|---|---|
| Deploy Kernel | Image select | Yes | Kernel image (AKI format) |
| Deploy Ramdisk | Image select | Yes | Ramdisk image (ARI format) |
| IPMI Address | IP input | Yes | BMC/IPMI management IP |
| IPMI Port | Number | No | IPMI port (max: 65535) |
| IPMI Username | Text | Yes | BMC login username |
| IPMI Password | Text | Yes | BMC login password |
| Field | Default | Options |
|---|---|---|
| IPMI Bridge | no | no |
| IPMI Privilege Level | ADMINISTRATOR | ADMINISTRATOR, USER |
| IPMI Protocol Version | 2.0 | 1.5, 2.0 |
Node Management Actions
- Dashboard
- CLI
The following actions are available from the node row’s More dropdown:
The first row action is Manage State for provisioning lifecycle transitions.
| Action | Description |
|---|---|
| Edit | Update node properties, interfaces, and IPMI credentials |
| Power On | Power on the physical server |
| Power Off | Power off the physical server |
| Inspect | Auto-detect hardware properties from the BMC |
| Set Maintenance | Put the node in maintenance mode |
| Clear Maintenance | Remove the node from maintenance mode |
| Set Boot Device | Configure the next boot device |
| Create Port | Register a network port for the node |
| Create Port Group | Create a port group (bonded interfaces) |
| Delete | Remove the node from the platform |
Node Detail
- Dashboard
- CLI
Click a node name to open the detail page. Three tabs are available:Base Info tab:
- Base Info: Chassis ID, Resource Class, Maintenance status and reason
- Driver: All driver info key-value pairs (IPMI credentials masked)
- Boot Device: Current boot device and persistence setting
- Properties: All node properties
- Traits: Standard and custom traits
- Interface Validation: Table showing each interface’s validation status
Next Steps
Launch an Instance
Provision bare metal instances through the instance create wizard
Flavors
Create bare metal flavors with resource class matching
Compute Hosts
Monitor bare metal hypervisor resources
Troubleshooting
Resolve bare metal provisioning failures