Article ID: 3270, created on Nov 30, 2007, last review on Aug 12, 2014

  • Applies to:
  • H-Sphere

Resolution

In H-Sphere 3.0, H-Sphere installation and update is performed by a common script. This script brings about more flexibility in the process of installation, update and post-configuration, and introduces a variety of advanced features and improvements.

Before running H-Sphere updater/installer:

  1. Download the install/update script - it is actually located and run in a similar way as the update script in lower versions. For example, for H-Sphere 3.0 RC4 run under root on Linux box:

    # wget http://www.psoft.net/shiv/HS/releases/U30.0/U30.0RC4/U30.0RC4

  2. Run script with corresponding option:

    # sh U30.0RC4 update

    You will get the list of update modes, each having its own options.

    # sh U30.0RC4 install

    You will get the list of installation modes, each having its own options.

    # sh U30.0RC4

    the script will choose to update or install, according to what is available on the server:

    • To update H-Sphere, run the script in the update mode:
    • To install H-Sphere, run the script in the install mode:
    • If you run:
      • CP Unix user cpanel
      • the hsphere.properties file
      • consistent H-Sphere system PostgreSQL database
      • H-Sphere related software (if user ran updater mistakenly on a non-CP box)

Important: It is highly recommended to run script with specified update or install mode.

 

Update Modes and Options

After running the script with update mode, you will get the below menu with the choice of update options:

==========================================================================
                               UPDATE
==========================================================================
 (1) hsupdate    -- update H-Sphere cluster, except SiteStudio.
                    (for more details, type '1').
==========================================================================
 (2) update      -- update H-Sphere cluster including SiteStudio.
                    (for more details, type '2').
==========================================================================
 (3) sitestudio  -- update SiteStudio on the Control Panel box.
                    (for more details, type '3').
==========================================================================
 (4) cpupdate    -- update H-Sphere core and related packages only.
                    (for more details, type '4').
==========================================================================
 (5) deploy      -- H-Sphere cluster post-update configuration.
                    (for more details, type '5').
==========================================================================
 (6) hspackages  -- H-Sphere cluster update in custom mode; additional
                    update options (forming custom configuration files,
                    maintaining exclude package lists, skipping CP update,
                    etc.)
                    (for more details, type '6').
==========================================================================
 (7) 3rdpackages -- install missing files for H-Sphere 'hsp'
                    packages on physical boxes.
                    (for more details, type '7').
==========================================================================
 (8) revert      -- downgrade packages to previous versions.
                    (for more details, type '8').
==========================================================================

If you want more info on every mode, simply type its number in the command line.

Update modes:

Options:

revert pkgs=[ list | package_name,package_name2,.. ] [ help ]
  • hsupdate - common H-Sphere update, excluding system postgres and SiteStudio.

    Options:

    hsupdate          [ help ] [ ips=IP1,IP2,.. ] [ group=lgroup1,lgroup2,... ]  
                      [ private ] [ strict ] [ nomd5 ] [ force ] [ skip=stage ] [ url=Link ]
                      [ mirror=mirror_number ]
  • update - H-Sphere update, including system postgres and SiteStudio.

    Options:

    update           [ help ] [ ips=IP1,IP2,.. ] [ group=lgroup1,lgroup2,... ]
                     [ private ] [ strict ] [ nomd5 ] [ force ] [ skip=stage ] [ url=Link ] 
                     [ mirror=mirror_number ]
  • sitestudio - SiteStudio update.

    Options:

    sitestudio       [ help ] [ ips=IP1,IP2,.. ] [ group=lgroup1,lgroup2,... ] [ url=Link ]
                     [ mirror=mirror_number ]
  • cpupdate - update only Control Panel packages, templates, jars, etc.

    Options:

    
    cpupdate         [ help ] [ ips=IP1,IP2,.. ] [ group=lgroup1,lgroup2,... ] [ url=Link ] [ mirror=mirror_number ]
  • deploy - the so-called "deploy" mode is run after all the system packages are installed/updated. In the deploy mode H-Sphere updater downloads and installs post-configuration scripts that perform general H-Sphere post-install/post-update configuration. H-Sphere install/update script runs in the deploy mode to complete Single Server Edition H-Sphere installation in the the postsingle mode.

    Options:

    deploy           [ help ] [ ips=IP1,IP2,.. ] [ group=lgroup1,lgroup2,... ]
                     [ private ] [ strict ] [ nomd5 ] [ force ] [ skip=stage ] [ url=Link ] [ mirror=mirror_number ]
  • hspackages - advanced mode to update H-Sphere related packages across H-Sphere cluster.

    Options:

    hspackages         [ help ] [ ips=IP1,IP2,.. ] [ group=lgroup1,lgroup2,... ]
                       [ private ] [ strict ] [ nomd5 ] [ force ] [ skip=stage ] 
                       [ reconfig=front-end|spamassassin|all ]
                       [ mode=modename ] [ oscode ] [ mirror=mirror_number ]
                       [ exclude=[show|add:pattern1,...|del:pattern1,...|del:all] |
                       exclude-mysql=show|add|del | exclude-postgresql=show|add|del ]
                       [ sitestudio ] [ postgres ] [ url=Link ] [ verbose ]          
                       [ ctemplates=php,httpd,ftpd,mysql,pgsql,httpdcp,named ]       
                       [ edit=IP:/path/to/custom/template ] [ skip-exclude ]
                       [ old-platform ]

    Read more about hspackages options.

  • 3rdpackages - install missing files for H-Sphere 'hsp' packages on physical boxes.

     

    3rdpackages       [ help ] 

    This is a long term operation. To examine the output of the script use tail -f logfile command.

  • revert - downgrade packages to previous versions. (More..)

