Cloudpods – Compute

Docs: Disks

Mon, 01 Jan 0001 00:00:00 +0000

Disks are storage files for VMs. By location, disks are classified as local disks and cloud disks:

Local disk: Resides on the same host as the VM. Creating, attaching, and detaching from the disk list are not supported.
Cloud disk: Resides in the same availability zone as the VM. Creating, attaching, detaching, resizing, deleting, and related operations are supported.

Entry: On the cloud management platform, click the navigation menu in the upper left, then in the left sidebar click “Resource Management / Compute / Disks / Disks” to open the Disks page.

List fields

Field	Description
Name	Disk name; click the name to open the disk details page
Tags	Tags bound to the disk; BingoCloud does not support editing tags
Capacity	Disk capacity; sortable. On VMware, the provisioning method is also shown (such as thick provision or thin provision)
Max IOPS	Maximum IOPS of the disk; shows `-` when empty
Format	Disk format (such as qcow2 or raw)
Storage type	Storage type of the disk (such as local storage or shared storage)
Disk type	System disk or data disk
Attached	Shows the number of unattached disks; click to jump to the associated VMs page
VM	Name and status of the VM the disk is attached to; click to open VM details
Mount point	Mount point of the disk in the VM (such as vda or vdb); shows `-` when empty
Storage	Name of the storage that owns the disk; supports copy
Created at	Creation time of the disk. Hidden by default in the list; enable via column settings
Platform	Cloud platform of the disk
Region	Region where the disk resides
Billing method	Billing type of the disk (pay-as-you-go / subscription)
Status	Current status of the disk
Project	Project that owns the disk
Cloud account	Cloud account of the disk
Medium type	Storage medium type of the disk (such as SSD or HDD)
Auto reset on shutdown	Whether auto reset on shutdown is enabled (Yes / No)

Note: The list supports filtering by ID, name, description, status, storage, VM, disk type, attached or not, platform, project, domain, cloud account, region, medium type, and VM status above the list.

Create disk

Create a disk. A newly created disk must be attached to a VM before it can be used normally.

On the create disk page, click the “On-premise”, “Private Cloud”, or “Public Cloud” tab at the top to switch and create disks on different platforms.

Create an on-premise disk

Before creating an on-premise disk, configure shared storage such as Ceph, NFS, or GPFS.

On the Disks page, click the “All” or “On-premise” tab at the top, then click “Create” above the list to open the create disk page.
Configure the following parameters:
- Specify project: Administrators and domain administrators must specify the project that owns the disk when creating a disk.
- Region: Select the region and availability zone.
- Name: Set the disk name.
- Notes: Notes for the disk.
- Disk: Select the disk type and set the disk capacity; specifying block storage is supported.
- Specify VM: Select a specific host–VM for the disk.
- Disk encryption: Disabled by default. When enabled, the disk is encrypted with the selected key.
- Tags: Binding tags to the new disk is supported.
Click “OK” to complete the operation.

Only OneCloud supports specifying a VM.

In the admin console view, you can select a host and a specific VM under that host when creating a disk. In the domain admin console view and project view, you can only select a specific VM when creating a disk.

Create a private cloud disk

Before creating a private cloud disk, ensure a cloud account for the corresponding platform exists.

On the Disks page, click the “Private Cloud” tab at the top, then click “Create” above the list to open the create disk dialog.
Configure the following parameters:
- Specify project: Administrators and domain administrators must specify the project that owns the disk when creating a disk.
- Region: Select the region and availability zone. The region determines the private cloud platform and the private cloud account used to create the disk.
- Name: Set the disk name.
- Notes: Notes for the disk.
- Disk: Select the disk type and set the disk capacity.
- Disk encryption: Disabled by default. When enabled, the disk is encrypted with the selected key.
- Tags: Binding tags to the new disk is supported.
Click “OK” to complete the operation.

Create a public cloud disk

Before creating a public cloud disk, ensure a cloud account for the corresponding platform exists.

On the Disks page, click the “Public Cloud” tab at the top, then click “Create” above the list to open the create disk dialog.
Configure the following parameters:
- Specify project: Administrators and domain administrators must specify the project that owns the disk when creating a disk.
- Region: Use platform, region, and availability zone to determine the platform and availability zone of the disk.
- Name: Set the disk name.
- Notes: Notes for the disk.
- Disk: Select the disk type and set the disk capacity.
- Disk encryption: Disabled by default. When enabled, the disk is encrypted with the selected key.
- Tags: Binding tags to the new disk is supported.
- Advanced configuration: Click the “Advanced configuration” link to expand advanced options.
  - Specify cloud subscription: Specify the cloud subscription used to create the disk.
Click “OK” to complete the operation.

When creating a disk on Tencent Cloud, the disk capacity must be a multiple of 10. Otherwise creation fails.

Resize disk

Expand the size of a system disk or data disk to meet growing data needs. Disk resize does not support reducing disk capacity. Single and batch resize are supported.

On the Disks page, click “Resize” in the Actions column for the disk to open the resize dialog.
Adjust the disk capacity, then click “OK”.

Resize limits by platform:

Platform	Resize limits
OneCloud	No requirements
VMware	System disks support resize only when stopped; data disks have no requirements. If the disk already has an instance snapshot, resize is not allowed
ZStack	The VM the disk is attached to must be running or stopped
OpenStack	Data disks only
Alibaba Cloud	Data disks only; the VM the disk is attached to must be running or stopped
AWS	No requirements
Azure	The VM the disk is attached to must not be running
Tencent Cloud	Data disks only
Huawei Cloud	The VM the disk is attached to must be running or stopped
UCloud	The VM the disk is attached to must be stopped

Note: BingoCloud and SangFor do not support resize.

Attach

Attach a disk that is waiting to be attached to a VM so the VM can use it.

On the Disks page, click “More” in the Actions column for the disk, then select “Attach”.
After selecting a VM, click “OK”.
After the disk is attached successfully, log in to the VM to partition and format the attached disk and mount the new partition.

Limits:

The disk status must be ready before attach.

An already attached disk cannot be attached again.

BingoCloud and SangFor do not support attach.

Detach

Remove the association between a data disk attached to a VM and the VM. A detached disk can be attached to another VM. Only data disks can be detached.

For Linux VMs, wait until the umount command completes successfully inside the VM before detaching the disk.

On the Disks page, click “More” in the Actions column for the disk, then select “Detach”.
Confirm the operation.

Limits:

System disks cannot be detached.

Unattached disks cannot be detached.

Disks attached to multiple VMs cannot be detached.

Non-portable disks (portable=false) cannot be detached.

Disks that are migrating cannot be detached.

BingoCloud and SangFor do not support detach.

Create snapshot

Back up disk data. After a failure, a disk with a snapshot can be restored to the state before the snapshot.

Disks on VMware and UCloud do not support creating snapshots.

Snapshots cannot be created when the status of the VM that owns the disk is abnormal or when the disk is not attached to a VM.

Disks that are migrating cannot create snapshots.

BingoCloud and SangFor do not support creating snapshots.

On the Disks page, click “More” in the Actions column for the disk, then select “Create snapshot”.
Set the snapshot name, then click “OK” to create the snapshot.

Set auto snapshot

Set an auto snapshot policy for a disk. After configuration, the disk periodically creates automatic snapshots at the times specified by the auto snapshot policy.

On the Disks page, click “More” in the Actions column for the disk, then select “Set auto snapshot”.
Enable auto snapshot:
1. Check enable auto snapshot and select an auto snapshot policy name. If no suitable policy exists, click the “Create custom snapshot policy” link on the right, configure parameters in the create policy dialog, then click “OK” to create an auto snapshot policy.
2. After selecting the auto snapshot policy, click “OK”.
Disable auto snapshot: Check disable auto snapshot, then click “OK”.

Limits:

Only disks on OneCloud, Alibaba Cloud, and Tencent Cloud support setting auto snapshots.

The disk status must be ready.

VMware and China Telecom Cloud do not support this operation.

On OpenStack, only local storage and iSCSI storage types are supported.

On UCloud and RockBase, only the CLOUD_NORMAL storage type is supported.

The disk must already be attached, and the VM status must be running or normal.

BingoCloud, SangFor, ZettaKit, UIS, and CAS do not support this operation.

Auto reset on shutdown

Set an auto reset on shutdown policy for a disk. Supported only on OneCloud (KVM) when the VM status is ready.

On the Disks page, click “More” in the Actions column for the disk, then select “Auto reset on shutdown”.
In the dialog, set the auto reset policy, then click “OK”.

Change driver

Change the disk driver. A VM restart is required for the change to take effect. Visible only in the admin console.

Limits:

Supported only on OneCloud (KVM).

The disk must already be attached to a VM.

The VM status must be ready.

On the Disks page, click “More” in the Actions column for the disk, then select “Change driver”.
Modify the following parameters:
- Cache mode: Set the disk cache mode, including none, writethrough, writeback, and others.
  - none: Access the host disk directly.
  - writethrough: Do not use any cache; write directly to disk. Success is returned only after data is written to disk. Data consistency is preserved, but write speed is slow because disk writes are slow, while read speed is relatively high. No flush is required.
  - writeback: Success is returned after data is written to the host page cache. The page cache then merges data and writes it to disk. The guest disk controller is aware of the back cache, so to keep data consistent (newer data on the guest side, older data on the disk side), the guest sends flush instructions when needed to force cached data to disk.
- Disk driver: Set the disk driver, including virtio, ide, scsi, and pvscsi.
Click “OK” to complete the operation.

Change project

Change the project of an unattached disk.

Limits:

Not supported in project mode.

Attached disks cannot change project; detach first and retry.

BingoCloud, SangFor, ZettaKit, UIS, and CAS do not support this operation.

On the Disks page, click “More” in the Actions column for the disk, then select “Change project”.
Select the domain and project, then click “OK”.

Sync status

Get the current status of a disk.

Sync a single disk

On the Disks page, click “More” in the Actions column for the disk, then select “Sync status” to sync the disk status.

Batch sync status

