Difference between revisions of "Upgrading GlobalSight"

From Globalsight
Jump to navigation Jump to search
m (1 revision)
Line 1: Line 1:
 
{{Docset_side}}
 
{{Docset_side}}
−
You can upgrade easily from one version of GlobalSight to another using the '''GlobalSight Upgrade Installer'''.  
+
You can upgrade easily from one version of GlobalSight to a newer version using the '''GlobalSight Upgrade Installer'''.  
  
−
To download and install the upgrade installer, follow the instructions below for Windows or Ubuntu.
+
To download the upgrade installer package and upgrade GlobalSight core application, follow the instructions below for Windows or Ubuntu.
  
−
__TOC__
+
 
−
==Pre-requisites==
+
==Prerequisites==
 
'''Before beginning, make sure that:'''
 
'''Before beginning, make sure that:'''
 
* The GlobalSight service is stopped
 
* The GlobalSight service is stopped
−
* The MySQL database is started
+
* The MySQL database server is running
  
 
==Windows==
 
==Windows==
−
'''To download and install the upgrade installer:'''
+
===Pre-upgrade procedures===
−
# Download and unzip the '''GlobalSight_Upgrade_Installer_<version>.zip''' package
+
# Download and unzip the GlobalSight Upgrade Installer package ''<tt>GlobalSight_Upgrade_Installer_<version>.zip</tt>'' to local system
−
# Double-click '''run.bat'''<br>[[File:upgrade1.jpg|thumb|left|500px]]<br><br><br><br><br><br><br><br><br><br><br><br><br><br>
+
# Edit '''config.properties''' file to set GlobalSight application directory and certificate information to sign code for some Java applet components
−
# Click '''Next'''. The installer looks for the '''installValues.properties''' file in the C:\Documents and Settings\<user>\Local Setting\Temp folder to determine the GlobalSight installation directory. If this is found, it proceeds with the upgrade. If this is not found, you are prompted to enter the GlobalSight installation directory manually<br>[[File:upgrade2.jpg|thumb|left|500px]]<br style="clear: both" />[[File:upgrade3.jpg|thumb|left|500px]]<br style="clear: both" />
+
#: <code>gsHome</code>: the absolute path to GlobalSight application directory. Using forward slash as the path separator
−
# Enter the GlobalSight installation directory and click '''OK'''<br>[[File:upgrade4.jpg|thumb|left|500px]]<br style="clear: both" />
+
#: <code>JKS</code>: the absolute path to the certificate keystore file, uncomment it if needed.  Using forward slash as the path separator
−
# Click '''Finish''' to exit. The installer backs up the previous version of GlobalSight and applies the upgrade to your GlobalSight instance. The backup is stored in the <GlobalSight_Upgrade_Installer_x.x.x.x>\installer\backup folder<br>[[File:upgrade5.jpg|thumb|left|500px]]<br style="clear: both" />
+
#: <code>keyPass</code>: the passphrase/password of the certificate keystore file, uncomment it if needed
−
# Re-start the GlobalSight service
+
#: <code>keyAlias</code>: the alias of the certificate keystore file, uncomment it if needed
 +
 
 +
===Extra procedures for upgrading GlobalSight 8.6 to 8.6.6===
 +
 
 +
* Install Oracle JDK 8 and update system variable <code>JAVA_HOME</code>
 +
*: Oracle JDK 8 (at least jdk1.8.0_45) is required for GlobalSight version 8.6.3 and above.
 +
* Replace website header image
 +
*: Find '''globe_header.gif''' in current GlobalSight application, and replace it with ''<tt>GlobalSight_Upgrade_Installer_<version>\server\GlobalSight\jboss\server\standalone\deployments\globalsight.ear/globalsight-web.war\images\globe_header.gif</tt>''
 +
: Note: The original website header image is not in GIF format, which will not show on Microsoft Internet Explorer after ungrading to GlobalSight version 8.6.6.
 +
 
 +
===To upgrade GlobalSight using the Upgrade Installer===
 +
 
 +
# Double-click '''run.bat''' to launch the installer
 +
#: [[File:upgrade1.png|thumb|left|500px]] <br style="clear: both" />
 +
#: Note: if you need run the Upgrade Installer as Administrator, change below line in '''run.bat''' before running it:
 +
