Quick Start

  1. Q: What can I do with ZStack Cloud?

    A:

    In general, the Cloud helps you easily create and manage VM instances and related network storage resources. For example,
    • You can obtain the usage of physical resources, such as processors, memories, storages, and networks in the Cloud in real time. You only need to create VM instances and the Cloud will immediately send alarms if resources are insufficient.
    • The Cloud allows you to copy templates before you create VM instances.
    • After you create a VM instance, the Cloud allows you to set or change the relevant IP address.
    • The Cloud supports flat networks, vRouter networks, and VPC networks. You can quickly set up flexible and diverse network scenarios as needed with simple clicks in the UI.
    • The Cloud can take over vCenter. Specifically, the Cloud can manage both KVM and VMware clusters at the same time. In addition, the Cloud supports the V2V migration of VM instances from vCenter to ZStack.
    • The Cloud allows different accounts to see different VM instances.
    • The Cloud supports advanced features such as billing.
    • You can directly add firewalls to VM instances on the Cloud and set various security policies, which is simple and convenient.
    • The Cloud supports advanced features, such as enterprise management, bare metal management, V2V migration, and backup service.
    In addition, ZStack has a lot of powerful features. Try ZStack Enterprise to find more highlights.
  2. Q: What documents does ZStack provide? Which documents should I read?

    A: ZStack provides the following documents:
    • Release Notes:

      The release notes briefly describe the new features provided by ZStack during each release and detail the changes or enhancements made to the Cloud.

    • Product Manuals:

      The product manuals include the User Guide, Maintenance Manual, Technical Whitepaper, CLI Command Manual, and CTL Command Manual. These manuals describe the functional architecture, functional advantages, installation and deployment, how to use the Cloud, and solutions to common problems during the O&M of ZStack. You will find a new world if you explore ZStack by using CLI.

    • Tutorials:

      We provide you with many tutorials that cover various application scenarios, for example, Quick Start Installation Tutorial, Upgrade Tutorial, Multi-MN HA Tutorial, and V2V Migration Tutorial. With these tutorials, you can get started quickly and easily.

    • API Reference:

      The API Reference, as the core of ZStack, helps you gain in-depth insight of ZStack from the API level.

    • FAQ:

      The FAQ provides answers to a list of frequently asked questions during the use of the Cloud.

    • Blogs:

      The blogs provide a place where you can voice your ideas and share your thoughts on ZStack as well as the cloud computing industry. Here, you can expand your horizon and have a more thorough understanding of IaaS.

    Different users can find the most suitable documents here.
    • For beginners:
      • First of all, we recommend that you learn some basic concepts of IaaS, and understand what ZStack is and what can it do.
      • Then, you can refer to the Quick Start Installation Tutorial to install the Cloud quickly.
      • After you installed the Cloud successfully, you can use it by referring to our tutorials. For example, you can try to deploy a flat network without virtual routing.
      • If you successfully created the first VM instance, you succeeded in taking the first step and could perform further operations.
      • Next, you can try some deployment scenarios according to the tutorials. Then, you will have a new understanding of various features and nouns in the UI.
      • If you read the blogs carefully, you will find something new and more interesting.
    • For developers:
      • If you are interested only in some features, refer to the API Reference to learn more about the APIs for secondary development.
      • You can also refer to the CLI Command Manual to deploy a ZStack environment by using CLI.
      • The API Reference and CLI Command Manual are necessary for developers. You can also find answers to some questions in the tutorials and blogs.
    • For experts:
      • You can take a quick glance at the installation tutorial and then select an appropriate solution.
      • Maybe you have more interests in the API Reference and Blogs.
      • If you have any questions during the use of the Cloud, refer to the FAQ. If you did not find your answers, feel free to raise your questions in the ZStack community (QQ group numbers: 1046295840, 741300236, 443027683, and 410185063).