In the disk list, select one or more disks, click “Batch actions” above the list, then select “Sync status” to batch sync status.

Note: VMware and SangFor do not support sync status. During batch sync, if the selection includes a VMware disk, the entire operation is disabled.

Set tags

Batch set tags for disks.

In the disk list, select one or more disks, click “Batch actions” above the list, then select “Set tags”.
In the set tags dialog, configure tags, then click “OK”.

Note: BingoCloud does not support editing tags.

Delete

Single and batch delete of disks are supported. A disk can be deleted only when it is not attached.

On OpenStack, disks and Ceph disks that have snapshots cannot be deleted.

Subscription disks cannot be deleted.

Alibaba Cloud, Tencent Cloud, Huawei Cloud, AWS, Azure, Google, ZStack, ZettaKit Cloud, OpenStack, OneCloud, and other platforms support deleting snapshots together when deleting a disk.

On Huawei Cloud, deleting a disk also deletes its disk snapshots.

On OneCloud, deleting a Ceph disk also deletes its disk snapshots.

BingoCloud and SangFor do not support delete.

Delete a single disk

On the Disks page, click “More” in the Actions column for the disk, then select “Delete” to open the confirmation dialog.
Click “OK” to complete the operation.

Batch delete

In the disk list, select one or more disks, click “Batch actions” above the list, then select “Delete” to open the confirmation dialog.
Click “OK” to complete the operation.

View disk details

This feature shows detailed information about a disk.

On the Disks page, click the disk name to open the disk details page.
The top menu on the details page supports resize, attach, detach, create snapshot, set auto snapshot, change driver, change project, sync status, delete, and other operations on the disk.
The details page includes the following tabs.

Disk information

Shows basic attributes of the disk:

Field	Description
User tags	User tags of the disk; editable (not supported on BingoCloud)
External tags	External tags of the disk; editable (not supported on BingoCloud)
Platform	Cloud platform of the disk
Billing method	Billing type of the disk
Capacity	Disk capacity
Provisioning	Disk provisioning method
Max IOPS	Maximum IOPS of the disk
Throughput	Disk throughput
Disk type	System disk or data disk
Attached	Shows the number of unattached disks
Format	Disk format
Medium type	Storage medium type of the disk
VM	Name and status of the VM the disk is attached to; click to jump
Storage	Name of the storage that owns the disk; public clouds show `-`. Hidden in project mode
Snapshot policy	Name of the associated auto snapshot policy
Auto reset on shutdown	Whether auto reset on shutdown is enabled (Yes / No)

Encryption (shown when the disk is encrypted):

Field	Description
Encryption key	Disk encryption key ID; shows “Not encrypted” if unencrypted
Encryption algorithm	Encryption algorithm (such as AES-256); shows `-` if unencrypted
Encryption key user	User/domain that owns the key; shows `-` if unencrypted

Snapshots

View snapshot information on the disk and manage snapshots.

On the disk details page, click the “Snapshots” tab to open the snapshots page.
View the snapshot list for the disk. The following operations are supported:
- Roll back disk: Roll the disk back to the state when the snapshot was created. Before rollback, ensure the VM associated with the disk is stopped. Click “Roll back disk” in the Actions column for the snapshot to open the roll back disk dialog, then click “OK”.
- Sync status: Get the current status of the snapshot. Click “Sync status” in the Actions column for the snapshot.
- Delete: Delete a disk snapshot. Click “Delete” in the Actions column for the snapshot to open the confirmation dialog, then click “OK”.

Tasks

Shows related asynchronous tasks for the disk.

On the disk details page, click the “Tasks” tab to open the tasks page.
View the execution status of related tasks.

View operation logs

This feature shows operation log information related to the disk.

On the disk details page, click the “Operation Logs” tab to open the operation logs page.
- Load more: The list shows 20 operation logs by default. To view more, click “Load more”.
- View log details: Click “View” in the Actions column for an operation log to view log details; content can be copied.
- View logs in a time range: Set the start and end dates in the upper right of the list to query logs for a specified period.
- Export logs: Click the icon in the upper right, set the export columns in the export data dialog, then click “OK” to export the logs shown on the current page.

Docs: Hosts

Mon, 01 Jan 0001 00:00:00 +0000

A host is a physical server that provides underlying resources for VMs on the cloud management platform. Hosts are domain resources.

Host sources:

The cloud management platform can sync host information from VMware, ZStack, OpenStack, Zetta Cloud, HCSO, and other cloud platforms.
After a physical server installs the proprietary host service, it automatically reports host information to the default domain and is shared by default.
Convert a physical machine (bare metal) to a host.

Entry: In the cloud management platform, click the navigation menu in the upper left, then click “Resource Management / Compute / Basic Resources / Hosts” in the left menu to open the Hosts page.

The upper right of the list shows the total number of hosts and status counts (running, stopped, operation failed, unknown).

List fields

The host list supports many display fields, grouped as follows:

Basic information fields

Field	Description
Name	Host name; click to open details. Icons after the name may include: - Host type icon (bare metal badge): The host was converted from a physical machine - Passthrough device icon: The host has GPU or other passthrough devices - Huge page icon: Huge page memory is enabled (page_size_kb > 4)
Status	Running status, such as running, stopped, running (offline), unknown, maintaining, or maintain failed
Enabled status	Whether the host is enabled (enabled/disabled). Disabled hosts cannot create VMs
Service (host_status)	Host service status, such as online/offline; alarm/error icons may appear beside it—hover to view sys_warn/sys_error details
Tags	Host tags; add and edit supported (except BingoCloud)
IP	Multiple IP addresses on the host: - Management IP (access_ip) - IPMI IP (ipmi_ip; bare metal hosts only) - Public IP (EIP)
IPMI password	Shown only for bare metal hosts (is_baremetal); click to get/view the password
#VM	Number of non-system VMs on the host; sortable
CPU architecture	CPU architecture, such as x86_64 or aarch64
Platform / Brand	Cloud platform brand the host belongs to
Cloud account	Cloud account the host belongs to
Share scope	Share scope of a domain resource: private / partial share / global share
Domain / Project	Domain and project the host belongs to
Region	Region where the host is located
Alert status	Monitoring alert status (requires the corresponding scoped policy)
Created at	Creation time

Resource usage fields (all sortable)

Field	Description
CPU usage	Used CPU cores / actual CPU cores; progress bar; hover for values
CPU allocation rate	Allocated VCPU cores / (actual CPU cores × CPU overcommit ratio); progress bar; hover for allocation details and overcommit limit
Memory usage	Used memory / actual memory; progress bar; hover for memory details (GB/MB)
Memory allocation rate	Allocated memory / (actual memory × memory overcommit ratio); progress bar; hover for allocation details
Storage usage	Used storage / storage pool capacity; progress bar
Storage allocation rate	Allocated storage / (storage pool capacity × storage overcommit ratio); progress bar; hover for storage overcommit limit
Disk read/write rate	Real-time disk read rate and write rate (B/s)
Network throughput	Real-time network inbound and outbound traffic (B/s)

Hardware information fields

Field	Description
Brand (manufacture)	Server vendor; icons for Dell, HP, HPE, Inspur, Lenovo, Super Micro, Huawei, Red Hat, and more
Model	Server hardware model
SN	Server serial number (sn); can be copied
Host type	Virtualization type: KVM, container host (container), bare metal (baremetal), and more
Scheduling tags	Bound scheduling tags shown as tags; shows “Not configured” when empty. Used for VM scheduling policies

Note: Fields can be shown or hidden via column settings in the upper right; actual columns may differ by configuration.

Host service offline notes

Common cases when the OneCloud host service goes offline:

At startup, the host service checks whether qemu is installed, whether the nbd module exists, and whether the native openvswitch kernel module exists. If any check fails, the host service goes offline and shows a specific error.

When an administrator intentionally takes the host service offline (ocadm node disable-host-agent <node-name> on the control node), VM status on the host does not change; users can still connect and use VMs remotely, but the cloud management platform cannot manage those VMs.

If region detects an abnormal offline, VMs on the host are set to unknown and cannot be used normally.

On private cloud platforms, host service offline may be caused by the host being powered off or related services being abnormal.

Remote control

Connect to a host via SSH for management. Depending on configuration, you may need the initial account password after connecting.

On the Hosts page, click “Remote control” in the Actions column to expand the submenu:
- SSH management IP: Open a web SSH connection using the host management IP.
- SSH management IP: custom port: If port 22 is occupied, set a custom SSH port in the dialog, then click “OK”.
- Custom account/password connection: Click the edit icon next to the SSH option, enter port, username, and password, then connect with custom credentials.
If multi-factor authentication (MFA) is enabled, complete MFA before connecting.

Notes:

Only hosts in the running state support SSH; for other statuses the SSH menu is disabled.

Bare metal hosts also support SOL web console and JNLP console (IPMI remote management).

BingoCloud hosts do not support SSH.

Enable / Disable

Enable/disable controls whether new VMs can be created on the host.

Enable: Enable a disabled host. Enabled hosts can create VMs and be scheduled.
Disable: Disable an enabled host. Disabled hosts cannot create VMs, but existing VMs keep running normally.

Platform limits: BingoCloud hosts do not support enable/disable.

Permission: Only users in the resource owner domain (ownerDomain) can enable/disable.

Batch enable/disable: In the host list, select one or more hosts, click “Batch actions” above the list, then select “Enable” or “Disable”.

Set tags

Hosts support tags for classification and filtering. You can edit tags directly on the list page.

Limits: BingoCloud hosts do not support tag editing.

Batch set tags: In the host list, select one or more hosts, click “Batch actions” above the list, then select “Set tags”.

Adjust scheduling tags

Bind scheduling tags to a host. Hosts with scheduling tags are preferentially scheduled to create VMs. When multiple hosts need the same tag, use batch adjust scheduling tags; to bind different tags, adjust each host separately.

On the Hosts page, click “More” in the Actions column, then select “Adjust scheduling tags”. The dialog appears.
Select scheduling tags to bind, then submit.

