DocsKnowledge BaseAPI Explorer
Documentation›HCI›Flagship Edition›Explore more›Installation and Deployment Tutorial
HCI

Overview

This tutorial describes how to install ZStack Cube Ultimate Edition with SDDC Manager and complete product initialization.

Scope

This tutorial applies to the following product and tool versions:

  • ZStack Cube Ultimate Edition 2.5.4.16.
  • SDDC Manager 1.1.0.

ZStack Cube Ultimate Deployment Scenarios

ZStack Cube Ultimate uses ZCF (ZStack Cloud Foundation) as its virtualization foundation and supports the following storage products:

  • ZStone
  • ZCE
  • ZBS

The products are delivered through the unified Cube management UI. Product versions and management node configuration must match the delivery plan for this version of ZStack Cube Ultimate.

About the Tutorial

This tutorial uses ZCF + ZStone as the deployment example. The example settings are as follows:

Item Example setting

Products and delivery
  • ZCF: ZStack Cloud 5.4.16.
  • ZStone: version 5.5.12.

Hosts and management mode
  • Hosts: three hosts with the same CPU architecture, cube-node-1, cube-node-2, and cube-node-3.
  • Management mode: shared management nodes in single-node mode, with cube-node-3 as the management node.
  • Roles: all three hosts provide compute and storage services.

Networks
  • Management: configure each host with its planned management IP.
  • Storage: reuse the management network.
  • Business networking: Create it in ZStack Cube Ultimate after installation, following Create Network, rather than through SDDC.

Disks and storage pool
  • System disks: keep vda as the system disk on each host.
  • Data disks: use vdb and vdc as raw data disks on each host.
  • Storage pool: assign all six data disks to pool-hdd, with three replicas and the Server failure domain.

Use the disk names detected on the actual hardware.

When using this tutorial, note the following:

  • These settings illustrate one complete wizard configuration. Plan management HA, dedicated storage and business networks, and disks according to actual production delivery requirements.
  • This example does not create business networks through SDDC. After product installation, follow ZStack Cube Ultimate's initialization wizard and the Create Network chapter.
  • Hostnames, addresses, and disk information in screenshots illustrate the pages. Match each host to the site plan using the recorded device SN and MAC. After changing hostnames on Configure System, continue to identify hosts by device SN.

Procedure

  1. Preparing for Deployment
  2. Configuring the Controller
  3. Installing Server Operating Systems: follow this stage if OS installation is needed. Skip it if all target servers already run the matching OS and SDDC Agent.
  4. Deploying ZStack Cube Ultimate
  5. Initialization by Wizard

Preparing for Deployment

Preparation Checklist

Before deploying ZStack Cube Ultimate Edition 2.5.4.16, prepare the devices, packages, and network plan below.

Item Description Detailed Requirements
Controller A device running SDDC deployment services, either a separate controller or a target server. Prepare the Controller
SDDC Manager package The software package providing the PXE installation and Manager product deployment tools used in this tutorial. Prepare the SDDC Manager Package
Servers The devices running ZCF and the storage product. The interface calls them hosts; this example uses three servers with the same CPU architecture. Prepare the Servers
Operating system images Matching customized operating system images, required when OS installation is needed. Prepare the OS Images
ZCF and ZStone installation packages Installation files for ZCF and its storage product: the ZStack Cloud 5.4.16 ISO and ZStone 5.5.12 tar.gz package in this example. Prepare the ZCF and ZStone Installation Packages
Network plan Settings for PXE installation, server discovery, ZCF/ZStone management and storage, and subsequent business network creation. Prepare the Network

Prepare the Controller

Prepare a device to run SDDC services according to the deployment method:

  • Separate controller: use a physical machine or virtual machine running Windows or macOS.
  • Server acting as controller: select a Linux target server that already runs the matching customized OS.

Windows 11 x64 and macOS 13 or later are recommended.

  • Administrative permissions: ensure that you have the permissions required to run and manage SDDC Manager.
  • Network connectivity: ensure that the controller can access the servers through the deployment network.
  • Storage: reserve enough disk space for installation packages and image files.

Prepare the SDDC Manager Package

Contact official technical support for the matching SDDC Manager package, and verify the following:

  • The package supports the controller operating system.
  • The package supports the controller CPU architecture.

Prepare the Servers

Prepare servers according to the delivery requirements of this ZCF release and the selected storage product, and check the following:

  • Hardware: check CPU architecture, CPU and memory resources, disks, NICs, hardware virtualization settings, and the hardware clock.
  • Device records: record each server's device SN, PXE NIC MAC address, current hostname, and planned hostname.
  • Data backup: back up operating systems and disk data that must be retained.
  • Boot requirements: when using PXE, ensure that the servers support booting from the connected NIC and disable Secure Boot. Use the same CPU architecture within one OS installation batch and one product deployment.
  • Disk preparation: identify system, cache, and data disks, and record each disk's name, capacity, model, and RAID/passthrough mode. Configure ZStone data disks for passthrough/JBOD according to the storage plan and keep them separate from system disks.

Prepare the OS Images

Appliance servers may have a preinstalled OS. Check that the OS matches this deployment and that SDDC Agent is running. If OS installation is required, contact official technical support for the supplied OS image for this ZCF＋ZStone deployment. After installation, the servers run SDDC Agent for discovery and management by Manager.

  • CPU architecture: the image supports the CPU architecture of the servers in this batch.
  • Boot mode: the image supports the servers' actual boot mode and matches the PXE installation settings.
  • Product compatibility: the image meets the deployment requirements of this ZCF and ZStone release.
  • Difference from the product ISO: the OS image and ZCF product ISO serve different purposes. Obtain them separately.

Prepare the ZCF and ZStone Installation Packages

Contact official technical support for the following installation packages and checksums for release 2.5.4.16:

Product Files used in this example

ZCF

ZStack Cloud 5.4.16 iso package.