#:: <code>cd installer</code> to <code>cd %~dp0\installer</code>
 +
# Click '''Next''' to the next screen
 +
#: If <code>gsHome</code> is not defined in '''config.properties''' file, or the Upgrade Installer cannot find current GlobalSight application directory, you are prompted to enter the GlobalSight application directory manually.
 +
#:[[File:upgrade2.png|thumb|left|500px]]<br style="clear: both" />
 +
# Enter the GlobalSight application directory and click '''OK'''
 +
#:[[File:upgrade3.png|thumb|left|500px]]<br style="clear: both" />
 +
# Beginning with GlobalSight 8.6.3, the upgrade installer also checks whether a version of Oracle JDK 8 is installed. Enter the JDK 8 home directory and click '''OK'''
 +
#:[[File:upgrade4.png|thumb|left|500px]]<br style="clear: both" />
 +
# Click '''Finish''' to exit
 +
#: [[File:upgrade5.png|thumb|left|500px]]<br style="clear: both" />
 +
 
 +
The Upgrade Installer backs up the previous version of GlobalSight application and applies the upgrade. The GlobalSight application backup is stored in the ''<tt>\path\to\GlobalSight_Upgrade_Installer_<version>\installer\backup</tt>'' folder
  
−
You can find the upgrade log in the <GlobalSight_Upgrade_Installer_x.x.x.x>\installer\log.txt file.
+
The upgrade log file '''log.txt''' can be found in ''<tt>\path\to\GlobalSight_Upgrade_Installer_<version>\installer</tt>'' folder.
 +
 
 +
===Post-upgrade procedures===
 +
 
 +
Restart GlobalSight service.
  
 
==Ubuntu==
 
==Ubuntu==
−
'''Before beginning:'''
+
 
−
* Log in as a user with sudo privileges 
+
===Pre-upgrade procedures===
−
* Stop Globalsight: /etc/init.d/globalsight stop
+
* Log in as a user with '''sudo''' privilege
 +
* Stop Globalsight
 +
*: Type: '''sudo service globalsight stop'''
 
* Make sure that the MySQL database is running
 
* Make sure that the MySQL database is running
 +
*: Type: '''sudo service mysql status'''
 +
*: To check remote MysQL database server's status
 +
*: Type: '''mysqladmin status -u''' <i><tt><globalsight_user_name></tt></i> '''-p -h''' <i><tt><mysql_hostname_or_ip_ address></tt></i> '''-P''' <i><tt><mysql_port></tt></i>
 +
*: Example: mysqladmin status -u globalsight -p -h 192.168.1.29 -P 3306
 +
* Download and unjar the GlobalSight upgrade installer package
 +
*: Type: '''mkdir''' <i><tt>GlobalSight_Upgrade_Installer_<version></tt></i> '''&& cd''' <i><tt>GlobalSight_Upgrade_Installer_<version></tt></i>
 +
*: Example: mkdir GlobalSight_Upgrade_Installer_8.6.6 && cd GlobalSight_Upgrade_Installer_8.6.6
 +
*: Type: '''jar xvf''' <i><tt>/path/to/GlobalSight_Upgrade_Installer_<version>.zip</tt></i>
 +
*: Example: jar xvf /home/jboss/GlobalSight_Upgrade_Installer_8.6.6.zip
 +
* Edit '''config.properties''' file to set GlobalSight application directory and certificate information to sign code for some Java applet components
 +
*: <code>gsHome</code>: the absolute path to GlobalSight application directory
 +
*: <code>JKS</code>: the absolute path to the certificate keystore file, uncomment it if needed
 +
*: <code>keyPass</code>: the passphrase/password of the certificate keystore file, uncomment it if needed
 +
*: <code>keyAlias</code>: the alias of the certificate keystore file, uncomment it if needed
 +
* Update GlobalSight daemon template <i><tt>/path/to/GlobalSight_Upgrade_Installer_<version></tt></i><strong>/server/GlobalSight/jboss/util/bin/service.sh.template</strong> file
 +
*: Insert <code> -c ${JBOSS_USER} -d ${JBOSS_HOME}</code> between <code>--background</code> and <code>--user</code>
 +