Limits:

BingoCloud hosts do not support adjusting scheduling tags.

Only users in the resource owner domain can perform this operation.

Batch actions: In the host list, select one or more hosts, click “Batch actions” above the list, then select “Adjust scheduling tags”.

Adjust overcommit limits

Set CPU and memory overcommit ratio limits and system reserved memory. Overcommit means the host can allocate more than its actual resources (allocatable = actual × overcommit ratio).

CPU overcommit ratio can be much greater than 1 (depending on workload)
Memory overcommit ratio is recommended to be 1 (to avoid OOM from memory overcommit)

Important: After huge page memory is enabled, memory overcommit ratio and system reserved memory cannot be adjusted.

Limits: ZStack hosts do not support adjusting overcommit limits; BingoCloud does not support it.

Parameter description

Parameter	Description
CPU overcommit limit	Upper limit of the host CPU overcommit ratio. Allocatable VCPUs = physical CPU cores × overcommit ratio
Memory overcommit limit	Upper limit of the host memory overcommit ratio. Allocatable memory = (actual memory − system reserved) × overcommit ratio
System memory reserved (GB)	Memory reserved for the host system; minimum 1 GB. Reserved memory is not allocated to VMs

Batch actions: In the host list, select one or more hosts, click “Batch actions” above the list, then select “Adjust overcommit ratio”.

Change domain

Change the domain the host belongs to. After a server installs the proprietary host service, it registers to the OneCloud platform under the default domain. Use Change domain to move it.

Conditions for changing domain (all required):

The current user is in the admin backend (admin backend domain).

Three-level permissions are enabled on the platform.

The host share scope is private (not shared).

Not a BingoCloud host.

Only users in the resource owner domain can perform this operation.

Batch actions: In the host list, select one or more hosts, click “Batch actions” above the list, then select “Change domain”.

Set the share scope of a host as a domain resource.

Domain resource share scopes:

Not shared (private): Only users in this domain can view and use the host.
Domain share - partial (multi-domain share): Shared to specified domains (one or more). Only users in the host’s domain and shared domains can use it.
Domain share - all (global share): Shared to all domains; all users in the system can view and use it.

Conditions for setting sharing (all required):

The current user is in the admin backend.

Three-level permissions are enabled on the platform.

Not a BingoCloud host.

Only users in the resource owner domain can perform this operation.

Batch actions: In the host list, select one or more hosts, click “Batch actions” above the list, then select “Set sharing”.

Auto migrate on crash

Set whether OneCloud hosts enable auto migrate on crash. When enabled, VMs created with shared storage on the host can automatically migrate to other available hosts if the host is powered off or fails. VMs using local storage on the host do not trigger migration.

On the Hosts page, click “More” in the Actions column, then select “Auto migrate on crash”.
In the dialog, select or clear “Enable auto migrate”, then click “OK”.

Limits:

Only OneCloud (OneCloud/provider=onecloud) hosts support this; other platforms show it disabled with “Only OneCloud hosts support this”.

The host must have health checks enabled (allow_health_check=true).

Only users in the resource owner domain can operate.

BingoCloud does not support this.

Batch actions: You can set auto migrate on crash for multiple hosts via batch actions.

Recycle as physical machine

Recycle a host as a physical machine (bare metal). Physical machines create bare metal servers; hosts create KVM VMs.

Conditions for recycling as a physical machine (all required):

Host type must be KVM / hypervisor (not baremetal or container).

Must be a bare-metal-converted host with IPMI information (is_baremetal=true).