ZStone

ZStone 5.5.12 tar.gz package.

Prepare the Network

Plan the networks used for deployment and those used by the products.

Networks for Deployment

  • Page access: prepare a controller IPv4 address reachable from the browser for the Manager and PXE pages.
  • Server discovery and communication: keep IPv6 enabled on wired NICs between the controller and servers, and allow mDNS multicast for Manager server discovery and SDDC Agent communication.
  • PXE installation: if OS installation is required, select a controller NIC on the same Layer 2 network as the target servers' PXE NICs. Plan its IPv4 address, subnet mask, VLAN, and DHCP address pool. Use the same subnet as the PXE address, exclude occupied addresses and the network and broadcast addresses, and provide enough addresses for the batch.
Note: When using PXE for OS installation, ensure that no conflicting DHCP service runs on the installation network.

Allow the deployment ports below. PXE ports are required only when using PXE for OS installation.

Connection Port Purpose
Browser to controller TCP 10016 Manager product deployment page.
Browser to controller TCP 10018 PXE OS installation page.
Target server to controller PXE address TCP 10019 Network boot, installation content download, discovery, and installation result reporting.
Target server and PXE service UDP 67, 69 DHCP and TFTP network boot.
Controller to server TCP 10017 SDDC Agent communication.

Product deployment also requires access to the servers' SSH TCP port (default: 22). Use the actual port specified in Configure System.

Networks for Product Operation

Plan the following networks according to the delivery plan, and record the required NIC and address settings:

  • ZCF management network: used to manage hosts and access the ZStack Cube Ultimate management interface. Record each host's NIC name and MAC address, management IP, subnet mask, gateway, VLAN, and Bond settings.
  • ZStone storage network: used for storage I/O and communication between nodes. When reusing the management network, use its settings. For dedicated storage networks, plan the NICs, addresses, subnet masks, VLANs, and bonds for the public and cluster networks, and record the storage gateway CIDR.
  • VM business network: used for VM business traffic. Prepare the compute node NICs, VLANs, VM subnets, gateways, and DNS servers. After product initialization, configure L2 and L3 networks as described in Create Network.
  • Migration network: plan a separate network if needed and confirm which network will carry VM migration traffic.

Check switch ports, VLANs, NIC bonding, and redundancy against the delivery plan, and ensure consistent server and switch settings. At least dual Gigabit links are recommended for management and business networks, and dual 10 Gigabit links for storage networks.

Record the Deployment Plan

Record and review the following information before starting. Match each host by device SN when entering settings at each step. The three nodes, single management node, reused management network, and disk configuration are tutorial examples; use the approved delivery plan for production.

Planning item Information to record

Hosts and roles
  • Host identity: SN, PXE MAC, current and planned hostnames, and CPU architecture for identifying servers in PXE and Manager.
  • Roles: ZCF compute roles and ZStone Management, Monitor, Data, and Gateway roles for each host.
  • Management: product management node assignment, count, and hosts, plus management VIPs for dual-node plans. This example uses the shared single management node cube-node-3.

Disks
  • Disks: system, cache, and data disk names, capacities, models, and RAID/passthrough mode.
  • Storage pools: names, replica counts, failure domains, and disk assignments for ZStone pools and their ZCF primary storage and backup storage associations. This example uses pool-hdd.

Addresses and networks
  • Controller: page access address, PXE NIC, PXE service address, subnet mask, VLAN, and DHCP address pool.
  • Host management network: each host NIC name/MAC, management IP, subnet mask, gateway, and VLAN/Bond settings for By Host entries on Configure Network.
  • Storage and business networks: record whether ZStone reuses the management network. Record business NICs, VLANs, IP range or CIDR, gateway, and DNS for Create Network; see the network checklist above.

Ensure that the planned addresses are not already in use.

System and access
  • Host access: the current root password and the same actual SSH port on all hosts for connectivity checks on Configure System. The default port is 22.
  • System services: NTP source IPv4 addresses and DNS addresses reachable from the servers for Configure System.
  • Product credentials: administrator and database passwords for Configure Products; Recommended Configuration does not generate them. The administrator password is also used to log in to ZStack Cube Ultimate afterward.
  • Handover: agree on handover of host and product credentials and storage locations for deployment reports, planning records, and acceptance records.

Configuring the Controller

After Preparing for Deployment, configure the controller network and start Manager to deploy ZCF and storage products. Also configure and start PXE when installing server operating systems through PXE.

Use the local console on a separate Windows or macOS controller. When a target server acts as the controller, use the command line on the Linux server running the matching customized OS.

