Package XML Configuration File (_pkg.xml)

• DTD Scheme: http://download.hsphere.parallels.com/HSdocumentation/xmls/package.dtd
• Example: http://download.hsphere.parallels.com/HSdocumentation/xmls/_pkg.xml

Tags and attributes:

• pkg - package information. It is set manually in _pkg.xml after package configurator run.

  Attributes:

  • name - package name.
  • description - brief description.
  • info - additional info.
  • vendor - package vendor.
  • version - package version.
  • build - package build.
• scripts - system scripts to be included into the package. This tag appears if package configurator runs with the --with-scripts option.

  Attributes:

  • src - directory in the package src/ directory where scripts are collected. It is pkg_scripts by default. You may not need to change it.
• classes - classes to be included into the package. This tag appears if package configurator runs with the --with-classes option.

  Attributes:

  • src - directory in the package src/ directory where classes are collected. It is pkg_classes by default. You may not need to change it.
• jars - jar files to be included into the package. This tag appears if package configurator runs with the --with-jars option.
• Attributes:
  • src - directory in the package src/ directory where classes are collected. It is pkg_jars by default. You may not need to change it.
• templates - custom templates to be included into the package. This tag appears if package configurator runs with the --with-templates option.

  Attributes:

  • src - directory in the package src/ directory where templates are collected. It is templates by default. You may not need to change it.
• xmls - custom XML configuration files to be included into the package. This tag appears if package configurator runs with the --with-xmls and --with-properties options.

  Attributes:

  • src - directory in the package src/ directory where custom XMLs are collected. It is pkg_xmls by default. You may not need to change it.
• images - custom images to be included into the package. This tag appears if package configurator runs with the --with-images and --with-properties option.

  Attributes:

  • src - directory in the package src/ directory where images are collected. It is pkg_images by default. You may not need to change it.
• lang_bundles - custom language bundles to be included into the package. This tag appears if package configurator runs with the --with-lang-bundle and --with-properties options.

  Attributes:

  • src - directory in the package /src directory where language bundles are collected. It is pkg_lang_bundle by default. You may not need to change it.
• sql - file with SQL queries to make changes in the Parallels H-Sphere database. This tag appears if package configurator runs with the --with-sql option.

  Attributes:

  • src - file location in the package src/ directory where scripts are collected. It is _SCRIPTS/_pkg.sql by default. You may not need to change it.
• config - custom language bundles to be included into the package. This tag appears if package configurator runs with the --with-properties option.

  Attributes:

  • path - file pathname relative to the package src/ directory. It is pkg_config/default.properties by default. You may not need to change it.
• actions - container tag for the scripts running before and after the package installation and uninstallation. They are created in the src/_SCRIPTS directory by default. You may not need to change their location.
• pre_install - tag with location of the script that runs before the package installation. This file (src/_SCRIPTS/_pre-install by default) is created empty when package configurator runs with the --with-preinstall option.
• post_install - tag with location of the script that runs after the package installation. This file (src/_SCRIPTS/_post-install by default) is created empty when package configurator runs with the --with-postinstall option.
• pre_uninstall - tag with location of the script that runs before package uninstallation. This file (src/_SCRIPTS/_pre-uninstall by default) is created empty when package configurator runs with the --with-preuninstall option.
• post_uninstall - tag with location of the script that runs after the package uninstallation. This file (src/_SCRIPTS/_post_uninstall by default) is created empty when package configurator runs with the --with-postuninstall option.
• rpms - container tag for the list of rpm tags with third-party RPMs (.rpm files) to be included into the package. The rpms and rpm tags appear when package configurator run with the --with-rpms option.
• rpm - third party RPM file information. During the package installation these RPMs will be copied to the /hsphere/shared/scripts/pkg_rpms/ directory to all servers belonging to a logical server group specified in the server_group attribute.

  Attributes:

  • name - RPM filename without .rpm extension.
  • server_group - Parallels H-Sphere logical server group this RPM relates to: WEB, MAIL, DNSANY applies tarballs to all logical server groups.
• tarballs - container tag for the list of tarball tags with third-party tarballs (.tgz files) to be included into the package. The tarballs and tarball tags appear when package configurator run with the --with-tarballs option.
• tarball - third party .tgz package file information. During the package installation these tarballs will be copied to the /hsphere/shared/scripts/3rd_party/ directory to all servers belonging to a logical server group specified in the server_group attribute.

  Attributes:

  • name - tarball filename without .tgz extension.
  • server_group - Parallels H-Sphere logical server group this tarball relates to: WEB, MAIL, DNS; ANY applies tarballs to all logical server groups.
• platform - tags (at least one; may be more than one) included into the tarball and rpm tags to specify location of third-party tarballs or RPMs for corresponding OS types.
• Attributes:
  • name - server OS type supported in Parallels H-Sphere: RH72, RH73, RHES, RHAS, RHAS3, FBSD4, ANY for all of the previously mentioned supported OSs.
  • location - tarball/RPM location for this type of platform. Location may be an URL: http://... or ftp://..., or it may be BUILT-IN.
    If location="BUILT-IN", the file will be taken from the OS type subdirectory (the name attribute of the platform tag) of the tarballs/RPMs directory (pkg_tarballs for tarballs or pkg_rpms for RPMs in the package's src/ directory).
    For example: src/pkg_rpms/RHEL4/rpm_name.rpm for an RPM file for RedHat Enterprise Linux EL 4 platform, where rpm_name is set in the name attribute of the rpm tag.

See also Building Packages guide for package configuration details.