Installation and Deployment

  1. Q: What hardware environments does ZStack support?

    A: ZStack supports x86 and ARM servers with hardware virtualization features, workstations or desktops, and mainstream Intel or AMD processors.

  2. Q: What operating systems does ZStack support?

    A: ZStack supports ZStack Custom ISO that is deeply customized based on CentOS 7.4 or CentOS 7.6.

  3. Q: Can I install ZStack by using the standard CentOS 7.4 or CentOS 7.6 operating system?

    A: Currently this is not supported. However, ZStack supports ZStack Custom ISO that is deeply customized based on CentOS 7.4 or CentOS 7.6.

  4. Q: How many servers are needed to install and deploy ZStack?

    A: A minimum of one server is required. This server can act as the management node and compute node at the same time. In a production environment, we recommend that you install the management node and compute node separately. ZStack can manage all hardware resources by using only one management node.

  5. Q: What is the minimum server configuration requirement for installing and deploying ZStack?

    A: 4 CPUs, 8 GB memory, 200 GB primary storage, and 200 GB backup storage. Note that the minimum configuration is only applicable to test environments.

  6. Q: What installation modes does ZStack Custom ISO support? What are the differences?

    A: ZStack Custom ISO supports the following installation modes:
    1. ZStack Enterprise Management Node

      Install the ZStack Custom ISO that is deeply customized based on CentOS 7.4 or CentOS 7.6 as well as the ZStack Enterprise management node.

    2. ZStack Community Management Node

      Install the ZStack Custom ISO that is deeply customized based on CentOS 7.4 or CentOS 7.6 as well as the ZStack Community management node.

    3. ZStack Compute Node

      Install the ZStack Custom ISO that is deeply customized based on CentOS 7.4 or CentOS 7.6 as well as the essential software package of ZStack compute node.

    4. ZStack Expert Node

      Install the ZStack Custom ISO that is deeply customized based on CentOS 7.4 or CentOS 7.6 and configure the local repo. You can customize the system usage as needed.

  7. Q: How do I install ZStack Enterprise?

    A: Download the latest ZStack Custom ISO. If you are installing the system for the first time, we recommend that you select the Enterprise management node. After the operating system is installed, you can restart the operating system to automatically install the Enterprise management node.

  8. Q: How do I upgrade ZStack Enterprise?

    A: To upgrade ZStack that you already deployed to the latest version, use one of the following methods. Here we take c76 as an example.
    • Incremental upgrade:
      1. Obtain the latest bin installation package from ZStack Official Website: ZStack-installer-3.10.0.bin.
      2. If the root password of the database is the default password, run the following command to upgrade the Cloud:
        [root@localhost ~]# bash ZStack-installer-3.10.0.bin -u
        If the root password of the database is a custom non-blank password, run the following command to upgrade the Cloud:
        [root@localhost ~]# bash ZStack-installer-3.10.0.bin -u -P MYSQL_ROOT_PASSWORD
    • Offline upgrade:
      1. Obtain the latest ISO installation package from ZStack Official Website: ZStack-x86_64-DVD-3.10.0-c76.iso.
      2. Obtain the latest upgrade script: Upgrade script.
      3. Run the following command to upgrade the Cloud:
        [root@localhost ~]# bash zstack-upgrade ZStack-x86_64-DVD-3.10.0-c76.iso
    Note: The method to upgrade the c74 version is the same as that of the c76 version. Please obtain the installation package corresponding to the c74 version to upgrade.
  9. Q: How do I upgrade from an expert node to a management node?

    A: Run the following commands:
    [root@localhost ~]# yum --disablerepo=* --enablerepo=zstack-local install zstack-manager [root@localhost ~]# bash ZStack-installer-3.10.0.bin -E
  10. Q: How do I upgrade from an expert node to a compute node?

    A: Run the following command:
    [root@localhost ~]# yum --disablerepo=* --enablerepo=zstack-local,qemu-kvm-ev groupinstall zstack-host
  11. Q: How do I upgrade from a compute node to a management node?

    A: Run the following commands:
    [root@localhost ~]# rpm -e zstack-host [root@localhost ~]# yum --disablerepo=* --enablerepo=zstack-local install zstack-manager [root@localhost ~]# bash ZStack-installer-3.10.0.bin -E
  12. Q: How do I upgrade a management node from ZStack Community to ZStack Enterprise?

    A: Obtain and use the latest Enterprise license.

  13. Q: How do I reinstall ZStack?

    A:
    1. Run the following command to delete the original database:
      [root@localhost ~]# rm -rf /usr/local/zstack
      Note: This command will delete all the data under this directory. You can use this command only when you want to completely reinstall ZStack.
    2. Then, run the following command to reinstall the management node:
      [root@localhost ~]# bash ZStack-installer-3.10.0.bin -D #Install ZStack Enterprise.
  14. Q: I installed ZStack as a root user. However, when I start the service, the system reports that I am not a root user. Why?

    A:
    • Symptom:
      When you install ZStack, you use root for login. However, when you start the service, the system reports that you are not a root user and sudo is required.
      ERROR: please use sudo or root user FAIL  Reason: failed to start zstack
      When you run the following command in a Python CLI environment, you find that Python determined that you are not a root user.
      import getpass  user = getpass.getuser()  print user 
    • Cause:

      When you switch from a regular user to a root user, you used su instead of sudo su. In this case, only the root user is switched but relevant environment variables are not switched.

    • Description:
      • The sudo command can be used by the current user with the root super permission.
      • The su command can be used to switch to a root user. However, the relevant environment variables are not switched to the root directory.
      • The sudo su command is used to switch to a root user with the root permission.
  15. Q: In a multi-node deployment environment, can I use a VM instance as a node?

    A: Yes, you can. Make sure that the network is connected. We recommend that you bridge the VM node with other nodes. In addition, the VM node is more suitable to act as a management node with a minimum of 4 CPUs and 8 GB memory.

  16. Q: Can I install ZStack on a ZStack VM instance?

    A: Yes, you can. Method: Go to Settings > Global Settings > Basic Settings, locate Vm.cpuMode, and set the value to host-passthrough. Then, the virtualization feature of a host can be passed through.

  17. Q: After I perform one-click installation of ZStack, what should I do if the Cloud takes a long time to start up?

    A:
    • Cause:

      The startup time of the management node is related to the configuration resources of the node. The startup takes a long time only when you install ZStack on a VM instance.

    • Solution:
      We recommend that you use more than 4 CPUs and 16 GB memory in a virtualization environment.
      Note:

      The startup takes a long time does not indicate that the installation or startup fails. If a time out error is reported, use zstack-ctl status to check the status. If the status is stopped, use zstack-ctl start to start the service. If the status is unknown, use zstack-ctl stop to stop the service, and then use zstack-ctl start to start the service.

  18. Q: How do I change the installation directory of ZStack?

    A: When you install ZStack, add -r destination directory. For example,
    [root@localhost ~]# bash zstack-installer.bin -r /home/zstack
  19. Q: When I upgrade the Cloud, what should I do if the new version of ZStack Custom ISO does not match the old one?

    A:
    • Symptom:
      If the new version of ZStack Custom ISO does not match the old one during the upgrade, the following error message will be reported:
      mount: /dev/loop0 is write-protected, mounting read-only /root Current release c76 not matched the new ISO c74, Use zstack-upgrade -r xxx.iso to update current repo, Use zstack-upgrade -a/--add_repo xxx.iso to add a new repo
    • Cause:

      The current ISO version used by the system is not suitable for upgrading the installation package. You need to upgrade the corresponding ISO and then upgrade ZStack.

    • Solution:
      Follow these steps to perform the deployment. Here, we take c76 as an example.
      1. Run the following command to download the latest upgrade script:
        wget http://cdn.zstack.io/product_downloads/scripts/zstack-upgrade
      2. Run the following command to download the latest ISO in the management node:
        wget http://cdn.zstack.io/product_downloads/iso/ZStack-x86_64-DVD-3.10.0-c76.iso
      3. Perform the upgrade. That is, upgrade the yum repo in the ISO and synchronize it to your local server. Then, directly upgrade the management node.
        bash zstack-upgrade ZStack-x86_64-DVD-3.10.0-c76.iso
  20. Q: When I upgrade ZStack, the following error is reported: The Operating System version is not suitable for zstack-enterprise installation.. What should I do?

    A: Use the latest ZStack Custom ISO for installation and upgrade.

  21. Q: During the upgrade of ZStack, if the upgrade fails due to secondary development or database adjustment, how can I restore the original ZStack?

    A:
    • Prerequisite:

      During the upgrade of ZStack, the core files and database of the current ZStack are backed up to the corresponding directory by default.

    • Procedure:
      1. Back up the core files in ZStack of the previous version.
        cp /usr/local/zstack/upgrade/2017-11-09-15-41-52 /root -r
      2. Back up the database of the previous version.
        cp /usr/local/zstack/db_backup/2017-11-09-15-42-43/backup.sql /root
      3. Back up the database again.
        zstack-ctl dump_mysql
      4. Delete the current ZStack environment.
        zstack-ctl stop rm -rf /usr/local/zstack
      5. Use the previous installation package to directly install ZStack.
        bash ZStack-installer-3.10.0.bin -D
      6. Perform recovery by using the core files backed up in Step 1.
        zstack-ctl stop mv /usr/local/zstack/apache-tomcat/webapps/zstack /usr/local/zstack/apache-tomcat/webapps/zstack-bk cp /root/2017-11-09-15-41-52/zstack /usr/local/zstack/apache-tomcat/webapps  -r chown zstack:zstack /usr/local/zstack/apache-tomcat/webapps/zstack -R
      7. Restore the database backed up in Step 2.
        cat /root/backup.sql |mysql -u root -p zstack.mysql.password zstack
      8. Start the ZStack management node service. Then, ZStack is successfully restored to the previous version.
        zstack-ctl start
  22. Q: When I restart a management node, the management node fails to be started, and the system reports that no space is available. What should I do?

    A:
    • Cause: The versions earlier than ZStack 3.5.0 use Prometheus 1.8.2, which might cause the monitoring data to occupy the root space.
      Note: ZStack 3.5.0 and later versions use Prometheus 2.9.2, which allow you to set the retention policy. (By default, 50 GB monitoring data can be saved.)
    • Solution: If the monitoring data is no longer needed, permanently delete the Prometheus monitoring data to release the space.
      • In a single management node environment, run the following commands in sequence to delete the Prometheus monitoring data:
        [root@hostname ~]# du -sh /var/lib/zstack/prometheus/data/    //View the monitoring data size. [root@hostname ~]# zstack-ctl stop  [root@hostname ~]# kill -9 `ps -ef |grep prometheus|awk '{print $2}'`  [root@hostname ~]# rm -rf /var/lib/zstack/prometheus/data [root@hostname ~]# zstack-ctl start
      • In a dual-MN environment, run the following commands in each management node to delete the Prometheus monitoring data:
        [root@mn-1 ~]# du -sh /var/lib/zstack/prometheus/data/    //View the monitoring data size. [root@mn-1 ~]# zsha2 stop-node [root@mn-1 ~]# kill -9 `ps -ef |grep prometheus|awk '{print $2}' [root@mn-1 ~]# rm -rf /var/lib/zstack/prometheus/data [root@mn-1 ~]# zsha2 start-node
  23. Q: I tried to install a compute node by using an unofficial ZStack but failed. Why?

    A: Unofficial ISO cannot be used to install a compute node. Please use the official ZStack custom ISO.

  24. Q: I successfully installed a ZStack Cloud in a nested virtualization environment. However, when I add a host in the Cloud, the following error is reported: ERROR:could not insert 'kvm_intel':Operation not supported stdout. What should I do?

    A: When you set up ZStack in nested virtualization environments such as KVM, VMware, VirtualBox, Hyper-V, and Xen, enable Intel VT-x/EPT or AMD-V/RVI(V) in the virtualization engine settings of the corresponding virtualization platform.