Windows / macOS (Separate Controller)

  1. Extract the SDDC Manager package obtained during preparation to a writable directory. Preserve all included directories and files, including bin and assets.

  2. Open the extracted bin directory.

    • Windows: double-click sddc-console.exe.
    • macOS: double-click sddc-console.

    Wait for the local console to open in the browser.

  3. Complete the required operating system authorization. Review the current network in the console and verify NICs, MAC addresses, and IPv4 addresses. If status cannot be determined, click Authorization check, then Rescan.

  4. Configure and start Manager.

    If the Manager card shows Running and its network settings do not need changing, no restart is needed. Otherwise, follow the relevant case below:

    • To use the controller's existing IPv4 address, click Start Manager on the Manager card and complete operating system authorization.
    • To configure a static IPv4 address on the deployment NIC, click Initialize and start on the Manager card, select static IPv4 configuration, and enter the NIC, IPv4 address, subnet mask, and optional VLAN. Review the changes, then confirm and start.

  5. Configure and start PXE if needed.

    When using PXE for OS installation, follow the relevant case below. If the PXE card already shows Running and the installation network remains unchanged, no restart is needed:

    • For first use of PXE, click Initialize and start on the PXE card. Enter the network parameters in the table below, review the changes, then confirm and start.
    • If PXE was initialized previously and the installation NIC, address, and address pool remain unchanged, click Start PXE.
    • To change the installation NIC, address, or address pool, run Initialize and start again.
    PXE Network Parameter Instructions
    NIC
    • Select a wired NIC on the same Layer 2 network as the target servers and verify its MAC address.
    • A dedicated installation network is recommended to avoid affecting the management connection.
    IPv4 address and subnet mask Enter the controller IPv4 address and subnet mask on the installation network in their separate fields. Do not add a CIDR suffix in the IPv4 address field.
    VLAN ID
    • With VLAN tagging: follow the switch and NIC plan.
    • Without VLAN tagging: select untagged operation.

    Changing a Windows NIC's VLAN may affect its other connections. Verify the NIC purpose first.
    DHCP address pool
    • Use the same subnet as the PXE address.
    • Exclude addresses used by the controller or other devices, the network address, and the broadcast address.
    • Ensure that no conflicting DHCP service runs on this installation network.

  6. Check the services and open their pages.

    Wait until the Manager card shows Running, then click Open service. When using PXE, also confirm that its card shows Running and open its service page.

    • Manager: http://127.0.0.1:10016/.
    • PXE: http://127.0.0.1:10018/.

    These addresses are for access from the controller itself. From another device, replace 127.0.0.1 with the controller's reachable IPv4 address and ensure that the corresponding ports are accessible. Once services are ready, continue to Installing Server Operating Systems if OS installation is needed. If all target servers already run the matching OS and SDDC Agent, continue to Deploying ZStack Cube Ultimate.

Note: The portable edition does not start automatically with the operating system. Keep the controller powered on during deployment. After sleep or restart, check and start the required services again.

Linux (Server Acting as Controller)

  1. Check SDDC Manager.

    sddc-manager version
    • Version displayed: confirm that it is the matching version for this deployment before proceeding.
    • Command not found: Use the matching RPM package for the current system and run the following command with the actual file path:
      sudo rpm -Uvh "<path-to-SDDC-Manager-RPM>"

      Run sddc-manager version again to confirm that the command is available.

  2. Configure the Manager network.

    For first use, run the Manager initialization command:

    sudo sddc-manager init
    1. Select the Manager NIC and enter the planned IPv4 address, subnet, gateway, DNS, and optional VLAN. Review and confirm the settings.
    2. Answer No to Enable PXE?. If PXE installation is needed, configure it separately in the next step.

    If Manager was initialized previously and its network settings do not need changing, continue to the next step.

  3. Configure the PXE installation network if needed.

    If all target servers already run the matching OS and SDDC Agent, skip PXE configuration and check and start Manager. For first use of PXE installation, run:

    sudo sddc-manager pxe init
    1. Select the PXE NIC on the same Layer 2 network as the target servers.
    2. Enter the PXE IPv4 address, subnet mask, optional VLAN, and DHCP address pool planned in Prepare the Network.
    3. Review and confirm the network settings, then wait for PXE initialization to finish.

    If PXE was initialized previously and the installation network remains unchanged, skip initialization and check the service status.

  4. Check and start the services.

    • Check Manager:

      sudo sddc-manager status

      If Manager is not running, run:

      sudo systemctl start sddc-manager.service

      Run the status command again to confirm that Manager is ready.

    • When using PXE for OS installation, check PXE:

      sudo sddc-manager pxe status

      If PXE is not running, run:

      sudo sddc-manager pxe serve

      Run the status command again to confirm that PXE is ready.

  5. Open the service pages.

    In a browser, use the controller's reachable IPv4 address to open:

    • Manager: http://<controller-IPv4>:10016/.
    • PXE: http://<controller-IPv4>:10018/.

    Once services are ready, continue to Installing Server Operating Systems if OS installation is needed. If all target servers already run the matching OS and SDDC Agent, continue to Deploying ZStack Cube Ultimate.

Installing Server Operating Systems

Prerequisites

Note: If all target servers have the matching operating system installed and SDDC Agent running, skip this chapter and continue to Deploying ZStack Cube Ultimate.
Warning: Starting installation formats the selected system disks. Verify the target hosts and disks and back up any data that must be retained.

Complete Preparing for Deployment to obtain the supplied OS image and prepare the servers and PXE network. Configure the PXE network and start the PXE service as described in Configuring the Controller.

About this task

Use PXE to install the customized operating system on the target hosts: the servers selected for OS installation. The term “node” on pages or in reports refers to the same devices.