Options description:

 
  • mode=[hsupdate|update|ipmigration|deploy] - choose in whichever update mode to update packages.
  • ips - specify comma-separated list of target boxes' IPs the update will be resricted to;
  • group - specify the list of comma-separated logical server groups to be affected by the update. Possible groups: mail, web, dns, mysql, pgsql, cp, vps (using common ips and group tags is allowed).
  • nomd5 - update is not critical for wrong md5 sum, only warning;
  • force - check md5 sum of the installed packages with the same version too, if wrong md5 sum, install new package by force;
  • strict - form package list based exclusively on package list. By default, downgrade to older package version is skipped.
  • subversion - there is global hsphere package list and its subversion differences.
  • help2 - get additional possibilities description.
  • This key allow to check only subversion check to speed up update (of course, update to corresponding hsphere version is required before);
  • url=Link - alternative path for package download (instead of http://www.psoft.net/shiv/HS/);
  • verbose - inform whether package was installed by force or with nodeps;
  • exclude=[show|add:pattern1,pattern2,...|del:pattern1,pattern2,...|del:all] - show, set or delete list of the package patterns to be skipped during update on all or specified list of H-Sphere boxes.
    For example, to exclude hsphere-info-1-1 from the update on the 192.168.1.10 box, execute:
    hspackages exclude=add:hsphere-info ips=192.168.1.10
    i.e. package version must be left out.
    * Use this carefully, as H-Sphere packages have direct correlation with H-Sphere version. This may be used in the the following cases:
        1. You have customized version of the specific H-Sphere package.
        2. You update system packages, like MySQL server via native OS package manager, etc.
  • skip=[check|preparing]
    • check - skip check-up and regeneration of the existing updater.
    • preparing - skip config.xml regeneration on boxes during update.
  • sitestudio - update SiteStudio to last supported version.
  • postgres - update postgressql to the last supported version.
  • private - private update for testing purpose.
  • ctemplates=php,httpd,ftpd,mysql,pgsql - Place custom config file templates for comma-separated list of services into predefined locations if custom templates are not there already.
  • edit=IP:/path/to/custom/template - Edit custom config file template on a specified server in a specified location.
  • pkgs=[ list | package_name1,package_name2,.. ] - revert (downgrade) packages separated by comma. For example: revert=hsphere-webmails,mysql,hsphere-mnogosearch
    Using pkgs=list will display the list of all packages you can downgrade. Choose from the list. (Read more about Downgrading Packages to the Previous Version.
  • ( for HS 3.0+) mirror - allow to set another mirror instead of the default one. At this moment available are the following HS servers:
    N  Host             Location   Status
    --------------------------------------
    0  psoft.net        (USA)      default
    1  mirror.psoft.net (Europe)
  • ( for HS 3.0 Patch 1+) skip-exclude - skip pre-configured exclude package list during current update. skip pre-defined exclude list that was previously set via exclude
  • ( for HS 3.0 Patch 1+) old-platform - this option allows to force install/update for the deprecated OS/soft listed in https://kb.odin.com/en/9012.

f213b9fa8759d57bee5d547445806fe7 6311ae17c1ee52b36e68aaf4ad066387

Email subscription for changes to this article
Save as PDF