Number of virtualized machines (#VM) must be 0 (no VMs).

Host must be disabled (enabled hosts cannot be recycled).

ARM architecture (cpu_architecture=aarch64) hosts do not support recycling as physical machines yet.

Only users in the resource owner domain can operate.

BingoCloud does not support this.

When conditions are not met, the button is disabled with a reason (such as “Cannot recycle when virtualized machines > 0” or “Enabled hosts cannot be recycled”).

Batch actions: In the host list, select one or more hosts, click “Batch actions” above the list, then select “Recycle as physical machine”.

Enter maintenance mode

When a host needs temporary downtime (hardware repair, firmware upgrade, and so on), put it into maintenance mode. VMs on a host in maintenance mode automatically migrate to other idle hosts.

Conditions for entering maintenance mode:

Only OneCloud (hypervisor) hosts support this (not baremetal/container).

host_status must not be offline (offline cannot auto-migrate).

Host status must be running or maintain_fail.

Other idle available hosts must exist as migration targets.

VMs on the host must not have GPU devices or optical discs attached (if attached, VMs must be stopped).

VMs on the host must not have backup instances.

VM statuses on the host must be stopped, running, or unknown (other statuses may not migrate).

Only users in the resource owner domain can operate.

BingoCloud does not support this.

On the Hosts page, click “More” in the Actions column, then select “Enter maintenance mode”.
After confirmation, VMs on the host migrate one by one to other hosts. Host status becomes “Maintaining” (maintaining), and enabled status becomes disabled.
If some VMs fail to migrate, status becomes “Maintain failed” (maintain_fail). Handle failed VMs manually, then retry or exit maintenance mode.

Exit maintenance mode

When the host is healthy again, exit maintenance mode and rejoin the scheduling pool.

On the Hosts page, for a host in “Maintenance mode” or “Maintain failed”, click “More” in the Actions column, then select “Exit maintenance mode”.
After confirmation, host status becomes “Running”. Enabled status remains disabled; you must manually Enable before the host can create and schedule VMs.

Note: When entering maintenance mode fails (maintain_fail), Exit maintenance mode can return the host to normal running.

Limits: Only hypervisor (KVM) hosts support this; BingoCloud does not; only owner-domain users can operate.

Set NUMA affinity

Set NUMA (Non-Uniform Memory Access) affinity on a host to optimize memory access across NUMA nodes.

On the Hosts page, click “More” in the Actions column, then select “Set NUMA affinity”.
Configure the NUMA policy in the dialog and submit.

Set CPU reserved resources

Reserve some CPU cores on the host for the host system or other processes. Reserved cores are not allocated to VMs.

Limits:

Only OneCloud (OneCloud) hosts support this.

All VMs on the host must not be running.

Shared hosts cannot set CPU reservation.

Only users in the resource owner domain can operate.

Parameter: Reserved CPU cores can be 0–15 (0, 1, 2, …, 15).

Batch actions: Select multiple hosts in the list and set CPU reserved resources via batch actions.

Set passthrough device reserved resources

Reserve dedicated CPU, memory, and storage for each GPU card on the host. Reserved resources cannot be allocated to ordinary VMs and are dedicated to GPU passthrough.

Limits:

Only OneCloud (OneCloud) hosts with GPU passthrough devices support this.

Hosts without GPUs show the button disabled with “Hosts with GPUs are supported”.

When a host has multiple GPUs, the same amount is reserved for each GPU.

GPU reserved resources are deducted after host CPU/memory/storage overcommit: compute total allocatable by overcommit ratio, then deduct passthrough reservations.

Only users in the resource owner domain can operate.

BingoCloud does not support this.

Parameter description

Parameter	Description
CPU (cores)	CPU cores reserved per passthrough device (per GPU)
Memory (MB)	Memory reserved per passthrough device (MB)
Disk (MB)	Disk reserved per passthrough device (MB)

Batch actions: You can set passthrough device reserved resources for multiple hosts in batch.

Delete

Delete a host. After deletion, it is removed from the platform and no longer scheduled or managed.

Delete conditions:

Number of VMs on the host is 0 (no running or existing VMs).

Host is disabled.

Common delete checks pass ($getDeleteResult), such as no dependent resources.

Only users in the resource owner domain can operate.

BingoCloud does not support deleting hosts.

When delete conditions are not met, the button is disabled with the specific reason.

Batch delete: In the host list, select one or more hosts, click “Batch actions” above the list, then select “Delete”.

View host details

Click a host name in the list to open details. Top action buttons match list Actions (remote control, enable/disable, adjust scheduling tags, adjust overcommit ratio, recycle as physical machine, enter/exit maintenance mode, delete, and more).

The details page includes the following tabs, in order:

Host information

Shows all detailed host attributes:

Basic info: Cloud ID, ID, name, status, domain, hostname, tags, share scope, platform, enabled status, IP, MAC address, #VM, scheduling tags, host version, hardware virtualization, ISO boot, passthrough device count, region, availability zone, cloud account, cloud subscription, created at, updated at, and description.
Brand info: Brand/vendor name, model, and serial number.
CPU info: Physical CPU cores, sockets, overcommit ratio, virtual CPUs, current overcommit ratio, description, CPU architecture, passthrough device reserved CPU, and system reserved cores.
Memory info: Physical capacity (total/allocated), overcommit ratio, current overcommit ratio, system reserved (typically about 10% of actual host memory, capped at 10 GB), and passthrough device reserved memory.
Storage info: Root partition capacity (used/total), storage pool capacity (used/total), type, current overcommit ratio, invalid storage (total capacity of disks not in available status), passthrough device reserved storage, and adapter information.
Network interfaces: All NIC information (IP, MAC, subnet mask, type, speed).

Dashboard (resource stats and monitoring)

Shows host capacity stats, real-time monitoring, and TOP5 resource consumers:

Capacity stats: Ring charts for CPU, memory, local storage, and VM count (total, used, and usage percentage).
TOP5: Top 5 VMs by CPU usage, network inbound, network outbound, disk read rate, and disk write rate, with values.
Real-time monitoring: Gauges for system load, memory utilization, disk IO usage, disk space usage, NIC inbound bandwidth usage, and NIC outbound bandwidth usage.

VM list

Lists all VMs (non-system VMs) on the host and supports common VM management (create, delete, start, stop, restart, adjust configuration, and more). See VMs.

Note: For container hosts (host_type=container), this tab title becomes “Containers” and shows container instances.

Network (bare metal network information)

Shows host network interface details. Requires the baremetalnetworks_list permission.

Field	Description
Index	NIC index
MAC address	NIC MAC address
NIC type	NIC type
IP address	IP address bound to the NIC
IP subnet	Owning IP subnet
Layer 2 network	Owning Layer 2 network
Driver	NIC driver name

For NICs without an allocated IP, you can bind a Layer 2 network manually: click “Set Layer 2 network” in the Actions column, select a Layer 2 network, then submit.

Storage

Shows storage information and local storage pools on the host. Requires the hoststorages_list permission.

Field	Description
Name	Storage name
Capacity	Total storage capacity
Allocated	Capacity allocated to VMs
Wasted	Wasted capacity (allocated but not actually used)
Storage type	Storage type, such as local storage, NFS, or Ceph
Enabled	Whether storage is enabled
Mount point	Mount path of the storage on the host

Supports storage management (enable/disable, adjust configuration, and more).

Passthrough devices / GPU

Shows all GPU cards and other passthrough devices on the host:

Field	Description
Device type	GPU card type
Device model	Specific model
Associated host	Owning host
Attach status	Whether attached to a VM

Supports GPU management (attach, detach, and more).

Recycle bin

Lists VMs on this host that are in the recycle bin (pending_delete=true). Supports purge or restore; see Instance recycle bin.

Monitoring

Shows historical host monitoring metrics as line charts across time ranges (last 1 hour / 3 hours / 6 hours). You can set a monitoring alert for each metric.

Monitoring metrics:

Metric category	Included metrics
CPU	CPU usage (user/system/iowait/idle breakdown), CPU idle rate, and more
System load	1/5/15-minute average load, average load per CPU core
Memory	Memory usage, used, free, and total
Disk	Disk usage, used, free, IO usage, IOPS (read/write)
Network	Network inbound traffic, network outbound traffic

Set monitoring alert: Click “Set monitoring alert” to the right of a metric. In the create dialog, configure query period, comparison operator, threshold, alert level, alert method, and recipients. After submit, an alert rule for that metric is created.

Alert history

Lists historical monitoring alert events related to the host, including alert level, metric, trigger time, and recovery time.

Tasks (Task Drawer)

Shows async compute tasks related to the host, such as VM migration, host maintenance mode, and overcommit ratio adjustment. View progress, status, error information, and more.

Operation logs

Shows operation logs related to the host.

On the host details page, click the “Operation logs” tab.
- Load more: 20 logs by default; click “Load more” for more.
- View log details: Click “View” in the Actions column; you can copy the content.
- Time filter: Set start and end dates in the upper right to query a time range.
- Export logs: Click the export icon in the upper right, set export columns, then click “OK” to export logs on this page (CSV/Excel).

DMESG logs

Shows host kernel boot logs (dmesg output) for troubleshooting hardware and kernel-level boot issues.

Hardware logs (BMC Log, bare metal hosts only)

Shown only for bare metal hosts converted from physical machines (is_baremetal=true). Displays hardware event logs recorded by the BMC (Baseboard Management Controller).

Set an end time (cutoff) to query hardware logs before that time.
When there are many logs, click “Load more” below the list for more history.

Docs: System Images

Mon, 01 Jan 0001 00:00:00 +0000

System images fall into two main format categories:

Image format	Formats	Characteristics	Usage
VM images	QCOW2, VMDK, RAW, VHD	Used to create VMs, bare metal, and more. One image can have multiple formats so it fits multiple platforms; ready to boot without installing an OS.	When the image is a public image, select it under Public images when creating a VM. When the image is a custom image, select it under Custom images.
ISO images	ISO	Used only to create VMs on the OneCloud platform. After the VM is created, you still need to log in remotely to install the OS and related steps.	Regardless of image type, when creating a VM choose Boot from ISO and select the ISO image.

By type, system images include:

Image type	Description	Sources
Public image	Share scope defaults to system share and cannot be changed.	Images imported by administrators from the Image Market; custom images in the administrator’s project set as public images.
Custom image	Share scope defaults to private and can be changed.	Images uploaded by any user; images generated by saving a system image; public images in the administrator’s project set as custom images.

Cloud management platform image usage rules:

When creating VMs on private cloud or on-premise using platform images, images are saved as image caches on the corresponding host’s local storage;
When public clouds use platform images, images are cached on the public cloud; cached images show a cached badge when selecting an image to create a VM.

Entry: On the cloud management platform, click the navigation menu in the upper left, then in the left sidebar click “Resource Management / Compute / Images / System Images” to open the System Images page.

Upload a system image

Upload a system image file. Uploaded images default to custom images.

Steps:

On the System Images page, click “Upload” to open the upload page.
Set the following parameters:

Parameter	Description
Project	Select the owning project of the system image
Image name	Set the image name; preferably related to the OS release
CPU architecture	x86 and ARM are supported
Upload method	Upload an image file or enter an image URL
Operating system	Linux, Windows, or Other
Image encryption	Enable image encryption; the image is encrypted with the selected key

Upload method notes:

Upload image file: Upload an image accessible to the current browser. The VM image list supports QCOW2, VMDK, RAW, and VHD suffixes. The ISO image list supports only ISO files.

Enter image URL: Add an image by URL. Only http and https URLs are supported, in the form http://path/file or https://path/file.

Create a VM

Create a VM from a system image.

On the System Images page, click “Create VM” in the Actions column for the image to open the create VM dialog.
Select On-premise, Private cloud, or Public cloud, then click “OK” to open the create VM page.
Configure other parameters, then click “Create” to create the VM.

Modify attributes

Modify attribute information of a system image.

On the System Images page, click “More” in the Actions column for the image, then select “Modify attributes”.
The following parameters can be modified:

Parameter	Description
Name	Set the image name; preferably related to the OS release
CPU architecture	x86 or ARM
Operating system	Linux, Windows, or Other
Distribution	Select the OS distribution
Minimum disk	Minimum disk requirement for hosts created from the image
Disk driver	System auto-select, virtio, scsi, pvscsi, ide, or sata. Choose by disk type; “System auto-select” is recommended
NIC driver	System auto-select, virtio, e1000, or vmxnet3. “System auto-select” is recommended
BIOS mode	BIOS, UEFI, or BIOS & UEFI
VDI protocol	System auto-select, vnc, or spice

Click “OK” to finish.

Set as public / custom image

Only system administrators can set a custom image in their project as a public image, or set a public image in their project as a custom image.

Public image: Defaults to system share; share scope cannot be changed.
Custom image: Defaults to private; share scope can be set.

On the System Images page, for a custom image, click “More” in the Actions column, then select “Set as public image” to set it as a public image.
On the System Images page, for a public image, click “More” in the Actions column, then select “Set as custom” to set it as a custom image.

Set the share scope of a system image. Only custom images support setting sharing.

Project resources have five share scopes:

Not shared (private): Only users in this project can use the project resource.
Project share - partial (multi-project share within the domain): The project resource can be shared with one or more specified projects in the same domain. Only users in the owning project and the shared projects can use it.
Project share - all (domain-wide share): The project resource can be shared with all projects in the domain, so users in the resource’s domain can use it.
Domain share - partial (multi-domain share): The project resource can be shared with one or more specified domains. Only users in the owning domain and the shared domains can use it.
Domain share - all (global share): The project resource can be shared with all domains, so all users in the system can use it.

Conditions for setting domain sharing:

Three-level permissions are enabled on the OneCloud platform.

The user is in the Admin Console.

Conditions for setting project sharing:

The user is in the Admin Console or Domain Admin Console.

Set sharing one

On the system image page, click “More” in the row actions for the target system image, then choose “Set sharing”.
Confirm the action.

Set sharing in batch

In the system image list, select one or more system image, then click “Set sharing” above the list.
Confirm the action.

Change project

Change the owning project of a system image.

Change project one

On the system image page, click “More” in the row actions for the target system image, then choose “Change project”.
Confirm the action.

Change project in batch

In the system image list, select one or more system image, then click “Change project” above the list.
Confirm the action.

Merge images

Merge two or more system images into one host image.

Note: ISO images do not support merge.

In the system image list, select two or more system images, click “Batch actions” above the list, then select “Merge images”.
Enter a name for the merged image and set image order. Order corresponds to disk order when creating a host: system disk, data disk 1, data disk 2, … data disk n. Keep the order consistent with actual disks.
Click “OK” to finish.

Set delete protection

Set delete protection for system images. When delete protection is enabled, the system image cannot be deleted; when it is disabled, the system image can be deleted.

Set delete protection one

On the system image page, click “More” in the row actions for the target system image, then choose “Set delete protection”.
Confirm the action.

Set delete protection in batch

In the system image list, select one or more system image, then click “Set delete protection” above the list.
Confirm the action.

Delete

Delete system images. If the system image name has a icon, delete protection is enabled and the system image cannot be deleted; disable delete protection first. System images imported from the Image Market return to the not-imported list after delete.

Administrators can delete all system images.

Domain administrators can delete only system images in their domain.

Project users can delete only system images in their project.

Delete one

On the system image page, click “More” in the row actions for the target system image, then choose “Delete”.
Confirm the action.

Delete in batch

In the system image list, select one or more system image, then click “Delete” above the list.
Confirm the action.

View system image details

View detailed information about a system image.

On the System Images page, click the image name to open the details page.
The top menu on the details page supports management operations on the image.
View image information:

Category	Fields
Basic information	Cloud ID, ID, Name, Status, Domain, Project, Share scope, Type, Size, Created at, Updated at, Notes
Image attributes	Disk format, System language, Minimum memory, Minimum disk, Disk driver, NIC driver, Application platform
Multi-cloud image	Except for ISO, images imported to the OneCloud platform are converted into three formats; multi-cloud image shows checksum, format, size, and status
Other	Enable or disable delete protection

Tip: Images from the Image Market or manual upload are stored under /opt/cloud/workspace/data/glance/image on the First Node. One to three format copies are saved, named by image ID.

View image caches

View the image cache list and create or delete caches. Only the administrator view supports viewing and managing image caches.

On the System Images page, click the image name to open the details page.
Click the “Cache list” tab.
View cache location, status, updated at, platform, region, cloud account, and related information.

Cache location notes: On OneCloud and private clouds, cache location is the host; on public clouds, it is the region on the public cloud.

Create an image cache

By default, when creating a VM on OneCloud or a private cloud, the selected image is cached on the corresponding host; when creating a VM on a public cloud, it is cached in the corresponding region.

In addition, the cloud management platform supports pre-caching images to specific hosts and platform regions to speed up VM creation.

Cache to IDC:

On the cache page, click “Create” above the list, then select “IDC”.
The list shows all cacheable locations, including platform, region, zone, IP, cache location, SN, and more.
Search by IP or SN in the search box, or select hosts in the list.
Click “OK” to finish.

Cache to private cloud:

Private cloud cache locations are hosts.

On the cache page, click “Create” above the list, then select “Private cloud”.
Filter by platform, cloud subscription, region, and more, or select cache locations in the list.
Click “OK” to finish.

Cache to public cloud:

Public cloud cache locations are regions.

On the cache page, click “Create” above the list, then select “Public cloud”.
Filter by platform, cloud subscription, region, and more, or select cache locations in the list.
Click “OK” to finish.

View system image operation logs

On the system image page, click the system image name to open details.
Click the “Operation logs” tab.
- Load more: 20 logs by default; click “Load more” for more
- View details: click “View” in the row actions
- Time filter: set start/end dates to query a time range
- Export logs: click the download icon to export logs on this page

Docs: VMs

Mon, 01 Jan 0001 00:00:00 +0000

A VM is a virtual machine instance built with virtualization technology and running on a host, including a full virtual hardware environment such as CPU, memory, OS, disks, and NICs.

VM sources:

After the cloud management platform connects to other cloud accounts, VMs on those platforms are synced automatically for management on the cloud management platform.
Create VMs.

Entry: Left menu → Resource Management / Compute / Instances / VMs

The upper right of the list shows the total VM count and counts for running, stopped, operation failed, and unknown states.
In Project view, users cannot see domain-resource list fields. For example, in Project view users cannot see the host or cloud account of a VM.

Feature overview

Create VM - Create VM instances
Instance operations - Start, stop, restart, suspend, and more
Configuration changes - Reinstall OS, resize, passthrough devices, and more
Network and security - Security groups, EIPs, NIC management
Storage - Disks, snapshots, backups, ISO
High availability - Migration, rescue, backup instances
Monitoring and alerts - Agent install, metrics, alert settings
Details - Information on various tabs
Platform compatibility - Operations supported per platform

View VM operation logs

On the VM page, click the VM name to open details.
Click the “Operation logs” tab.
- Load more: 20 logs by default; click “Load more” for more
- View details: click “View” in the row actions
- Time filter: set start/end dates to query a time range
- Export logs: click the download icon to export logs on this page

Docs: Host Images

Mon, 01 Jan 0001 00:00:00 +0000

Host images are used to create VMs.

Source: Save a host image via the Save image action on the VM list.

Entry: On the cloud management platform, click the navigation menu in the upper left, then in the left sidebar click “Resource Management / Compute / Images / Host Images” to open the Host Images page.

Modify attributes

Modify attribute information of a host image.

On the Host Images page, click “More” in the Actions column for the image, then select “Modify attributes” to open the dialog.
The following parameters can be modified:

Parameter	Description
Image name	Set the image name; preferably related to the OS release
Operating system	Linux, Windows, or Other
Distribution	Select the OS distribution
Disk driver	System auto-select, virtio, scsi, pvscsi, ide, or sata. Choose by disk type; “System auto-select” is recommended
NIC driver	System auto-select, virtio, e1000, or vmxnet3. “System auto-select” is recommended
BIOS mode	BIOS, UEFI, or BIOS & UEFI
VDI protocol	System auto-select, vnc, or spice

Click “OK” to finish.

Set the share scope of an image.

Project resources have five share scopes:

Not shared (private): Only users in this project can use the project resource.
Project share - partial (multi-project share within the domain): The project resource can be shared with one or more specified projects in the same domain. Only users in the owning project and the shared projects can use it.
Project share - all (domain-wide share): The project resource can be shared with all projects in the domain, so users in the resource’s domain can use it.
Domain share - partial (multi-domain share): The project resource can be shared with one or more specified domains. Only users in the owning domain and the shared domains can use it.
Domain share - all (global share): The project resource can be shared with all domains, so all users in the system can use it.

Conditions for setting domain sharing:

Three-level permissions are enabled on the OneCloud platform.

The user is in the Admin Console.

Conditions for setting project sharing:

The user is in the Admin Console or Domain Admin Console.

Set sharing for a single host image

On the Host Images page, click “More” in the Actions column for the image, then select “Set sharing” to open the dialog.
Configure the following parameters:
- When the sharing scope is “Not shared”, the project resource is private and only users in this project can use it.
- When the sharing scope is “Project share”, select projects in the same domain that can be shared with.
  - When one or more projects in the same domain are selected, the scope is Project share - partial; only users in the owning project and the shared projects can use the project resource.
  - When all projects are selected, the scope is Project share - all; users in the resource’s domain can use the project resource.
- When the sharing scope is “Domain share”, select the domains to share with.
  - When one or more domains are selected, the scope is Domain share - partial; only users in the owning domain and the shared domains can use the domain resource.
  - When all domains are selected, the scope is Domain share - all; all users in the system can use the project resource.
Click “OK” to finish.

Batch set sharing

In the host image list, select one or more host images, click “Set sharing” above the list to open the dialog.
Configure the following parameters:
- When the sharing scope is “Not shared”, the project resource is private and only users in this project can use it.
- When the sharing scope is “Project share”, select projects in the same domain that can be shared with.
  - When one or more projects in the same domain are selected, the scope is Project share - partial; only users in the owning project and the shared projects can use the project resource.
  - When all projects are selected, the scope is Project share - all; users in the resource’s domain can use the project resource.
- When the sharing scope is “Domain share”, select the domains to share with.
  - When one or more domains are selected, the scope is Domain share - partial; only users in the owning domain and the shared domains can use the domain resource.
  - When all domains are selected, the scope is Domain share - all; all users in the system can use the project resource.
Click “OK” to finish.

Change project

Change the owning project of a host image.

Change project for a single host image

On the Host Images page, click “More” in the Actions column for the image, then select “Change project” to open the dialog.
Select a domain and a project under it, then click “OK” to finish.

Batch change project

In the host image list, select one or more host images, click “Batch actions” above the list, then select “Change project” to open the dialog.
Select a domain and a project under it, then click “OK” to finish.

Set delete protection

Set delete protection for host images. When delete protection is enabled, the host image cannot be deleted; when it is disabled, the host image can be deleted.

Set delete protection for a single host image

Disable delete protection:
- When the host image name has a icon, click “More” in the Actions column for the host image, then select “Set delete protection” to open the dialog.
- Select “Disable” delete protection, then click “OK”.
Enable delete protection:
- When the host image name does not have a icon, click “More” in the Actions column for the host image, then select “Set delete protection” to open the dialog.
- Select “Enable” delete protection, then click “OK”.

Batch set delete protection

In the host image list, select one or more host images, click “Set delete protection” above the list to open the dialog.
Select “Enable” or “Disable” delete protection, then click “OK” to set delete protection for the selected host images in bulk.

Delete

Delete host images. If the host image name has a icon, delete protection is enabled and the host image cannot be deleted; disable delete protection first.

Administrators can delete all host images.

Domain administrators can delete only host images in their domain.

Project users can delete only host images in their project.

Delete a single host image

On the Host Images page, click “More” in the Actions column for the image, then select “Delete” to open the confirmation dialog.
Click “OK” to finish.

Batch delete

In the image list, select one or more images, click “Delete” above the list to open the confirmation dialog.
Click “OK” to finish.

View host image details

View detailed information about a host image.

On the Host Images page, click the host image name to open the details page.
The top menu on the details page supports management operations on the image.
View image information:

Category	Fields
Basic information	Cloud ID, ID, Name, Status, Domain, Project, Share scope, Type, Sub-images, Size, Created at, Updated at, Notes
Image attributes	Disk format, System language, Minimum memory, Minimum disk, Disk driver, NIC driver, Application platform
Multi-cloud image	Other format details including checksum, format, size, and status
Other	Enable or disable delete protection

View sub-image information

View sub-images of a host image. Saving a host image for a VM saves each disk of the VM as a sub-image.

On the Host Images page, click the host image name to open the details page.
Click the “Sub-images” tab.
View sub-image name, category, format, created at, and related information.

View host image operation logs

On the host image page, click the host image name to open details.
Click the “Operation logs” tab.
- Load more: 20 logs by default; click “Load more” for more
- View details: click “View” in the row actions
- Time filter: set start/end dates to query a time range
- Export logs: click the download icon to export logs on this page

Docs: Physical Machines

Mon, 01 Jan 0001 00:00:00 +0000

A physical machine is a physical server registered with IPMI information on the cloud management platform and fully managed and controlled by the platform. Physical machines are used to create bare metal devices; bare metal exclusively uses physical machine resources.

Supported server vendors and models for management include Dell, HP, Huawei, Inspur, Lenovo, Super Micro, and other mainstream x86 servers.

Entry: Left menu → Resource Management / Compute / Basic Resources / Physical Machines

The upper right of the list shows the total number of physical machines and counts for running, stopped, operation failed, and unknown statuses.

View the physical machine list

View information in the physical machine list.

In the cloud management platform, click the navigation menu in the upper left, then click “Resource Management / Compute / Basic Resources / Physical Machines” in the left menu to open the Physical Machines page.
View the following parameters:
- Enabled: Whether the physical machine can be used to create bare metal. Only enabled physical machines can create bare metal.
- Status: Running status of the physical machine.
- IP: Management IP and out-of-band IP. The out-of-band IP is the IPMI address.
- SN: Serial number and related information.
- Allocation: Whether the physical machine has been allocated to create bare metal; shows the bare metal name created on this physical machine.
- Initial account: Get the username and password used to connect to the physical machine.
- IPMI: IPMI username, password, and IP.
- Maintenance mode: Whether the physical machine has entered maintenance mode (the yunionos mini system).

Add a physical machine

The OneCloud platform currently supports four ways to add physical machines:

Hosted: Host an existing physical machine that already has an OS. After hosting succeeds, a bare metal record is also created.
Pre-register: Pre-rack servers that do not yet have BMC configured. Provide the server MAC address and BMC information to configure. After the server is set to PXE boot and powered on, the OneCloud Baremetal service responds to PXE requests matching the MAC, boots the server into the YunionOS mini system, collects server information, resets BMC information, and completes registration.
ISO boot registration: Immediately boot servers that already have BMC configured. Does not require a DHCP Relay network, but requires Redfish support. Verifies BMC configuration via the Redfish API, boots YunionOS, and collects more server configuration.
PXE boot registration: Immediately boot servers that already have BMC configured. Requires a DHCP Relay network and PXE boot. Verifies BMC via IPMI, boots YunionOS, and collects more server configuration.

Before adding physical machines, ensure the Baremetal service is enabled. If it is not, the Add button on the Physical Machines page is disabled. Follow Enable Baremetal to enable it, then refresh the browser.

YunionOS is a temporary OS booted via out-of-band control. In this OS you can configure RAID, deploy OS images, and more.

ISO boot registration

Immediately register and boot a server that already has BMC configured. Does not require DHCP Relay, but requires Redfish.

On the Physical Machines page, click “Add” to open the add page.
Select the domain and set the add method to “ISO boot registration”. Two modes are supported.
- Single entry: Configure the following parameters.
  - Specify domain: Select the domain the physical machine belongs to.
  - Physical machine name: Set the physical server name.
  - IPMI address: Enter the configured IPMI address.
  - IPMI username: Enter the configured IPMI username.
  - IPMI password: Enter the configured IPMI password. Incorrect BMC information prevents successful boot registration.
  - Management port IP: Select an IP subnet. To use a static IP, click “Configure IP manually”, set the address, then click “OK”. Because ISO boot registration fits environments without DHCP Relay, you must provide the IP subnet or IP for the management port.
  - Register only, do not boot: Do not reboot into YunionOS. When selected, only partial server information is collected; the server cannot create bare metal until you run Detect hardware configuration.
- Template import: Import an XLSX template that contains physical machine registration information.
  - Follow the preset format; download the template first.
  - Fill in physical machine information in the downloaded host_template.xlsx. Put all physical machine information on the same sheet.
  - Click the dashed box or drag the template file into it, then click “OK” to upload.
  - Register only, do not boot: Do not reboot into YunionOS. When selected, only partial server information is collected; the server cannot create bare metal until you run Detect hardware configuration.
Click “OK” to complete boot registration.

PXE boot registration

Immediately register and boot a server that already has BMC configured. Requires a DHCP Relay network.

On the Physical Machines page, click “Add” to open the add page.
Select the domain and set the add method to “PXE boot registration”. Two modes are supported.
- Single entry: Configure the following parameters.
  - Specify domain: Select the domain the physical machine belongs to.
  - Physical machine name: Set the physical server name.
  - IPMI address: Enter the configured IPMI address.
  - IPMI username: Enter the configured IPMI username.
  - IPMI password: Enter the configured IPMI password. Incorrect BMC information prevents successful boot registration.
  - Management port MAC: Set the management port MAC. Servers that support Redfish do not need this field.
  - Management port IP: Optional. Select an IP subnet; to use a static IP, click “Configure IP manually”, set the address, then click “OK”. Leave empty for DHCP allocation.
  - Register only, do not boot: Do not reboot into YunionOS. When selected, only partial server information is collected; the server cannot create bare metal until you run Detect hardware configuration.
- Template import: Import an XLSX template that contains physical machine registration information.
  - Follow the preset format; download the template first.
  - Fill in physical machine information in the downloaded host_template.xlsx. Put all physical machine information on the same sheet.
  - Click the dashed box or drag the template file into it, then click “OK” to upload.
  - Register only, do not boot: Do not reboot into YunionOS. When selected, only partial server information is collected; the server cannot create bare metal until you run Detect hardware configuration.
Click “OK” to complete boot registration.

Pre-register

Pre-rack servers that do not yet have BMC configured. Pre-register only configures related information; actual boot registration happens after the server is set to PXE boot and powered on. Requires a DHCP Relay environment.

If the server already has BMC configured and you choose pre-register, BMC information may be reconfigured during boot to the values set at pre-register time, which may change the server’s BMC settings.

On the Physical Machines page, click “Add” to open the add page.
Select the domain and set the add method to “Pre-register”. Three modes are supported.

Single entry: Configure the following parameters.
- Specify domain: Select the domain the physical machine belongs to.
- MAC address: MAC address of the physical machine.
- Physical machine name: Name of the physical machine.
- IPMI address: Set the IPMI address. If omitted and an IPMI IP subnet exists on the platform, the system allocates an IP automatically. For new machines, leave empty; for existing machines, set the previous IP.
- IPMI username: Set the IPMI management username. If omitted, the system defaults to root. For new machines, leave empty; for existing machines, set the previous username.
- IPMI password: Set the IPMI user password. If omitted, the default password is YunionDev@123. For new machines, leave empty; for existing machines, set the previous password.
- When finished, click “OK”.
Batch entry: Note the following.
- One line is one physical machine record; up to 100 records per import.
- Format: “MAC address,name,IPMI address,IPMI username,IPMI password”, separated by English commas “,”. If the password contains a Chinese comma “，”, use single entry instead.
- MAC address and name are required; other parameters can be omitted.
- Example: ee:b3:f4:48:1c:f5,gpuhost01,192.168.1.1,root,admin123
- Example: ee:b3:f4:48:1c:f5,gpuhost01,,, — omits IPMI address, username, and password
- When finished, click “OK”.
Template import: Import an XLSX template that contains physical machine registration information.
- Follow the preset format; download the template first.
- Fill in physical machine information in the downloaded host_template.xlsx. Put all physical machine information on the same sheet.
- Click the dashed box or drag the template file into it, then click “OK” to upload.

After pre-register configuration, an administrator must manually set the server to PXE boot and power it on; the server then completes registration automatically.

Hosted

Manage a server that already has an OS installed. Run the following command on the server so the cloud management platform can manage it; a bare metal server with the same OS configuration is also created in the bare metal list.

Before hosting a server, ensure:

IP subnets of IPMI type and physical machine type that cover the physical server have been created on the platform;
The physical server has BMC configured (IPMI address, username, password);
Port 2222 or a later port is open on the physical server; if 2222 is occupied, open a later port.

The domain of a hosted physical machine depends on the operating user.

On the Physical Machines page, click “Add” to open the add page.
Set the add method to “Hosted”, click “Click to copy”, and run the copied command on the physical machine to be managed.
During execution, enter the server IPMI username, password, IPMI IP address, and related information.
After completion, the managed physical machine appears in the list.

Remote control

Connect to a physical machine via SOL (Serial over LAN) or SSH. SOL is remote connection over a serial port. After connecting, log in with the username and password from the Initial account column.

On the Physical Machines page, click “Remote control” in the Actions column, then select “SOL remote control” to connect via SOL.
Click “Remote control” in the Actions column, then select “SSH IP address” to open a web SSH connection.
If port 22 is occupied and SSH uses another port, select “SSH IP address: custom port”, set the port in the dialog, then click “OK”.
Click “Remote control” in the Actions column, then select “Java console” to download and open the JNLP file and connect.

Enable

Enable a physical machine that is disabled. Enabled physical machines are used to create bare metal servers.

Enable one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Enable”.
Confirm the action.

Enable in batch

In the physical machine list, select one or more physical machine (disabled), then click “Enable” above the list.
Confirm the action.

Disable

Disable a physical machine that is enabled. Disabled physical machines cannot create bare metal servers.

Disable one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Disable”.
Confirm the action.

Disable in batch

In the physical machine list, select one or more physical machine (enabled), then click “Disable” above the list.
Confirm the action.

Adjust scheduling tags

Bind scheduling tags to a physical machine. Physical machines with scheduling tags are scheduled to create bare metal servers according to scheduling policies.

Adjust scheduling tags one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Adjust scheduling tags”.
Confirm the action.

Adjust scheduling tags in batch

In the physical machine list, select one or more physical machine, then click “Adjust scheduling tags” above the list.
Confirm the action.

Sync status

Sync the running status of the physical machine OS. Stopped physical machines do not support sync status.

Sync status one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Sync status”.
Confirm the action.

Sync status in batch

In the physical machine list, select one or more physical machine, then click “Sync status” above the list.
Confirm the action.

Install OS

Create a bare metal device.

Click “More” in the Actions column, then select “Install OS” to open the create bare metal page.
Set the following parameters:
- Name: Bare metal device name.
- Quantity and specification: Because bare metal exclusively uses the physical machine, quantity and specification cannot be changed.
- Operating system:
  - Public image: Linux public images in the system image list, maintained by administrators.
  - Custom image: Linux custom images in the system image list, usually uploaded by users.
  - Boot from ISO: Linux OS images in ISO format in the system image list. When selecting an ISO, the user must install the OS for the bare metal server.
- Disk configuration: Click “Add disk” to open the create disk configuration dialog.
  - Select the disk type on the physical machine (HDD:3.6TiB means a 3.6 TiB HDD), set RAID (No RAID, RAID0, RAID1, RAID5, RAID10)
  - Set the disk count, that is, how many disks of the same configuration are used for RAID. RAID0 uses 100% of disk capacity; RAID1 with 2 disks uses 50%; RAID5 with 3 or more disks uses (n-1)/n; RAID10 with 4 or more disks uses 50%.
    - RAID0 and No RAID have no disk count requirement;
    - RAID1 requires at least 2 identical disks;
    - RAID5 requires at least 3 identical disks;
    - RAID10 requires at least 4 identical disks;
  - After RAID configuration, partition names and sizes are shown. You can modify partitions on the UI: click the yellow “System partition” area or the “Pending partition” area. Partition parameters:
    - Mount point: Partition mount point; the system partition defaults to “/”.
    - Partition format: ext4, xfs, ntfs, or swap.
    - Partition size: Maximum capacity or manual input. Maximum capacity uses all disk space; manual input sets size in GB.
- Network: Set the bare metal IP address. When two NICs connected by cable need bonding, select “Enable bonding”.

When a physical machine has exactly two cabled NICs, they are bonded automatically. When there are more than two cabled NICs, bonding results are unpredictable; proceed with caution.

 - **Specify IP subnet**: Select an IP subnet. To use a static IP, click “Configure IP manually”, set the address, then click “OK”.
- **Specify scheduling tags**: Set scheduling tags and preferences. Preferences override the default strategy on the tag. The optimal IP subnet is chosen by tags and preferences.
- **Administrator password**: Set the administrator password (root on Linux, administrator on Windows).
- **Random generate**: Generate a random password; users can view and copy it in the password column of the physical machine list.
- **Associate key**: Linux only. Create an SSH key under “Network - Keys” first. After association, log in with the SSH key pair.
- **Keep image settings**: Use the administrator password already in the image.
- **Manual input**: Set the administrator password manually.
- **Description**: Set remarks for the bare metal.

Click “Create” to create the bare metal device.

Convert to host

Convert a physical machine to a host. Physical machines create bare metal servers; hosts create VMs.

Preparation

A host is a compute node with the host service installed. When converting a physical machine to a host on the cloud management platform, use the dedicated host image provided by our company.
Upload that image to the management platform and record its image ID.
On the control node, use climc to set the default image for converting physical machines to hosts.

# Set the default image ID
$ climc service-config --config convert_hypervisor_default_template=a9b67435-8c08-4063-8ea6-d885ea26aa79 region2

When converting, you can select disk RAID settings directly, or use custom settings to choose the host image.

Steps

On the Physical Machines page, click “More” in the Actions column, then select “Convert to host”. The convert to host dialog appears.
Configure the following parameters:
- Host name: Defaults to the physical machine name; can be changed.
- Host type: Currently only KVM hosts are supported.
- Disk RAID configuration: Default (highest redundancy), RAID-1/RAID-10 (2× redundancy), RAID-5 (1.x× redundancy), RAID-0 (no redundancy), or custom.

When the physical machine has only one RAID controller and that controller has 4 or more identical disks, all options above are supported;

When disk RAID configuration is not “Custom”, the image used for conversion is the one set in region.conf on the control node, and NIC bonding is not supported.

When disks of different sizes exist on the physical machine, only custom configuration is supported;

- When selecting Default (highest redundancy), RAID-1/RAID-10 (2× redundancy), RAID-5 (1.x× redundancy), or RAID-0 (no redundancy), configure network information and whether to enable bonding.
- **Network**: Set the host IP address. When two cabled NICs need bonding, select “Enable bonding”.

When a physical machine has exactly two cabled NICs, they are bonded automatically. When there are more than two cabled NICs, bonding results are unpredictable; proceed with caution.

 - **Specify IP subnet**: Select an IP subnet. To use a static IP, click “Configure IP manually”, set the address, then click “OK”.
- **Specify scheduling tags**: Set scheduling tags and preferences. Preferences override the default strategy on the tag. The optimal IP subnet is chosen by tags and preferences.
- When selecting custom configuration, choose a disk image, add disks in custom disk configuration, select disks and RAID, set network information, and choose whether to bond.
- **Image**: For custom settings, set the image to the dedicated host image.
- **Custom disk configuration**: Click “Add disk” to open the create disk configuration dialog.
- Select the disk type on the physical machine (HDD:3.6TiB means a 3.6 TiB HDD), set RAID (No RAID, RAID0, RAID1, RAID5, RAID10)
- Set the disk count for RAID. RAID0 uses 100% of disk capacity; RAID1 with 2 disks uses 50%; RAID5 with 3 or more disks uses (n-1)/n; RAID10 with 4 or more disks uses 50%.
- RAID0 and No RAID have no disk count requirement;
- RAID1 requires at least 2 identical disks;
- RAID5 requires at least 3 identical disks;
- RAID10 requires at least 4 identical disks;
![RAID configuration](/docs/en/docs/web_ui/images/computing/raid.png)
![Partition configuration](/docs/en/docs/web_ui/images/computing/partition.png)
- Click “OK” to show partition names and sizes. You can modify partitions on the UI: click the yellow “System partition” area or the “Pending partition” area. Partition parameters:
- **Mount point**: Partition mount point; the storage pool default is “/opt/cloud/workspace”.
- **Partition format**: ext4, xfs, ntfs, or swap.
- **Partition size**: Maximum capacity or manual input. Maximum capacity uses all disk space; manual input sets size in GB.
![Create partition](/docs/en/docs/web_ui/images/computing/createpartition.png)
- **Network**: Set the host IP address. When two cabled NICs need bonding, select “Enable bonding”.

When a physical machine has exactly two cabled NICs, they are bonded automatically. When there are more than two cabled NICs, bonding results are unpredictable; proceed with caution.

 - **Specify IP subnet**: Select an IP subnet. To use a static IP, click “Configure IP manually”, set the address, then click “OK”.
- **Specify scheduling tags**: Set scheduling tags and preferences. Preferences override the default strategy on the tag. The optimal IP subnet is chosen by tags and preferences.

Click “OK” to convert the physical machine to a host.

Verify IPMI information

Verify whether IPMI information is configured correctly and whether IPMI over LAN is enabled. When management fails due to IPMI configuration issues, after you fix IPMI settings you can use Verify IPMI to check them; if correct, the physical machine is managed again.

Verify IPMI information one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Verify IPMI information”.
Confirm the action.

Verify IPMI information in batch

In the physical machine list, select one or more physical machine, then click “Verify IPMI information” above the list.
Confirm the action.

Detect hardware configuration

Sync and obtain hardware configuration of the physical machine. When you selected “Register only, do not boot” while adding, use Detect hardware configuration so the physical machine can be used normally.

Detect hardware configuration one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Detect hardware configuration”.
Confirm the action.

Detect hardware configuration in batch

In the physical machine list, select one or more physical machine, then click “Detect hardware configuration” above the list.
Confirm the action.

Power on

Power on a physical machine that is stopped.

Power on one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Power on”.
Confirm the action.

Power on in batch

In the physical machine list, select one or more physical machine (stopped), then click “Power on” above the list.
Confirm the action.

Power off

Power off a physical machine that is running. Not supported when the physical machine is already allocated to bare metal.

Power off one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Power off”.
Confirm the action.

Power off in batch

In the physical machine list, select one or more physical machine (running), then click “Power off” above the list.
Confirm the action.

Enter maintenance mode

Put a physical machine that has been allocated to bare metal into the offline system (yunionos network-boot mini system). In the offline system, administrators can change partitions, rebuild RAID, change passwords, and more. Unallocated physical machines are already in the offline system by default.

Enter maintenance mode one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Enter maintenance mode”.
Confirm the action.

Enter maintenance mode in batch

In the physical machine list, select one or more physical machine, then click “Enter maintenance mode” above the list.
Confirm the action.

Exit maintenance mode

Exit maintenance mode.

Exit maintenance mode one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Exit maintenance mode”.
Confirm the action.

Exit maintenance mode in batch

In the physical machine list, select one or more physical machine, then click “Exit maintenance mode” above the list.
Confirm the action.

Delete

Delete a physical machine. Only unallocated and disabled physical machines can be deleted.

Delete one

On the physical machine page, click “More” in the row actions for the target physical machine, then choose “Delete”.
Confirm the action.

Delete in batch

In the physical machine list, select one or more physical machine, then click “Delete” above the list.
Confirm the action.

Tag management

See Multi-cloud Management - Tag Management.

View physical machine details

View detailed information about a physical machine.

On the Physical Machines page, click a physical machine name to open details.
The top menu supports remote control, enable, disable, adjust tags, sync status, install OS, convert to host, detect hardware configuration, power on, power off, enter maintenance mode, exit maintenance mode, delete, and more.
View physical machine details.
- Basic info: Cloud ID, ID, name, status, domain, project, share scope, enabled status, maintenance mode, IP, allocation, MAC address, scheduling tags, host version, hardware virtualization, ISO boot, region, availability zone, cloud account, created at, updated at, and description.
- Brand info: Brand name, model, and serial number.
- CPU: CPU cores, sockets, overcommit ratio, current overcommit ratio, and description.
- Memory: Memory capacity, system reserved, overcommit ratio, and current overcommit ratio.
- Storage: Storage capacity, type, current overcommit ratio, invalid storage, and adapter information.
- Network interfaces: All NIC information: IP address, MAC address, subnet mask, type, and speed.

View bare metal server information on the physical machine

View bare metal servers on the physical machine and manage them.

On the physical machine details page, click the “Bare metal servers” tab.
View bare metal server information and manage them. For details, see Bare metal.

View physical machine network information

View network information of the physical machine.

On the physical machine details page, click the “Network” tab.
View network information: index, MAC address, NIC type, IP address, IP subnet, and Layer 2 network. A green MAC indicates the cable is plugged in.
When a NIC has no allocated IP, you can set a Layer 2 network. Click “Set Layer 2 network” in the Actions column, select a Layer 2 network in the dialog, then click “OK”.

View physical machine storage information

View storage information on the physical machine.

On the physical machine details page, click the “Storage” tab.
View storage information: name, capacity, allocated, wasted, storage type, enabled, and mount point.

View physical machine GPUs

View GPU devices on the physical machine.

On the physical machine details page, click the “GPU” tab.
View GPU information: device type, device model, and physical machine.

View physical machine monitoring

View monitoring information for the physical machine.

On the physical machine details page, click the “Monitoring” tab.
View the following monitoring information.
- Line charts for the last 1 hour, 3 hours, and 6 hours: CPU usage, system load, memory usage, memory usage details, disk usage, disk usage details, disk IO usage, disk IOPS, network inbound traffic, and network outbound traffic.
  - CPU usage: CPU usage, CPU idle, user-space CPU, kernel-space CPU, and I/O wait share.
  - System load: 1/5/15-minute average load, and average load per CPU core for 1/5/15 minutes.
  - Memory usage: Memory used, free, and total.
  - Disk usage: Disk used, free, and total.
  - Disk IOPS: Average read IOPS and write IOPS per second.
You can set monitoring alerts for the metrics above.
- Click “Set monitoring alert” to the right of a metric. The create monitoring alert dialog appears.
- The metric is fixed. Set query period, comparison operator, threshold, alert level, alert method, and recipients, then click “OK” to create the alert.

View physical machine hardware logs

View hardware logs of the physical machine.

On the physical machine details page, click the “Hardware logs” tab.
Set an end time to query hardware logs before that time.
When there are many logs, click “Load more” below the list.

View physical machine operation logs

On the physical machine page, click the physical machine name to open details.
Click the “Operation logs” tab.
- Load more: 20 logs by default; click “Load more” for more
- View details: click “View” in the row actions
- Time filter: set start/end dates to query a time range
- Export logs: click the download icon to export logs on this page

Docs: App Packages

Mon, 01 Jan 0001 00:00:00 +0000

App packages are software packages used to create container hosts, in tar.gz format. The platform manages them as an image resource type, and you can select them when creating container hosts.

Entry: On the cloud management platform, click the navigation menu in the upper left, then in the left sidebar click “Resource Management / Compute / Images / App Packages” to open the App Packages page.

Upload an app package

Upload a local tar.gz app package to the platform.

Note: Only the tar.gz format is supported. Do not refresh or close the page during upload, or the upload will be interrupted.

On the App Packages page, click the “Upload” button to open the upload dialog.
Set the name, select the tar.gz file, and choose the project.
Click the “OK” button to start uploading.

Export an app package

On the App Packages page, click the “Export” button in the Actions column to download the package file.

Delete an app package

On the App Packages page, click the “Delete” button in the Actions column and confirm to delete.
You can also select multiple app packages and delete them via “Batch Actions”.

Docs: Baremetal

Mon, 01 Jan 0001 00:00:00 +0000

Baremetal is a compute instance that exclusively uses one physical machine. Unlike VMs that share a host, baremetal runs directly on the physical machine and fits scenarios that need performance isolation or hardware passthrough.

Baremetal sources:

Create baremetal on the cloud management platform from managed physical machines.
Sync baremetal instances after connecting cloud accounts.

Entry: On the cloud management platform, click the navigation menu in the upper left, then in the left sidebar click “Resource Management / Compute / Instances / Baremetal” to open the Baremetal page.

Tip: Before creating baremetal, manage and enable the corresponding physical machine under Physical Machines.

Create baremetal

Create a baremetal instance in the local IDC.

On the Baremetal page, click the “Create” button to open the create baremetal wizard.
Configure project, region, name, image, network, disks, and related parameters. Images can be VM images or ISOs from system images.
Confirm the configuration and click “OK”. The platform deploys baremetal on the specified physical machine.

Remote control

On the Baremetal page, click the “Remote control” button in the Actions column.
Choose SOL, JNLP, or SSH based on your network.

Instance state

Supports power on, power off, restart, and related power operations. Click “More” in the Actions column, then choose the corresponding action under “Instance state”.

Other operations

Action	Description
Sync status	Sync the current baremetal status from the underlying layer
Reinstall OS	Reinstall the OS with a specified image
Create same configuration	Create another instance with the same configuration as the current baremetal
Reset password / Bind or unbind key	Manage login credentials
Mount / Unmount ISO	Mount or unmount an ISO image via the optical drive
Delete	Delete the baremetal instance without deleting the underlying physical machine

View baremetal details

Click the name on the Baremetal page to open the details page and view basic info, NICs, disks, monitoring, and operation logs.

Docs: Image Registries

Mon, 01 Jan 0001 00:00:00 +0000

Image registries store the access URL and credentials of container image registries so that container hosts can pull images when created.

Note: This menu is under Resource Management / Compute / Images / Image Registries, and no longer appears under the Kubernetes menu.

Entry: On the cloud management platform, click the navigation menu in the upper left, then in the left sidebar click “Resource Management / Compute / Images / Image Registries” to open the Image Registries page.

Create an image registry

Create an image registry record with the registry URL and credentials.

On the Image Registries page, click “Create” to open the create dialog.
Set the following parameters:

Parameter	Description
Project	Select the owning project of the image registry
Name	Set the image registry name
URL	Set the registry access URL in the form `https://registry-address` or `http://registry-address`
Credentials	When the registry requires authentication, set the username and password

Click “OK” to finish.

Modify attributes

Modify attribute information of an image registry.

On the Image Registries page, click “More” in the Actions column for the registry, then select “Modify attributes” to open the dialog.
The following parameters can be modified:

Parameter	Description
Name	Set the image registry name
URL	Set the registry access URL
Credentials	Change the username and password required to access the registry

Click “OK” to finish.

Change project

Change the owning project of an image registry.

Change project for a single image registry

On the Image Registries page, click “More” in the Actions column for the registry, then select “Change project” to open the dialog.
Select a domain and a project under it, then click “OK” to finish.

Batch change project

In the image registry list, select one or more registries, click “Batch actions” above the list, then select “Change project” to open the dialog.
Select a domain and a project under it, then click “OK” to finish.

Set the share scope of an image registry. Only custom image registries support setting sharing.

Project resources have five share scopes:

Not shared (private): Only users in this project can use the project resource.
Project share - partial (multi-project share within the domain): The project resource can be shared with one or more specified projects in the same domain. Only users in the owning project and the shared projects can use it.
Project share - all (domain-wide share): The project resource can be shared with all projects in the domain, so users in the resource’s domain can use it.
Domain share - partial (multi-domain share): The project resource can be shared with one or more specified domains. Only users in the owning domain and the shared domains can use it.
Domain share - all (global share): The project resource can be shared with all domains, so all users in the system can use it.

Conditions for setting domain sharing:

Three-level permissions are enabled on the OneCloud platform.

The user is in the Admin Console.

Conditions for setting project sharing:

The user is in the Admin Console or Domain Admin Console.

Set sharing for a single image registry

On the Image Registries page, click “More” in the Actions column for the registry, then select “Set sharing” to open the dialog.
Configure the following parameters:
- When the sharing scope is “Not shared”, the project resource is private and only users in this project can use it.
- When the sharing scope is “Project share”, select projects in the same domain that can be shared with.
  - When one or more projects in the same domain are selected, the scope is Project share - partial; only users in the owning project and the shared projects can use the project resource.
  - When all projects are selected, the scope is Project share - all; users in the resource’s domain can use the project resource.
- When the sharing scope is “Domain share”, select the domains to share with.
  - When one or more domains are selected, the scope is Domain share - partial; only users in the owning domain and the shared domains can use the domain resource.
  - When all domains are selected, the scope is Domain share - all; all users in the system can use the project resource.
Click “OK” to finish.

Batch set sharing

In the image registry list, select one or more registries, click “Batch actions” above the list, then select “Set sharing” to open the dialog.
Configure the following parameters:
- When the sharing scope is “Not shared”, the project resource is private and only users in this project can use it.
- When the sharing scope is “Project share”, select projects in the same domain that can be shared with.
  - When one or more projects in the same domain are selected, the scope is Project share - partial; only users in the owning project and the shared projects can use the project resource.
  - When all projects are selected, the scope is Project share - all; users in the resource’s domain can use the project resource.
- When the sharing scope is “Domain share”, select the domains to share with.
  - When one or more domains are selected, the scope is Domain share - partial; only users in the owning domain and the shared domains can use the domain resource.
  - When all domains are selected, the scope is Domain share - all; all users in the system can use the project resource.
Click “OK” to finish.

Delete

Delete image registries.

Administrators can delete all image registries.

Domain administrators can delete only image registries in their domain.

Project users can delete only image registries in their project.

Delete a single registry

On the Image Registries page, click “More” in the Actions column for the registry, then select “Delete” to open the confirmation dialog.
Click “OK” to finish.

Batch delete

In the image registry list, select one or more registries, click “Batch actions” above the list, then select “Delete” to open the confirmation dialog.
Click “OK” to finish.

View image registry details

View detailed information about an image registry.

On the Image Registries page, click the registry name to open the details page.
The top menu on the details page supports management operations on the registry.
Review basic information, including ID, name, status, domain, project, share scope, URL, created at, updated at, and notes.

View image list

View the list of images contained in the image registry.

Tip: Currently only open-source Docker Registry is supported for listing images in a registry.

On the image registry details page, click the “Image list” tab.
View image information in the registry, including image name, tags, size, and more.

View image registry operation logs

On the image registry page, click the image registry name to open details.
Click the “Operation logs” tab.
- Load more: 20 logs by default; click “Load more” for more
- View details: click “View” in the row actions
- Time filter: set start/end dates to query a time range
- Export logs: click the download icon to export logs on this page

Docs: Image Market

Mon, 01 Jan 0001 00:00:00 +0000

Image Market

The image market provides prebuilt images from OneCloud. Users cannot modify them.

VM image market

Supports importing VM images. VM images include Not imported and Imported pages:

Page	Description
Not imported	Shows images from OneCloud that have not been imported. Each image includes OS, image format, image size, distribution, release version, architecture, file size, and update date
Import image	Imports an image from the Not imported page into the cloud management platform and shows it on the Imported page. Images imported from the image market are public images by default
Imported	Shows all images imported from the image market into the image list
Cancel import	The image market does not currently support canceling an import. You can delete a marketplace-imported image from the image list; it then moves from the Imported page back to the Not imported page

ISO image market

Supports importing ISO images. ISO images also include Not imported and Imported pages, with the same display content and import method as VM images.

Tip: For system images imported as VM or ISO images, you can view import progress in the list status.