System Login

  1. Q: Which browsers are recommended to log in to ZStack?

    A: Chrome 49, Firefox 52, or their later versions are recommended for a better experience.

  2. Q: What should I do if I could not log in to the UI?

    A: Check the following information:
    1. If the system reports that the user name or password is incorrect, enter the correct user name and password.
    2. If the system reports that you could not connect to the management node, run the zstack-ctl status command to check whether the management node service is running properly.
    3. If you still could not connect to the management node, perform login via cli.
      [root@localhost ~]# zstack-cli  #Go to the CLI mode. admin>>> LogInByAccount accountName=admin password=password #Log in to the CLI. Default user name/password: admin/password.
    4. Check whether the related Java process cannot run due to zombies in the process. If yes, restart the management node service.
  3. Q: How do I change the admin password of the UI?

    A: Three methods are available:
    • UI method:

      On the Homepage of ZStack, click the admin icon, and then click Change Password.

    • CTL method:
      Run the following command:
      [root@localhost ~]# zstack-ctl reset_password --password NEW_PASSWORD #Change the password. (NEW_PASSWORD is the new password.)
    • CLI method:
      Run the following commands in sequence:
      [root@localhost ~]# zstack-cli  #Go to the CLI mode. admin>>> LogInByAccount accountName=admin password=password #Log in to the CLI. Default user name/password: admin/password. admin>>> UpdateAccount uuid=36c27e8ff05c4780bf6d2fa65700f22e password=NEW_PASSWORD #Change the password. (NEW_PASSWORD is the new password.)
  4. Q: How do I change the default port (5000) of the UI?

    A: Run the following commands in sequence:
    [root@localhost ~]# zstack-ctl config_ui --server-port 8888  #Change the UI port to 8888. [root@localhost ~]# zstack-ctl config_ui --webhook-port 8888  #Change the webhook host port to 8888. [root@localhost ~]# zstack-ctl stop_ui  #Stop the UI service. [root@localhost ~]# zstack-ctl start_ui  #Start the UI service.
  5. Q: How do I extend the session timeout?

    A:
    • UI method:

      Go to Settings > Global Settings > Basic Settings, locate Session.timeout, and set a value as needed.

    • CLI method:
      Run the following commands in sequence:
      [root@localhost ~]# zstack-cli  #Go to the CLI mode. admin>>> LogInByAccount accountName=admin password=password #Log in to the CLI. Default user name/password: admin/password. admin>>> UpdateGlobalConfig name=session.timeout category=identity value=720000 #Change the session timeout to 200 hours.
  6. Q: How do I change the number of concurrent logins in ZStack?

    A:
    • UI method:

      Go to Settings > Global Settings > Advanced, locate Session.maxConcurrent, and set a value as needed.

    • CLI method:
      1. Run the QueryGlobalConfig name~=session command. Then, you will find that the maximum number of allowed concurrent sessions is 500.
        {             "category": "identity",             "defaultValue": "500",             "description": "Max number of sessions management server accepts. \ When this limit met, new session will be rejected",             "name": "session.maxConcurrent",             "value": "500"  }
      2. If you want to change the value to 1000, run the following command:
        UpdateGlobalConfig category=identity name="session.maxConcurrent" value=1000
  7. Q: How do I switch the language of the backend environment?

    A: The UI language and backend language of ZStack are independent of each other. The default backend language is Chinese. You can run the following commands in sequence to switch the language:
    [root@localhost ~]# zstack-ctl configure locale=en_US   #Switch the language. Note that en_US indicates English, and zh_CN indicates Chinese. [root@localhost ~]# zstack-ctl restart_node   #Restart the management node for the configuration to take effect.
  8. Q: Can I log in to the UI via HTTPS?

    A: ZStack allows you to log in to the UI via HTTPS or HTTP.






Back to Top

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.