Module 1.1: Parallels H-Sphere config.xml

From WebFocus Wiki Site
Jump to: navigation, search

Pre-Configuration Wizard

This document explains how to shape your Parallels H-Sphere cluster, add boxes and hosting services and configure basic Parallels H-Sphere settings after Control Panel installation. A.jpg

Parallels H-Sphere Pre-Configuration Wizard writes the cluster configuration into the specially formatted config.xml file (download sample config.xml from The Configuration File form on the main page enables you to:

  • Import: You upload the prepared XML file from a local machine to Parallels H-Sphere and later reconfigure Parallels H-Sphere in the wizard.
  • Export: export config.xml with your Parallels H-Sphere cluster configuration to your local machine.
  • Restore to Default: choose this option to recreate config.xml and to restart configuring Parallels H-Sphere cluster in the wizard.

> To complete the pre-configuration wizard:

1. Click the Edit General Settings icon on the right corner of the General Settings caption and fill in the data on the page that appears:

  • System Domain: Specify the service domain name here.
  • One Server Installation: check this box if you need a single server installation.
  • Use NAT IP mapping: Check this box if you implement NAT (on page 29) on your Parallels H-Sphere.

Press Submit and return to the main page of the wizard.

2. If you choose multiple server installation mode, you will see the Add Physical Server icon on the right corner of the Physical Servers caption. Click this icon and proceed to the form for adding new physical servers and services. Here you set physical server name, IP, root password to connect to, and choose which hosting services (CP, Web, mail, DNS, MySQL, PostgreSQL) will be installed there. Note: At the moment, VPS, Windows, MRTG are not installed via Parallels H-Sphere pre-configuration wizard. Choose Use defaults for this server to apply default names for Parallels H-Sphere logical servers on this server. By default, they are named webN, mailN, nsN, mailN, mysqlN, respectively.

3. After you have added physical servers into Parallels H-Sphere cluster, you will see them on the main page of the wizard. Click the Edit icon in front of a physical server in the list and edit logical server parameters. More on Logical Servers read in Parallels H-Sphere Service Administrator Guide.

4. After you have done with Parallels H-Sphere configuration, press Proceed Installation Wizard.

5. You will be taken to the Confirm Installation page. To complete installation via CP web interface, click Yes, continue

6. On the page that appears check the servers you want to be updated/installed and click Start. To see the update log, click the server name link. Pre-configuration Wizard 17 7. When update is finished and the light turns green, click Proceed to complete installation.

8. On the page that appears, click Return to Admin CP. You will be taken to the administrator control panel where you can maintain your hosting business.

Parallels H-Sphere config.xml

The config.xml file is used in Parallels H-Sphere Pre-configuration Wizard (on page 15). It contains Parallels H-Sphere cluster configuration: physical servers with their IPs and root passwords to install Parallels H-Sphere to, and logical servers to be installed on these boxes.

During regular Parallels H-Sphere installation, config.xml is formed in Parallels H-Sphere Pre-Configuration wizard in admin CP and is temporarily stored in the ~cpanel/.settings directory. After completing Parallels H- Sphere installation in the postinstall mode, installer removes this file. However, the postinstall mode won't continue if config.xml is missing or is different from the one used at the installation.

When installer runs in the install mode, it is required that you specify location of the correctly formed config.xml. See Appendix B. Installation Script Options of Parallels H-Sphere Control Panel Installation Guide.

Elements and AttributesElements and AttributesElements

In the following chart xml elements are marked in bold and their attributes -- in italics. physicalServers - a list of Parallels H-Sphere physical servers, each of them described as physicalServer with attributes:

  • id - id of the physical server
  • name - name of the physical server

password - root password to the physical server Each physicalServer contains ip and logicalServers elements:

  • ip - server IP with attribute:
  • type - type of the physical server

Element ip contains such child elements:

  • addr - IP address
  • ipExt - external IP for NAT mapping

Note: If Parallels H-Sphere does not use NAT, this child element is redundant.

  • mask - IP mask
  • logicalServers - a list of Parallels H-Sphere logical servers each of them described as logicalServer with attributes:
  • group - group of the logical server
  • id -id of the logical server
  • name - name of the logical server

Each logicalServer element contains ips element - a list of IPs, each of them described as ip with the following child elements:

  • addr - IP address
  • ipExt - external IP for NAT mapping

Note: If Parallels H-Sphere does not use NAT this child element is redundant.

  • mask - IP mask

systemzone - a Parallels H-Sphere DNS zone hsversion - a Parallels H-Sphere version