Parallels H-Sphere Documentation Developer Guide

 

Java Tools For Packaging

 
 

Related Docs:   Building Packages Package Installation

Last modified: 28 Dec 2007

 

WARNING: This documentation covers Parallels H-Sphere versions up to 3.1. For the latest up-to-date Parallels H-Sphere documentation, please proceed to the official Parallels site.

Packages are configured, built and installed by means of Java classes located in the directory /hsphere/local/home/cpanel/shiva/psoft/hsp/tools/:

 

Package Configurator

Package Configurator (PkgConfigurator) is a tool to configure directory structure for assembling H-Sphere packages. PkgConfigurator creates the package directory skeleton and populates it with files used by the package. The parameters specify the types of the files and where they must be copied from. The source locations must have the correct directory structure. If the path parameter is omitted, the directory skeleton is created empty, and the files will have to be copied manually.

SYNOPSIS:
java psoft.hsp.tools.PkgConfigurator
     --with-prefix[=/path/to/directory]
        [   --with-templates[=/path/to/directory]   ]
        [   --with-images[=/path/to/directory]   ]
        [   --with-properties[=/path/to/directory]   ]
        [  --with-xmls[=/path/to/directory]  ]
        [   --with-classes[=/path/to/directory]   ]
        [   --with-scripts[=/path/to/directory] | --with-scripts-advanced[=/path/to/directory]   ]
        [   --with-scripts-advanced   ]
        [   --with-lang-bundle[=/path/to/directory]   ]
        [   --with-preinstall[=/path/to/file]    ]
        [   --with-postinstall[=/path/to/file]   ]
        [   --with-preupgrade[=/path/to/file]    ]
        [   --with-postupgrade[=/path/to/file]   ]
        [   --with-preuninstall[=/path/to/file]   ]
        [   --with-postuninstall[=/path/to/file]   ]
        [   --with-jars[=/path/to/directory]   ]
        [   --with-rpms   ]
        [   --with-tarballs   ]
        [   --with-sql[=/path/to/file]   ]
        [   --with-sql-uninstall[=/path/to/file]   ]
        [   --with-sql-upgrade[=/path/to/file]   ]
        [   --with-uninstall-sql[=/path/to/file]  ]
        [ - l log_file [ -dl ] ]