Procedure

  1. Import and Confirm Installation Media

    Prepare installation media using the supplied OS image. A batch uses one set of media to install a group of target hosts with the same CPU architecture. The media must match the product version, CPU architecture, and boot mode confirmed during preparation.

    1. Open the PXE installation page.
      • On Windows/macOS, click Open service on the PXE card in the local console.
      • For direct access, open http://<reachable-controller-IPv4>:10018/ in a browser.

      Confirm that the page reports the PXE runtime as ready before selecting installation media.

    2. Open 安装介质 (Installation Media) and check the names, architectures, operating systems, and statuses of existing media. Reuse ready media for the supplied OS image if it is already available.
    3. If no suitable media is available, select a method under “导入新的 ISO” (Import a New ISO) and import the prepared OS image as described below.
      Method Action
      Browser upload Select a local OS image file and click 上传并导入 (Upload and Import).
      URL download Enter the HTTP/HTTPS URL of the supplied OS image and click 下载并导入 (Download and Import).
      Local file on the controller Place the image in the import directory shown on the page, scan the directory, then select and import the file. Windows/macOS portable packages use data/pxe-imports within the package.
    4. Confirm that the media status is “已就绪” (Ready); for newly imported media, wait for processing to complete. Verify that its architecture and supported boot mode match the target hosts, then select it.
    5. Click 确认介质并开始发现 (Confirm Media and Start Discovery).

      Confirming the media binds it to the current batch. Next, boot the target hosts from their PXE NICs.

    The page shows the selected media for this batch. Next, boot the target hosts from their PXE NICs to discover them.

  2. Discover and Select Target Hosts

    Use the PXE NIC MAC addresses and device serial numbers (SNs) recorded during preparation to identify the target hosts.

    1. Set each target host's boot device for the current boot to the NIC connected to the controller's PXE network, then power on or restart the target.
    2. Open 目标主机 (Target Hosts) and wait for discovery to complete.
    3. Verify each target host's PXE MAC address, serial number, architecture, boot mode, and detected disks.

      Select only target hosts that are online, ready, and fully discovered. Match the MAC address and SN to the planned installation targets, then check the detected disks.

    4. Select the intended target hosts and click 下一步 (Next).

      The selected target hosts must have the same architecture and match the media. System disks are configured in the next step; formatting and installation have not started yet.

    The System Configuration page opens for the selected target hosts.

  3. Configure System Disks and OS Parameters

    Configure a system disk, hostname, root password, and partitions for the target hosts selected in the previous step.

    1. On 系统配置 (System Configuration), select the system disk mode.
      • RAID1 模式（默认） (RAID1, default): use a detected software or hardware RAID1 logical disk. This mode does not create RAID1. RAID member disks cannot be used as separate system disks.
      • 自定义模式 (Custom): select one writable local whole disk for each target host. Choose this mode when the planned system disk is not a RAID1 logical disk.

      The example uses Custom mode, with /dev/vda as each server's system disk and /dev/vdb and /dev/vdc reserved for ZStone. Select system disks by the names, capacities, and models recorded during preparation.

    2. Enter the settings shared by this batch.
      Parameter Purpose Instructions
      Hostname and starting index Generate names for the target hosts. Enter the planned hostname prefix and starting index. Check the generated names and override individual names in their target host rows when necessary.
      Root password and confirmation Set the root password for the installed OS. Required for initial configuration; the two entries must match. After saving, the page shows only that a password is configured, without displaying the password.
      /boot partition Store OS boot files. Default: 1024 MB. Range: 1–10240 MB.
      Swap partition Configure swap if required. Disabled by default. Enable 设置 swap (Configure Swap) and enter a size when required; the default size is 4096 MB.
      Legacy biosboot partition Support Legacy boot. Default: 1 MB. Range: 0–2 MB. A Legacy system disk larger than 2 TiB cannot use 0.
      UEFI EFI partition Support UEFI boot. Default: 600 MB. Range: 1–4096 MB. Target host boot mode is detected automatically.
    3. Verify each target host's hostname, system disk, and detected boot mode.

      In Custom mode, check disk names, capacities, and models to avoid selecting a data disk.

    4. Click 保存并下一步 (Save and Next).

      If “系统盘信息需要确认” (Confirm the system disk information) appears, compare the selected disks with the disk information on the servers or their virtualization platform, then follow the relevant case:

      • If the selected system disks and capacities match the plan, click 仍然继续 (Continue Anyway).
      • If disk information cannot be confirmed or the selection is incorrect, click 返回修改 (Go Back and Edit) and check the system disks again.
      • If a disk issue prevents saving, resolve it as prompted before saving the configuration.

      The prompt can be caused by missing disk model or capacity information, or differences between the target hosts' system disks.

    After saving, the Review Configuration page opens. OS installation has not started.

  4. Review Configuration and Start Installation

    Review the saved installation settings on the Review Configuration page.

    Warning: Clicking “开始安装” (Start Installation) formats the selected system disks and erases their data. Recheck the target hosts, system disks, and data backups before proceeding.
    1. On 确认配置 (Review Configuration), verify that the DHCP NIC and subnet match the installation network plan.
    2. Check each target host's MAC address, hostname, and system disk. If an installation IP address is displayed, check that it belongs to this installation network.

      The temporary IP address is used for PXE installation. It does not replace the management network plan for subsequent product installation.

    3. Check the boot mode and the /boot, biosboot/EFI, and swap partition summaries.

      If changes are needed, return to the corresponding page, update and save the settings, then review them again here.

    4. After confirming the targets and system disks, click 开始安装 (Start Installation). Installation starts immediately.

    The Installation page opens and shows media preparation and progress for each target host. Keep the controller, PXE service, and required networks available throughout installation.

  5. Track Installation Progress and Results
    1. On 安装部署 (Installation), check the batch progress and each target host's stage, status, and message.

      The page refreshes automatically; you can also click 刷新 (Refresh). The estimated overall progress may differ from the installer progress reported in individual messages. Use each target host's final success or failure status to determine the installation result.

    2. To view the installation process, click 详情 (Details) for the target host.

      Review the stage, events, and previous installation attempts. Once the console is ready, click the 查看安装器控制台 (View Installer Console) icon to view the installation screen. The console is read-only.

    3. Wait for installation to finish on every target host in the batch and confirm that all installations are successful.

    Once installation succeeds on every target host in the batch, end the batch and save the report.

  6. End the Batch and Save the Report
    1. Click 结束部署 (End Deployment) to open 完成 (Completion).

      Verify the batch, media, target count, successful and failed host counts, and each target host's result and system disk. If any target hosts have failed, record their errors and the planned next actions.

    2. Click 下载装机报告 (Download Installation Report) and store the report securely.
      Note: The report contains sensitive information, including target host settings, root passwords, and installation results. Store it securely and use controlled channels to share it.

      Use 部署历史 (Deployment History) to review batches, target host results, and details later.

    3. Confirm that successfully installed target hosts boot from their local system disks into the installed OS.

      If a target host still boots into PXE, select the local system disk in the device boot menu or the hosting platform's boot settings. Once the OS starts, follow the next chapter to open Manager's Discover Hosts page and identify these target hosts.

Results

After confirming that the servers have started the installed OS and the installation report is saved, continue to Deploying ZStack Cube Ultimate to identify and select these servers in Manager.

