Cloudpods – Image

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: 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: 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