Allowed parameters:

  • --with-prefix[=/path/to/directory]

    Specifies the directory where the package skeleton will be generated. If the parameter is omitted, the current working directory will be used as the destination folder.

  • [ --with-templates[=/path/to/directory] ]

    Specifies that the package contains templates. The template files must be located relative to the custom templates directory. If the path parameter is omitted, the default directory skeleton will be generated in the package's templates directory, otherwise, templates located in the specified path will be copied to the package directory.

  • [ --with-images[=/path/to/directory] ]

    Specifies that the package contains images. The path to the custom directory should be specified.

  • [ --with-properties[=/path/to/directory] ]

    Specifies that the package requires custom .properties file to be appended to hsphere.properties. If the parameter path is present, the .properties file will be copied from the path specified.

  • [ --with-xmls[=/path/to/directory] ]

    Specifies that the package uses custom XML configuration files. This allows to customize menu, hosting plans, CP design.
    Important: Run this option with the --with-properties option to add custom XML files location into the package properties file.

  • [ --with-classes[=/path/to/directory] ]

    Specifies that the package contains java classes. This allows to add new classes and override H-Sphere core classes.

  • [ --with-scripts[=/path/to/directory] | --with-scripts-advanced[=/path/to/directory] ]

    Specifies that the package contains system scripts. This allows to add new scripts and override core H-Sphere scripts.

  • [ --with-lang-bundle[=/path/to/directory] ]

    Specifies that the package contains language bundle files. This allows to define new languages and override the default language dependent elements.
    Important: Run this option with the --with-properties option to add custom language bundle configuration into the package properties file.

  • [ --with-preinstall[=/path/to/file] ]

    Specifies that the package contains a pre-installed script which will be executed before the installation of the package.

  • [ --with-postinstall[=/path/to/file] ]

    Specifies that the package contains a postinstall script which will be executed after the deployment of package files.

  • (HS 2.4.3+) [ --with-preupgrade[=/path/to/file] ]

    Specifies that the package contains the script which will be executed before the the package upgrade.

  • (HS 2.4.3+) [ --with-postinstall[=/path/to/file] ]

    Specifies that the package contains the script which will be executed after the package upgrade.

  • [ --with-preuninstall[=/path/to/file] ]

    Specifies that the package contains a pre-uninstall script which will be executed before the deletion of package files.

  • [ --with-postuninstall[=/path/to/file] ]

    Specifies that the package contains a post-uninstall script which will be executed after the deletion of package files.

  • [ --with-jars[=/path/to/directory]

    Specifies that the package contains Java libraries.

  • [ --with-rpms ]

    Specifies that the package contains third party products supplied as RPMs.

  • [ --with-tarballs ]

    Specifies that the package contains third party products supplied as tarballs (.tgz files).

  • [ --with-sql[=/path/to/file] ]

    Specifies that the package contains SQL file(s) which will be executed against H-Sphere database after the deployment of the package files and before the execution of the package preinstall script if it is pre-configured.

  • (HS 2.4.3+) [ --with-sql-upgrade[=/path/to/file] ]

    Specifies that the package will have the file with SQL queries to be run upon the package upgrade.

  • (HS 2.4.3+) [ --with-uninstall-sql[=/path/to/file] ]

    Specifies that the package will have the file with SQL queries to be run upon the package uninstallation.

  • [ -l log_file [ -dl ] ]

    Creates and writes configuration process messages to a log file; -dl is a detailed log mode.

Example:

java psoft.hsp.tools.PkgConfigurator --with-prefix=./SuperPKG --with-templates --with-classes --with-scripts --with-properties -l conf.log -dl

The package source files consisting of templates, Java classes, system scripts and the custom properties file will be copied to the SuperPKG subdirectory of the current directory.

 

Package Builder

Package builder is a tool to build a package as one jar file after the package is pre-configured by package configurator and all required tuning is performed. Package builder checks if all required files in the package source directory are present, checks the config file and the package properties file if they are present, forms one jar file from Java classes if they are present and makes a package as one jar file with .hsp extension.

SYNOPSIS:
java psoft.hsp.tools.PkgBuilder --with-source=/path/to/package/source

Example:

java psoft.hsp.tools.PkgBuilder --with-source=./SuperPKG

 

Package Installer

SYNOPSIS:
java psoft.hsp.tools.PkgInstaller
     --package=/path/to/package/file
     [--upgrade] [--check-only] [--force]

Options:

  • --package=/path/to/package/file

    Specifies the path to the built package. H-Sphere package is a Java archive file (JAR) with .hsp extension.

  • (HS 2.4.3+) [--upgrade]

    Use this option if you upgrade the package already installed on your H-Sphere. With this option, you can easily upgrade the package without uninstallation of the older package and restarting H-Sphere after the uninstallation.

  • [--check-only]

    Makes utility not install the package but only perform a check routine if the package can be installed.

  • [--force]

    Forces the package installation even if conflicts were detected. For example, if you are installing two packages that use exactly the same file, install the first one without, and the second one with the --force option. The first instance of the file will be replaced with the second. Use this option only if you are sure this won't damage other packages.

See Package Installation for details.

 

Package Uninstaller

SYNOPSIS:
java psoft.hsp.tools.PkgUnInstaller
     --pkg-name=PACKAGE_NAME
     [--force]

Options:

  • --pkg-name=PACKAGE_NAME - specify the package name. It should be without the version and build number, as in the Package Name column in the list of installed packages (Settings/Packages menu in admin panel).
    For example, if the package installed is MyPackage-1.0.1-2.hsp, package name to be specified is MyPackage:

    java psoft.hsp.tools.PkgUnInstaller --pkg-name=MyPackage

  • --force - force the uninstallation.

 

Package Checker

Starting with 2.4.3 RC 2, scripts, tarballs, and rpms included into an H-Sphere packages are copied to the ~cpanel/shiva/packages/PACKAGE_NAME directory on the CP server. If needed, use java psoft.hsp.tools.PkgRecheck to check package integrity and reinstall the missing files from the *.hsp file.

This is true only for new H-Sphere packages. You will need to copy *.hsp packages already installed on your boxes to the corresponding ~cpanel/shiva/packages/PACKAGE_NAME directories on the CP server.

SYNOPSIS:
java psoft.hsp.tools.PkgRecheck [--pkg-name=PACKAGE_NAME] [--force]

Options:

  • [--pkg-name=PACKAGE_NAME]

    Specifies the path to the package checked; otherwise, checks all installed packages.

  • [--force]

    Reinstalls missing package files on remote physical boxes.


Related Docs:   Building Packages Package Installation



© Copyright 2017. Parallels Holdings. All rights reserved.