What to do next

After saving the report, click 关闭服务 (Stop Service) if PXE is no longer required. This stops the PXE page and installation service. Keep the service running if more OS installations are needed.

Deploying ZStack Cube Ultimate

Prerequisites

The servers must have the matching operating system installed and SDDC Agent running. Manager must be running. For servers that need OS installation, first follow Installing Server Operating Systems.

About this task

This chapter follows the example deployment plan to deploy ZCF and ZStone with the Cube management UI enabled. Use the actual delivery plan when configuring the wizard.

Procedure

  1. Discover Hosts
    1. Open Manager and go to Discover Hosts.
      • On Windows/macOS, click Open service on the Manager card in the local console.
      • For direct access, open http://<reachable-controller-IPv4>:10016/ in a browser.
    2. Wait for server discovery and hardware collection to finish, then check the following information.
      • Server identity: identify each server by the device SN recorded during preparation and the hostname set during OS installation.
      • Hardware information: check that CPU, memory, disk, and NIC information has been collected.
      • CPU architecture: select servers with the same architecture for a single product deployment.
      • SDDC version: review the version shown in the discovery list.
    3. Select the servers for this deployment and click Next.
      Figure 1. Select the Servers for This Deployment

      The three intended servers are selected in the discovery list, with hardware information and SDDC versions displayed.

    The Select Products page opens.

  2. Select Products
    1. Select ZCF and ZStone.

      ZStack Cube Ultimate requires ZCF and at least one storage product: ZCE, ZStone, or ZBS. Use the selected storage product for primary storage.

    2. Turn on Enable Cube management UI under Delivery Options.
    3. Confirm that the product combination and server resources meet the displayed requirements, then click Next.

      Requirements include server count, CPU, memory, disks, and NICs.

      Figure 2. Select Products and Enable the Cube Management UI

      ZCF and ZStone are selected and the Cube management UI option is enabled. Product combination and node count checks pass.

    The Manage Packages page opens.

  3. Manage Packages
    1. Click Product Compatibility List and check that the selected product versions are compatible.
    2. Import packages for the selected products as needed.

      This example uses the following matching packages:

      • ZCF: use a ZCF package in tar format or a ZStack Cloud package in iso format. This example uses the ZStack Cloud 5.4.16 ISO. A ZStack Cloud BIN package is not supported.
      • ZStone: use a package in tar.gz format. This example uses ZStone 5.5.12.

      Reuse the required packages if they are already listed. Otherwise, import packages as follows:

      • Local Upload: click Upload Package, select Local Upload, and upload the package from the computer running your browser.
      • Remote URL: click Upload Package, select Remote URL, and enter an HTTP/HTTPS package URL accessible from the controller. The controller downloads and imports the package.
      • Preset directory scan: check the preset directory in the supplied deployment instructions, place packages there, then click Rescan. For the Windows/macOS portable package, check package.presetPath in config/config.yaml. Relative paths are based on the package root directory.
    3. After package verification finishes, check the following information.
      • The package status is Ready.
      • The package contains the product and version required for this deployment.
      • Its supported CPU architecture and target operating system match the selected servers.
      • The MD5 checksum matches the value supplied by the vendor.
    4. Select a package for each product, confirm the packages under Selected Products, and click Next.
      Manage Packages

    After deployment validation passes, the Assign Hosts page opens.

  4. Assign Hosts
    1. Configure management nodes and management access addresses.

      Configure the following parameters according to the deployment plan. This example uses Shared Management Nodes in single-node mode, with cube-node-3 as the management node.

      Parameter Configuration instructions
      Management node assignment
      • Shared Management Nodes: ZCF and storage share one management node group. Select the nodes once in the shared management section.
      • Separate Management Nodes: select management nodes in the virtualization and storage sections separately. The two groups must not overlap.
      Management node count
      • Single Node (1): select one management node per group.
      • Dual Node (2): select two management nodes per group.
      Management nodes
      • Shared mode: select servers in the Shared Management Nodes section. Select these servers once to manage both virtualization and storage.
      • Separate mode: select servers in each product's management node section.

      Identify servers by hostname and discovery/access IP. Product configuration uses the management IPs planned on Configure Network.
      Management VIPs, dual-node mode Enter virtual IP addresses for accessing the product management interfaces.
      • Shared mode: enter the Management VIP.
      • Separate mode: enter each product's VIP, such as ZCF VIP and ZStone VIP.

      Each VIP must be unused and on the same management subnet as its management nodes. No VIP is required in single-node mode.
      Assign Management Nodes and Review Assignments

    2. Review the management and non-management nodes in Assignment Preview.

      Assignments must match the deployment plan. In shared mode, ZCF and storage must show the same management nodes.

    3. Click Next to save the assignments.

    The Configure Network page opens.

  5. Configure Network
    1. Configure management, storage, and any required business networks for the servers.

      This example configures the management network for each host, reuses it for storage, and leaves business networking disabled.

      Configuration area Parameter Configuration instructions
      / Configuration scope
      • All hosts: use the same configuration for all hosts.
      • By role: configure management and non-management nodes separately.
      • By product: configure each product independently.
      • By host: select a host card before entering its network parameters. Complete all hosts before proceeding.
      Management network NIC selection Click Add NIC and identify the management NIC by its name and MAC address. Use the server NIC for management networking; the controller PXE NIC is configured separately.
      IP, subnet mask, gateway For per-host configuration, enter the planned management IP, subnet mask, and gateway for the selected server. For unified configuration, enter the start and end IP addresses. Check each address against its intended server.
      Bond

      To bond NICs, select the member NICs, enable Bond, and select a mode:

      • Active-backup (mode1): switch to a backup NIC if the active NIC fails.
      • LACP (mode4): enable LACP on the switch.
      VLAN ID Enter the VLAN ID required by the network plan. Leave this blank if the server NIC does not need VLAN tagging. Do not copy a VLAN ID from an upstream virtual network or switch without checking the tagging plan.
      Storage network Configuration mode
      • Unified: share network parameters between storage public and cluster traffic.
      • Separate: configure the storage public and cluster networks separately.
      • Reuse Management Network: use the current management network configuration and addresses.
      Storage Public network Available when storage networking is configured separately. This network carries client reads and writes. Configure the NICs, IP range or host IP, subnet mask, and optional VLAN ID.
      Storage Cluster network Available when storage networking is configured separately. This network carries replication, backfill, and heartbeats between storage nodes. Configure the NICs, IP range or host IP, subnet mask, and optional VLAN ID.
      Bond

      To bond NICs, select the member NICs, enable Bond, and select a mode:

      • Active-backup (mode1): switch to a backup NIC if the active NIC fails.
      • LACP (mode4): enable LACP on the switch.
      VLAN ID Enter the VLAN ID required by the network plan. Leave this blank if the server NIC does not need VLAN tagging. Do not copy a VLAN ID from an upstream virtual network or switch without checking the tagging plan.
      Business network Enable business networking Enable this to generate ZCF business networking through the wizard. This example leaves this option disabled.
      NIC selection
      • When business networking is enabled, select one NIC or two NICs with the same speed. You can reuse NICs assigned to management or storage networks.
      • When reusing NICs already configured in a Bond, the existing Bond is retained and the Bond selector is not displayed.
      • When selecting unused, separate NICs, the Bond selector is displayed for optional configuration.
      IP range, subnet mask, gateway When business networking is enabled, enter these parameters to generate the recommended ZCF network configuration. Enter the start and end addresses, subnet mask, and gateway according to the business network plan. This IP range belongs to virtualization business networking, not server management.
      VLAN ID When business networking is enabled, enter the VLAN ID required by the business network plan. Leave this blank if VLAN tagging is not required.
      Configure Host Networks

    2. Review each server's network settings and click Next.

    After the IP conflict check passes, the network settings are saved and the Configure System page opens.

  6. Configure System
    1. Configure hostnames, connection credentials, and system services.
      Parameter Configuration instructions
      Hostname Enter the hostname prefix and suffix in batch configuration, review the generated names, and click Apply. In the host list, check each hostname against the device SN and planned management IP. Hostnames must not exceed 16 characters, including hyphens.
      Root password Enter the servers' current root password. For servers installed through the preceding PXE procedure, use the password set during OS installation. This password is used for subsequent SSH connectivity checks; the root password remains unchanged.
      SSH port Enter the servers' current SSH port. The default is 22. All servers in the batch must use the same port. The servers' SSH port remains unchanged.
      NTP time sources Enter the addresses of NTP time sources that the servers can reach. Only IPv4 addresses are supported; domain names are not supported. Separate multiple addresses with commas.
      DNS servers Enter DNS server addresses that the servers can reach for name resolution. Separate multiple addresses with commas.
      Firewall Set the firewall according to the site security policy. When enabled, the system automatically opens ports required by the products.
      Extra Open Ports To open additional ports, click Add port, enter ports or port ranges, and select TCP or UDP. Separate multiple ports or ranges with commas, for example, 8092,8093-8095.
      Passwordless login Deploying storage products requires SSH keyless login to be enabled. We recommend keeping the default enabled setting.
      Batch System Configuration

      Review the Host List

    2. Review each server's system settings, save, and continue.
      To locate a server on site, use Locator LED in the host list and select Turn on, Blink, or Turn off locator.

    The Configure Products page opens.

  7. Configure Products
    1. Choose a configuration method.
      Parameter Configuration instructions
      Recommended Configuration Click Recommended Configuration at the upper right to generate settings from the saved server, network, and product configuration and open Review Configuration. This example uses this method.
      Manual configuration Enter settings for the selected products according to the deployment plan.
      Note: Recommended Configuration replaces existing settings for the selected products. If prompted, confirm that existing settings do not need to be retained before clicking Generate and replace.
    2. Review or enter settings for the selected products.
      • Recommended Configuration: After generation, the Review Configuration page opens. ZCF administrator and database passwords must be entered manually. In this example, click Previous to return to Configure Products, enter and confirm both passwords, review the table below, and save. For other products, complete any required fields that were not generated.
      • Manual configuration: Enter and save the settings on Configure Products using the table below.

      The page displays only the parameters for the selected products.

      Configuration area Parameter Configuration instructions
      ZStone storage configuration Host Config Management, Monitor, Data, Gateway: In Storage Config (ZStone) > Host Config, select servers and assign roles. At least three nodes must each have all four roles: Management, Monitor, Data, and Gateway. These are internal ZStone service roles, separate from the product management nodes selected on Assign Hosts.
      Data Disk Config Disk type:
      • Hybrid disks: use SATA SSD or NVMe cache disks to accelerate HDD data disks.
      • Raw disks: use HDD, SSD, or NVMe disks directly as data disks.

      You can configure both types, using separate disks for each type. This example uses raw disks because the three servers have HDD data disks without separate cache disks.
      • Cache disks: For hybrid disks, select the cache disks first.
      • Allocation mode: After selecting cache disks, choose how they map to data disks:
        • Automatic allocation: let the tool assign the mappings.
        • Manual allocation: specify the mappings manually.
      • Data disks: For hybrid disks, assign them using the selected allocation mode. For raw disks, select the data disks directly.

      This example selects vdb and vdc on each server and preserves the vda system disk.
      Storage Pool Config

      Click Add Storage Pool and configure:

      • Name: Enter a pool name. This example uses the recommended pool-hdd pool.
      • Replicas: Select according to the storage plan. This example uses three replicas.
      • Failure Domain: Select according to the storage plan. This example uses Server.
      OSD Assignment: Select the data disks configured in the preceding step. Create at least one pool. Each disk can belong to only one pool. This example assigns all six raw data disks to the same pool.
      ZCF virtualization configuration Host Config Compute Node: Review the management nodes selected on Assign Hosts and select the servers that provide compute resources. A server can serve as both a management node and a compute node. In this example, all three servers are compute nodes and one is also a management node.
      Common Config
      • Administrator password: Set and confirm the password used to log in to the product UI after deployment.
      • Database password: Set and confirm the password used by product database users.
      • Cluster scale: Select according to delivery requirements.

      Enter both passwords manually and follow the rules shown on the page. Recommended Configuration leaves these fields for you to complete.
      Create Zone
      • Name: Enter the zone name. This example keeps the recommended ZONE-1.
      • Description: Enter a description if needed.
      Create Cluster

      Check the parent zone, then configure:

      • Name: Enter a cluster name. This example uses Cluster-1.
      • Hypervisor Type: Select according to the deployment plan. This example uses KVM.
      • CPU Architecture: Match the selected servers. This example uses x86_64.
      Add Backup Storage
      • Type: This example uses ZStone; select Ceph.
      • Mon Nodes: Select the ZStone servers assigned the Monitor role. Use their management IPs from Configure Network and their SSH ports and root credentials from Configure System.
      • Backup Storage Pool: Enter the pool created earlier.

      Recommended Configuration generates these settings from the saved nodes, credentials, and pool information. Review each value.
      Add Primary Storage
      • Type: This example selects Ceph.
      • Mon Nodes: Review each node's management IP and SSH connection settings.
      • Image Cache Pool: Check the pool. This example uses pool-hdd.
      • Data Volume Pool: Check the pool. This example uses pool-hdd.
      • Root Volume Pool: Check the pool. This example uses pool-hdd.
      • Storage Gateway CIDR: Enter the CIDR for the storage network.
      • Optional settings: Configure Cephx, the cold migration network, and the enterprise access token as needed.
      Create Instance Offering
      • Name: Enter the instance offering name.
      • CPU Cores: Set the CPU count for VM instances.
      • Memory: Set the memory capacity for VM instances.
      • Host Allocation Strategy: Select according to the deployment plan.
      • Optional settings: Configure disk bandwidth, IOPS, network bandwidth limits, and advanced settings as needed.

      This example keeps the recommended 1-core, 1-GB offering.
      Add Image
      • Image Format: Select the actual image format.
      • CPU Architecture: Select the image CPU architecture.
      • Platform: Select the image platform.
      • Operating System: Select the image's operating system.
      • Image URL: Enter the image file URL.
      • BIOS Mode: Select a boot mode supported by the image.

      Also review Virtio and backup storage. This example uses the recommended bundled qcow2 image. Its URL points to a file on the product installation media, not the OS image path on the controller.
      Create L2 Network, Create L3 Network Enable and configure these according to the business network plan. This example leaves business networking disabled on Configure Network, so Recommended Configuration disables both options and no L2 or L3 network is created during installation. After installation, follow Initialization by Wizard to initialize ZStack Cube Ultimate, then configure business networks as described in Create Network.
      Configure a Storage Pool

    Product settings are saved and the Review Configuration page opens.

  8. Preview
    1. Review the following deployment settings.
      • Product combination, versions, packages, and the Cube management UI option.
      • Management mode and VIPs, node roles, system disks, and data disks.
      • Storage pools and virtualization storage bindings, management networks, and business IP pools.
      • SSH credential configuration status, ports, NTP, and DNS.
      Review Host Addresses

      Review Products and Management Nodes

    2. If adjustments are needed, return to the corresponding step, edit, and save.

      If nodes, networks, or packages change, review the affected product settings again.

    3. After confirming the settings, continue.

    The Pre-flight Check page opens.

  9. Precheck
    1. Run the prechecks and wait for the results.

      Checks include Agent communication, package integrity and compatibility, product settings, available space, hardware compatibility, and SSH connections. The checks vary by product and version.

      Figure 9. Pre-installation check results


    2. Confirm that all checks pass, then continue.

    All prechecks have passed and product deployment can proceed.

  10. Install
    1. Submit the deployment task.
      Warning: Submitting the deployment task changes the selected servers and installs products using the saved settings. Recheck the target servers, disk roles, and data backups before submission.
    2. View deployment progress, logs, and status for each product and server.

      The tool follows the product dependencies to configure servers, install storage and virtualization, and initialize Cloud.

      • Check the Configure Cube management UI stage and its verification result.
    3. Wait for all selected products to deploy successfully.

    All selected products are deployed successfully and the Finish page opens.

  11. Finish
    1. Review the deployment results for each product and server.
    2. Open each product console, verify access, and check the following items.
      • Verify the Cube management UI, storage information, and storage management access. For multiple management nodes, also check the expected access point and node status.
      • Follow Initialization by Wizard to complete ZStack Cube Ultimate initialization and business network configuration, then complete acceptance checks.
    3. Download the deployment report and store it securely.

      Store the deployment report with the deployment plan and acceptance records according to the delivery requirements.

      If the Finish page provides a shutdown countdown or service stop control, save the report and complete verification first. Stopping the deployment service does not stop the installed products.

    ZCF and ZStone are installed successfully, the accessible ZStack Cube Ultimate management entry is recorded, and the deployment report is saved. Continue with Initialization by Wizard to initialize ZStack Cube Ultimate and create networks.