*: Example:  <code>start-stop-daemon --start --quiet --background -c ${JBOSS_USER} -d ${JBOSS_HOME} --user ${JBOSS_USER} --exec ${JBOSS_HOME}/bin/standalone.sh</code>
 +
*: Example: <code>start-stop-daemon --start --quiet --background -c ${JBOSS_USER} -d ${JBOSS_HOME} --user ${JBOSS_USER} --exec ${JBOSS_HOME}/bin/jboss-cli.sh -- --connect command=:shutdown</code>
 +
*: Note: this modification ensures that GlobalSight daemon is always running as user '''jboss'''.
 +
 +
===Extra procedures for upgrading GlobalSight 8.6 to 8.6.6===
 +
* Install Oracle JDK 8 and update system variable <code>JAVA_HOME</code>
 +
*: Oracle JDK 8 (at least jdk1.8.0_45) is required for GlobalSight version 8.6.3 and above. The install procedure can be found at [[Installing_Third-party_Components_for_GlobalSight_on_Ubuntu#Installing_JDK|Installing JDK]].
 +
* Replace website header image
 +
*: Type: '''sudo cp''' <i><tt>/path/to/GlobalSight_Upgrade_Installer_<version>/server/GlobalSight/jboss/server/standalone/deployments/globalsight.ear/globalsight-web.war/images/globe_header.gif</tt></i> <i><tt><globalsight_home_directory>/server/GlobalSight/jboss/server/standalone/deployments/globalsight.ear/globalsight-web.war/images/</tt></i>
 +
*: Example: sudo cp GlobalSight_Upgrade_Installer_8.6.6/server/GlobalSight/jboss/server/standalone/deployments/globalsight.ear/globalsight-web.war/images/globe_header.gif /home/jboss/GlobalSight/jboss/server/standalone/deployments/globalsight.ear/globalsight-web.war/images/
 +
:Note: The original website header image is not in GIF format, which will not show on Microsoft Internet Explorer after ungrading to GlobalSight version 8.6.6.
  
−
'''To download and install the upgrade installer:'''
+
===To upgrade GlobalSight using the Upgrade Installer===
−
# Download and un-jar the '''GlobalSight_Upgrade_Installer_<version>.zip'''<br>Type: jar xvf GlobalSight_Upgrade_Installer_<version>.zip
+
# Add the execute attribute to upgrade script '''run.sh'''
−
# Add the execute attribute to run.sh<br>Type: chmod u+x run.sh
+
#: Type: cd <i><tt>/path/to/GlobalSight_Upgrade_Installer_<version></tt></i>
−
# Run the GlobalSight Upgrade Installer<br>Type: ./run.sh<br>[[File:upgrade6.jpg|thumb|left|500px]]<br style="clear: both" />
+
#: Type: '''sudo chmod u+x run.sh'''
−
# The installer looks for the '''installValues.properties''' file in the/tmp folder to determine the GlobalSight installation directory.<br>If this file is found, it proceeds with the upgrade<br> If this file is not found, you are prompted to enter the GlobalSight installation directory manually<br>[[File:upgrade7.jpg|thumb|left|500px]]<br style="clear: both" />
+
# Run the GlobalSight Upgrade Installer
−
# Enter the GlobalSight installation directory and press '''Enter'''<br>[[File:upgrade8.jpg|thumb|left|500px]]<br style="clear: both" />
+
#: Type: '''sudo PATH=$JAVA_HOME/bin:$PATH ./run.sh'''
−
# Press '''Enter''' to exit the installer. It backs up the previous version of GlobalSight and applies the upgrade to GlobalSight. The backup is stored in <GlobalSight_Upgrade_Installer_x.x.x.x>/installer/backup directory<br>[[File:upgrade9.jpg|thumb|left|500px]]<br style="clear: both" />
+
#: [[File:upgrade6.png|thumb|left|500px]]<br style="clear: both" />
−
# Re-start GlobalSight<br>Type: /etc/init.d/globalsight start
+
# Press '''Enter''' to go to the next screen
 +
#: [[File:upgrade7.png|thumb|left|500px]]<br style="clear: both" />
 +
#: The Upgrade Installer looks for the '''installValues.properties''' file to determine the GlobalSight application directory.
 +
#: If <code>gsHome</code> in <i><tt>/path/to/GlobalSight_Upgrade_Installer_<version>/config.properties</tt></i> file is set, or '''/tmp/installValues.properties''' file is found, it proceeds with the upgrade. Otherwise you are prompted to enter the GlobalSight application directory manually.
 +
#: [[File:upgrade8.png|thumb|left|500px]]<br style="clear: both" />
 +
# Enter the GlobalSight application directory and press '''Enter'''
 +
#: [[File:upgrade9.png|thumb|left|500px]]<br style="clear: both" />
 +
# Beginning with GlobalSight 8.6.3, the upgrade installer also checks whether a version of Oracle JDK 8 is installed. Enter the JDK 8 home directory and press '''Enter'''
 +
#: [[File:upgrade10.png|thumb|left|500px]]<br style="clear: both" />
 +
# Press '''Enter''' to exit the upgrade installer.  
 +
#: [[File:upgrade11.png|thumb|left|500px]]<br style="clear: both" />
  
−
The upgrade log can be found in <GlobalSight_Upgrade_Installer_x.x.x.x>/installer/log.txt.
+
The Upgrade Installer backs up the previous version of GlobalSight application and applies the upgrade. The GlobalSight application backup is stored in <i><tt>/path/to/GlobalSight_Upgrade_Installer_<version>/installer/backup</tt></I> directory.
  
 +
The upgrade log file '''log.txt''' can be found in <i><tt>/path/to/GlobalSight_Upgrade_Installer_<version>/installer</tt></i> directory.
  
 +
===Post-upgrade procedures===
 +
# Change the ownership of the GlobalSight application
 +
#: Type: '''sudo chown -R jboss:jboss''' <i><tt><globalsight_home_directory></tt></i>
 +
#: Example: sudo chown -R jboss:jboss /home/jboss/GlobalSight/
 +
# Add executable attribute for start and stop script files
 +
#: Type: '''sudo chmod u+x''' <i><tt><globalsight_home_directory>/jboss/server/bin/standalone.sh</tt></i>
 +
#: Type: '''sudo chmod u+x''' <i><tt><globalsight_home_directory>/jboss/server/bin/jboss-cli.sh</tt></i>
 +
#: Example: sudo chmod u+x /home/jboss/GlobalSight/jboss/server/bin/standalone.sh
 +
#: Example: sudo chmod u+x /home/jboss/GlobalSight/jboss/server/bin/jboss-cli.sh
 +
# Change the ownership of GlobalSight documents and file storage directory
 +
#: Type: '''sudo chown -R jboss:jboss''' <i><tt><globalsight_document_directory></tt></i>
 +
#: Type: '''sudo chown -R jboss:jboss''' <i><tt><globalsight_filestorage_directory></tt></i>
 +
#: Example: sudo chown -R jboss:jboss /home/jboss/welocalize/
 +
# Restart GlobalSight
 +
#: Type: '''sudo service globalsight start'''
  
 
[[Category:GlobalSight]]
 
[[Category:GlobalSight]]

Revision as of 20:28, 8 March 2016

Developers
Go to: Getting Started Guide
Footer-logo.gif
System requirements

Installing GlobalSight
3rd party comps: Windows | Ubuntu
GlobalSight: Windows | Ubuntu
Desktop Icon

Setting up GlobalSight
Running GlobalSight Behind an Apache Reverse Proxy

Developing GlobalSight
GlobalSight Architecture
Getting the Code
Building and Deploying GlobalSight
GlobalSight Developer’s Guide
Setting up the Development Environment
Debugging GlobalSight
Designing the GlobalSight Adapters
GlobalSight Web Services API
Using the GlobalSight Web Services API Test Tool
Using the GlobalSight CVS Connector
Connecting to a CVS with the GlobalSight Desktop Icon

Upgrading GlobalSight
Comparing GlobalSight with WorldServer

You can upgrade easily from one version of GlobalSight to a newer version using the GlobalSight Upgrade Installer.

To download the upgrade installer package and upgrade GlobalSight core application, follow the instructions below for Windows or Ubuntu.


Prerequisites

Before beginning, make sure that:

  • The GlobalSight service is stopped
  • The MySQL database server is running

Windows

Pre-upgrade procedures

  1. Download and unzip the GlobalSight Upgrade Installer package GlobalSight_Upgrade_Installer_<version>.zip to local system
  2. Edit config.properties file to set GlobalSight application directory and certificate information to sign code for some Java applet components
    gsHome: the absolute path to GlobalSight application directory. Using forward slash as the path separator
    JKS: the absolute path to the certificate keystore file, uncomment it if needed. Using forward slash as the path separator
    keyPass: the passphrase/password of the certificate keystore file, uncomment it if needed
    keyAlias: the alias of the certificate keystore file, uncomment it if needed

Extra procedures for upgrading GlobalSight 8.6 to 8.6.6

  • Install Oracle JDK 8 and update system variable JAVA_HOME
    Oracle JDK 8 (at least jdk1.8.0_45) is required for GlobalSight version 8.6.3 and above.
  • Replace website header image
    Find globe_header.gif in current GlobalSight application, and replace it with GlobalSight_Upgrade_Installer_<version>\server\GlobalSight\jboss\server\standalone\deployments\globalsight.ear/globalsight-web.war\images\globe_header.gif
Note: The original website header image is not in GIF format, which will not show on Microsoft Internet Explorer after ungrading to GlobalSight version 8.6.6.

To upgrade GlobalSight using the Upgrade Installer

  1. Double-click run.bat to launch the installer
    File:Upgrade1.png
    500px

    Note: if you need run the Upgrade Installer as Administrator, change below line in run.bat before running it:
    cd installer to cd %~dp0\installer
  2. Click Next to the next screen
    If gsHome is not defined in config.properties file, or the Upgrade Installer cannot find current GlobalSight application directory, you are prompted to enter the GlobalSight application directory manually.
    File:Upgrade2.png
    500px

  3. Enter the GlobalSight application directory and click OK
    File:Upgrade3.png
    500px

  4. Beginning with GlobalSight 8.6.3, the upgrade installer also checks whether a version of Oracle JDK 8 is installed. Enter the JDK 8 home directory and click OK
    File:Upgrade4.png
    500px

  5. Click Finish to exit
    File:Upgrade5.png
    500px

The Upgrade Installer backs up the previous version of GlobalSight application and applies the upgrade. The GlobalSight application backup is stored in the \path\to\GlobalSight_Upgrade_Installer_<version>\installer\backup folder

The upgrade log file log.txt can be found in \path\to\GlobalSight_Upgrade_Installer_<version>\installer folder.

Post-upgrade procedures

Restart GlobalSight service.

Ubuntu

Pre-upgrade procedures

  • Log in as a user with sudo privilege
  • Stop Globalsight
    Type: sudo service globalsight stop
  • Make sure that the MySQL database is running
    Type: sudo service mysql status
    To check remote MysQL database server's status
    Type: mysqladmin status -u <globalsight_user_name> -p -h <mysql_hostname_or_ip_ address> -P <mysql_port>
    Example: mysqladmin status -u globalsight -p -h 192.168.1.29 -P 3306
  • Download and unjar the GlobalSight upgrade installer package
    Type: mkdir GlobalSight_Upgrade_Installer_<version> && cd GlobalSight_Upgrade_Installer_<version>
    Example: mkdir GlobalSight_Upgrade_Installer_8.6.6 && cd GlobalSight_Upgrade_Installer_8.6.6
    Type: jar xvf /path/to/GlobalSight_Upgrade_Installer_<version>.zip
    Example: jar xvf /home/jboss/GlobalSight_Upgrade_Installer_8.6.6.zip
  • Edit config.properties file to set GlobalSight application directory and certificate information to sign code for some Java applet components
    gsHome: the absolute path to GlobalSight application directory
    JKS: the absolute path to the certificate keystore file, uncomment it if needed
    keyPass: the passphrase/password of the certificate keystore file, uncomment it if needed
    keyAlias: the alias of the certificate keystore file, uncomment it if needed
  • Update GlobalSight daemon template /path/to/GlobalSight_Upgrade_Installer_<version>/server/GlobalSight/jboss/util/bin/service.sh.template file
    Insert -c ${JBOSS_USER} -d ${JBOSS_HOME} between --background and --user
    Example: start-stop-daemon --start --quiet --background -c ${JBOSS_USER} -d ${JBOSS_HOME} --user ${JBOSS_USER} --exec ${JBOSS_HOME}/bin/standalone.sh
    Example: start-stop-daemon --start --quiet --background -c ${JBOSS_USER} -d ${JBOSS_HOME} --user ${JBOSS_USER} --exec ${JBOSS_HOME}/bin/jboss-cli.sh -- --connect command=:shutdown
    Note: this modification ensures that GlobalSight daemon is always running as user jboss.

Extra procedures for upgrading GlobalSight 8.6 to 8.6.6

  • Install Oracle JDK 8 and update system variable JAVA_HOME
    Oracle JDK 8 (at least jdk1.8.0_45) is required for GlobalSight version 8.6.3 and above. The install procedure can be found at Installing JDK.
  • Replace website header image
    Type: sudo cp /path/to/GlobalSight_Upgrade_Installer_<version>/server/GlobalSight/jboss/server/standalone/deployments/globalsight.ear/globalsight-web.war/images/globe_header.gif <globalsight_home_directory>/server/GlobalSight/jboss/server/standalone/deployments/globalsight.ear/globalsight-web.war/images/
    Example: sudo cp GlobalSight_Upgrade_Installer_8.6.6/server/GlobalSight/jboss/server/standalone/deployments/globalsight.ear/globalsight-web.war/images/globe_header.gif /home/jboss/GlobalSight/jboss/server/standalone/deployments/globalsight.ear/globalsight-web.war/images/
Note: The original website header image is not in GIF format, which will not show on Microsoft Internet Explorer after ungrading to GlobalSight version 8.6.6.

To upgrade GlobalSight using the Upgrade Installer

  1. Add the execute attribute to upgrade script run.sh
    Type: cd /path/to/GlobalSight_Upgrade_Installer_<version>
    Type: sudo chmod u+x run.sh
  2. Run the GlobalSight Upgrade Installer
    Type: sudo PATH=$JAVA_HOME/bin:$PATH ./run.sh
    File:Upgrade6.png
    500px

  3. Press Enter to go to the next screen
    File:Upgrade7.png
    500px

    The Upgrade Installer looks for the installValues.properties file to determine the GlobalSight application directory.
    If gsHome in /path/to/GlobalSight_Upgrade_Installer_<version>/config.properties file is set, or /tmp/installValues.properties file is found, it proceeds with the upgrade. Otherwise you are prompted to enter the GlobalSight application directory manually.
    File:Upgrade8.png
    500px

  4. Enter the GlobalSight application directory and press Enter
    File:Upgrade9.png
    500px

  5. Beginning with GlobalSight 8.6.3, the upgrade installer also checks whether a version of Oracle JDK 8 is installed. Enter the JDK 8 home directory and press Enter
    File:Upgrade10.png
    500px

  6. Press Enter to exit the upgrade installer.
    File:Upgrade11.png
    500px

The Upgrade Installer backs up the previous version of GlobalSight application and applies the upgrade. The GlobalSight application backup is stored in /path/to/GlobalSight_Upgrade_Installer_<version>/installer/backup directory.

The upgrade log file log.txt can be found in /path/to/GlobalSight_Upgrade_Installer_<version>/installer directory.

Post-upgrade procedures

  1. Change the ownership of the GlobalSight application
    Type: sudo chown -R jboss:jboss <globalsight_home_directory>
    Example: sudo chown -R jboss:jboss /home/jboss/GlobalSight/
  2. Add executable attribute for start and stop script files
    Type: sudo chmod u+x <globalsight_home_directory>/jboss/server/bin/standalone.sh
    Type: sudo chmod u+x <globalsight_home_directory>/jboss/server/bin/jboss-cli.sh
    Example: sudo chmod u+x /home/jboss/GlobalSight/jboss/server/bin/standalone.sh
    Example: sudo chmod u+x /home/jboss/GlobalSight/jboss/server/bin/jboss-cli.sh
  3. Change the ownership of GlobalSight documents and file storage directory
    Type: sudo chown -R jboss:jboss <globalsight_document_directory>
    Type: sudo chown -R jboss:jboss <globalsight_filestorage_directory>
    Example: sudo chown -R jboss:jboss /home/jboss/welocalize/
  4. Restart GlobalSight
    Type: sudo service globalsight start
Retrieved from "http://www.globalsight.com/wiki/index.php?title=Upgrading_GlobalSight&oldid=5053"