Results

After ZStack Cube Ultimate initialization, business network configuration, and acceptance, follow the User Guide for this version for daily cloud resource and storage management.

After completing this workflow and saving the deployment report, click Reset in Manager on the deployment node if another environment needs to be deployed. Reset archives the current batch, clears the current wizard settings, and rediscovers hosts. It retains installation packages and does not affect the completed environment.

Note: During deployment, Reset clears the current wizard settings and affects the current task. Use it only when you decide to abandon this deployment and configure it again.

Initialization by Wizard

After the deployment succeeds, open Chrome 66 or later and navigate to http://management_node_ip:5000 to access the ZStack Cube Ultimate UI. For the first login, you can use the default account admin and the administrator password set in SDDC Manager.

ZStack Cube Ultimate provides a wizard for platform initialization and supports the following initialization methods:
  • Automated Initialization: The system scans hardware automatically and creates/adds basic resources on the platform.
  • Manual Initialization: Manually create or add basic resources on the platform.

This tutorial focuses on the automated initialization process. For manual initialization, see Initialization by Wizard > Manual Initialization in the User Guide.

Note:
  • If you exit the Wizard page or delete key resources during initial setup, you are not directed to the wizard again.
  • We recommend using the wizard to complete the basic platform configuration.

Automated Initialization

During the automated initialization, ZStack Cube Ultimate automatically creates the following basic resources:
  • Zone: A zone is a logical group of resources such as clusters, L2 networks, and primary storage. Zone is the largest resource scope defined in the Cloud.
  • Cluster: A cluster is a logical group of hosts (compute nodes).
  • Host: A host provides compute, network, and storage resources for VM instances.
  • Backup Storage: An image storage is a storage server that stores VM image templates, including ISO image files.
  • Primary Storage: A primary storage is one or more servers that store volume files of VM instances. These files include root volume snapshots, data volume snapshots, image caches, root volumes, and data volumes.
  • Instance Offering: An instance offering defines the number of vCPU cores, memory size, network bandwidth, and other configuration settings of VM instances.
  • Image: An image is a template file used to create a VM instance or volume. Images are categorized into system images and volume images.
  • L2 Network: An L2 network is a layer 2 broadcast domain used for layer 2 isolation. Generally, L2 networks are identified by names of devices on the physical network.
  • L3 Network: An L3 network includes IP ranges, gateway, DNS, and other network configurations that are used by VM instances.
Note: If you do not configure a business network when deploying ZStack Cube Ultimate, the system does not automatically create L2 and L3 networks during the automated initialization and you need to manually create them. For more information, see Create Network
When creating the above resources:
  • The system creates hosts, backup storage, and primary storage according to the hardware information it scans.
  • The system creates multiple instance offerings:
    • Balanced Type: The CPU-to-memory ratio is 1:4, such as 1C4G, 2C8G, 4C16G, and 8C32G.
    • Compute-Enhanced Type: The CPU-to-memory ratio is 1:2, such as 1C2G, 2C4G, 4C8G, and 8C16G.
    • Memory-Enhanced Type: The CPU-to-memory ratio is 1:8, such as 2C16G, 4C32G, 8C64G, and 16C128G.
  • The system creates multiple disk offerings, including 20GB, 40GB, 100GB, 200GB, and 500GB.

Start automated initialization using the resource settings above. Wait for initialization to finish before creating networks.

Note: If any resources fail to be created or added, click Retry to reattempt the failed step and continue initialization.

Create Network

If you do not configure a business network when deploying ZStack Cube Ultimate, the system does not automatically create L2 and L3 networks during the automated initialization and you need to manually create them.

Create L2 Network

Set the following parameters:
  • Name: Enter a name for the L2 network.
  • Description: Optional. Enter a description for the L2 network.
  • Switch Type: Supported switch types include Linux Bridge and OVS-DPDK.
  • Network Type: Choose a network type for the L2 network. Valid values: L2NoVlanNetwork, L2VlanNetwork.
    • L2NoVlanNetwork
      • If you do not need to use VLAN, select L2NoVlanNetwork.
      • If you select L2NoVlanNetwork, the switch port connected by the specified NIC must be in the Access mode.
    • L2VlanNetwork
      • If you need to use VLAN on ZStack Cube Ultimate, select L2VlanNetwork.
      • If you select L2VlanNetwork, the switch port connected by the specified NIC must be in the Trunk mode.
      • VLAN ID: Enter a VLAN ID that matches the actual network configurations. Valid values: 1 to 4094.
  • Cluster: Display the the cluster to which the L2 network will be attached.
  • NIC Name: Select or enter an NIC name for the L2 network. For example, em01.
    Note: You can only select or enter an NIC name shared across all hosts in the cluster.
Figure 10. Create L2 Network


Review and submit the settings to create the L2 network.

Create L3 Network

Set the following parameters:
  • Name: Enter a name for the L3 network.
  • Description: Optional. Enter a description for the L3 network.
  • Network Type: The wizard supports only flat network.
  • Network Range Method: Select a method to add a network range for the L3 network. You can select IP Range or CIDR.
    If you select IP Range, you need to set the following parameters:
    • Start IP: Set a start IP address for the network range, for example, 172.20.108.100.
    • End IP: Set an end IP address for the network range, for example, 172.20.108.200.
    • Netmask: Set a netmask for the network range, for example, 255.255.0.0.
    • Gateway: Set a gateway for the network range, for example, 172.20.0.1.
    • DNS: Add a DNS server to provide domain name resolution services for the L3 network. You can specify 223.5.5.5, 8.8.8.8, or 114.114.114.114.
    If you select CIDR, you need to set the following parameters:
    • CIDR: Set a CIDR block for the L3 network, for example, 192.168.108.1/24.
    • Gateway: Set a gateway for the L3 network, for example, 192.168.108.1.
      Note:
      • You can use the first or last IP address in the specified CIDR block as the gateway.
      • If left blank, the first IP address in the specified CIDR block is used as the gateway.
    • DNS: Add a DNS server to provide domain name resolution services for the L3 network. You can specify 223.5.5.5, 8.8.8.8, or 114.114.114.114.
Figure 11. Create L3 Network


Review and submit the settings to create the L3 network.

Now, the automated initialization is completed.

PreviousTechnical WhitepaperNextUpgrade Tutorial