Difference between revisions of "Lingoport Suite Installation Instructions"

From Lingoport Wiki
Jump to: navigation, search
Line 1: Line 1:
  +
−
TODO: add links for where to download all prerequisites.
  
  +
  +
 
= Read Me First =
  
= Read Me First =
   
Line 13: Line 15:
   
 
You'll want to take a moment to read over the table of contents summary for the
  
You'll want to take a moment to read over the table of contents summary for the
−
Installation Steps (see above) before proceeding. You may otherwise read the
 +
Installation Steps (see above) before proceeding.
  +
−
instructions as you go. You can of course read/skim over them before proceeding
  
  +
You may otherwise read the instructions as you go.
−
if you like.
  
   
 
= Installation Steps =
  
= Installation Steps =
Line 28: Line 30:
 
scenarios. Be sure that you understand the deployment scenario(s) you have
  
scenarios. Be sure that you understand the deployment scenario(s) you have
 
chosen.
  
chosen.
  +
  +
== Consider A Few Notable Prerequisites ==
  +
Most of the Prerequisites for the upcoming steps are fairly straightforward.
  +
However, a few of them might be worth a pause. Here are some prerequisites to be
  +
particularly aware of:
  +
  +
# LRM requires that the [[The Build Server]] use Linux.
  +
#* If you're not planning on using LRM, but there's some chance that you'll change your mind, it's still probably wise to use Linux for the build server. Otherwise you'd need to reinstall all of the build server components on a Linux machine later (what a pain).
  +
  +
# The following deployment scenarios require a version control system.
  +
#* [[Globalyzer Lite for Continuous Globalization]]
  +
#* [[Globalyzer CLI for Continuous Globalization]]
  +
#* [[Globalyzer API for Continuous Globalization]]
  +
#* [[Globalyzer and Check in Verification]]
  +
#* [[LRM for Continuous Globalization]]
  +
#* [[Continuous Globalization]]
  +
  +
Previous clients have used Git, Subversion, Team Foundation Server and even
  +
FTP. If you wish to use a different version control system, check with Lingoport
  +
first to insure compatibility.
  +
  +
If you're only looking to set up a sandbox style environment to evaluate
  +
components of the Lingoport Suite, then a version control system is not strictly
  +
necessary. However, the installation process becomes more complicated without
  +
one. If you choose to avoid a using a version control system, please check in
  +
with Lingoport to avoid getting stuck later.
  +
<!-- TODO maybe add a page and link for [[SVN] -->
  +
<!-- TODO instructions for installation without VCS -->
   
   
Line 166: Line 196:
 
The following are necessary for
  
The following are necessary for
 
* The OS for the build server must be '''Linux''', preferably [http://www.ubuntu.com/ Ubuntu].
  
* The OS for the build server must be '''Linux''', preferably [http://www.ubuntu.com/ Ubuntu].
−
** If you are 100% sure you will not be using LRM, this is not required. However, if there's a chance you might want to use it later, it's probably best to stick with Linux. Otherwise you might later have to migrate the entire build server setup from Windows to Linux (what a pain).
 +
** If you are 100% sure you will not be using LRM, this is not required. However, if there's a chance you might want to use it later, it's probably best to stick with Linux. Otherwise you might have to migrate the entire build server setup from Windows to Linux later (what a pain).
 
* [http://www.oracle.com/technetwork/java/javase/downloads/index.html '''Java 7 ''JDK'' ''' or greater]. The JDK is required by Globalyzer.
  
* [http://www.oracle.com/technetwork/java/javase/downloads/index.html '''Java 7 ''JDK'' ''' or greater]. The JDK is required by Globalyzer.
−
* A Version Control System Client (we've supported Git, SVN, TFS and FTP).
 +
* A Version Control System Client
  +
** Previous clients have used [[Git]], Subversion, Team Foundation Server and even FTP.
  +
** If you wish to use a different version control system, check with us first. It should still probably work, but will need to be integrated with Jenkins.
 
** TODO add link to [[Git]] (from [[Installation and Configuration]])
  
** TODO add link to [[Git]] (from [[Installation and Configuration]])
 
** TODO maybe add a page and link for [[SVN]
  
** TODO maybe add a page and link for [[SVN]

Revision as of 22:54, 16 October 2015


Read Me First

The following are instructions for installing the Globalyzer Suite.

Depending on what deployment scenarios you choose, you may not need to perform all of the following steps. If a step is not listed as relevant to your deployment scenario, you may skip over it. However, unless otherwise noted, the instructions are meant to be followed in sequential order. If you skip ahead of a relevant step, then things will break! For the same reason, it would be wise to troubleshoot any issues that you encounter in a section before moving on to the next.

You'll want to take a moment to read over the table of contents summary for the Installation Steps (see above) before proceeding.

You may otherwise read the instructions as you go.

Installation Steps

Read over the Lingoport Suite Systems Guide

If you haven't already, see the Lingoport Suite Systems Guide. Do not proceed until you feel that you understand it.


Decide On A Deployment Scenario

If you haven't already, see the Deployment Scenario document. Do not proceed until you have decided on one or more deployment scenarios. Be sure that you understand the deployment scenario(s) you have chosen.

Consider A Few Notable Prerequisites

Most of the Prerequisites for the upcoming steps are fairly straightforward. However, a few of them might be worth a pause. Here are some prerequisites to be particularly aware of:

  1. LRM requires that the The Build Server use Linux.
    • If you're not planning on using LRM, but there's some chance that you'll change your mind, it's still probably wise to use Linux for the build server. Otherwise you'd need to reinstall all of the build server components on a Linux machine later (what a pain).
  1. The following deployment scenarios require a version control system.

Previous clients have used Git, Subversion, Team Foundation Server and even FTP. If you wish to use a different version control system, check with Lingoport first to insure compatibility.

If you're only looking to set up a sandbox style environment to evaluate components of the Lingoport Suite, then a version control system is not strictly necessary. However, the installation process becomes more complicated without one. If you choose to avoid a using a version control system, please check in with Lingoport to avoid getting stuck later.


Install the Globalyzer Server (optional)

Deployment Scenarios

This is an optional step. You company may have elected to use Lingoport's Globalyzer Server at www.globalyzer.com.

If you are performing this step, you should receive detailed instructions along with your Globalyzer Server installation files. Pay special attention to Globalyzer_Server_Setup&Admin_<version>.doc.


TODO: They need a license, username, and account!

TODO: Add a verification step after each installation step.

Install the Globalyzer Client/Workbench on the i18n Specialists' Machines

This section may be completed at any time after the Globalyzer Server has been setup and verified. We recommend doing it now. That way the i18n specialists at your company may begin work on crafting rule sets while you perform the rest of the installation.

If you don't do it now, don't worry. There will be a reminder to come back here at the end of this document.

Deployment Scenarios

This is directly necessary for the Globalyzer Workbench for i18n Specialists deployment scenario. The other scenarios that use Globalyzer also require this by proxy, since they will require you to craft rule sets:

Prerequisites

  • Java 7 JDK or greater. A JDK is required (do not use a JRE).
  • MySQL 5.1 or greater (optional).
    • The Globalyzer Client can use either MySQL or HSQLDB. If you choose MySQL, you will need MySQL 5.1 or greater. If you choose HSQLDB, you do not need to install anything.

Installation

Log in to the Globalyzer Server (either www.globalyzer.com or your own internal server) and click the Client download link at the bottom of the page. Read and follow the instructions. You may install with any configuration - with or without the optional packages.

Post Installation

Now may be a good time to have i18n specialists begin crafting rule sets. That way they can work in parallel while you complete the rest of the installation.

Install Globalyzer Lite on the Developer Machines

This step may be performed at any time during or after the rest of the installation.

If you don't do it now, don't worry. There will be a reminder to come back here at the end of this document.

Deployment Scenarios

Prerequisites

Installation

Unzip the globalyzer-lite-#.#.#.zip file at a location of your choosing. (# = version number).

From the globalyzer-lite-#.#.# directory, run either:

  • install-lite.sh (Linux)
  • install-lite.bat (Windows).

TODO: Mention README on unzip TODO: add a verification step TODO: add a what to do after step (reference docs on globalyer.com)

Setup the Build Server

Deployment Scenarios

It may also be necessary for the following:

Although custom modifications will be needed based on your currently setup code gate(s) / build systems. these modifications can vary significantly, and are beyond the scope of this document.

Base Prerequisites for the Build Server

There are several options here. Before proceeding, install the following prerequisites. They are necessary regardless of which option you pick.

The following are necessary for

  • The OS for the build server must be Linux, preferably Ubuntu.
    • If you are 100% sure you will not be using LRM, this is not required. However, if there's a chance you might want to use it later, it's probably best to stick with Linux. Otherwise you might have to migrate the entire build server setup from Windows to Linux later (what a pain).
  • Java 7 JDK or greater. The JDK is required by Globalyzer.
  • A Version Control System Client
    • Previous clients have used Git, Subversion, Team Foundation Server and even FTP.
    • If you wish to use a different version control system, check with us first. It should still probably work, but will need to be integrated with Jenkins.
    • TODO add link to Git (from Installation and Configuration)
    • TODO maybe add a page and link for [[SVN]
  • Jenkins 1.620 or greater.
    • Jenkins, a continuous integration tool, is required. Jenkins enables nightly scanning and scheduled Dashboard updates. Additionally, Jenkins scripts, added as part of the LRM configuration, enable round-trip automation for managing resource files.


Install a Continuous Globalization Setup on the Build Server

Deployment Scenarios

Choose one of the three following installations:

  1. #Option 1: Globalyzer Lite
  2. #Option 2: Globalyzer CLI
  3. #Option 3: Custom Globalyzer API Setup


Option 1: Globalyzer Lite

For the Globalyzer Lite for Continuous Globalization scenario.

Prerequisites

See #Base Prerequisites for the Build Server

Installation

Acquire a copy of the globalyzer-lite-#.#.#.zip file (# = version numbers). Unzip the zip file at a location where jenkins has full permissions to access

  • If it exists, /home/jenkins/ is good.
  • Alternatively, create a 'lingoport' directory under /var/lib/jenkins/ and unzip there.

Unzipping will create a globalyzer-lite-#.#.# directory. Cd to the globalyzer-lite-#.#.# directory, then run 'install-lite.sh'.

Verify that the jenkins user has full permissions globalyzer-lite-#.#.# directory and its contents before continuing.

Option 2: Globalyzer CLI

For the Globalyzer CLI for Continuous Globalization scenario.

Prerequisites

Note: This step is only necessary if you did not already install the Globalyzer Client in a location where the 'jenkins' user has full permissions to it.

Log in to the Globalyzer Server and click on the Client download link at the bottom of the (post login) page. If you have not configured your own Globalyzer Server, use www.globalyzer.com.

Follow the instructions on the page reached from the client download link. Note that if you have a copy of the Globalyzer Client installer in your downloads folder, you may use it again. Take special care to:

  • Install the Globalyzer Client in a location where the 'jenkins' user will have full permissions.
    • You may wish to install the client as the 'jenkins' user.
  • Install all optional packages (Globalyzer CLI, Globalyzer Ant Tasks). They will be installed by default.

Now is a good time to double check that the 'jenkins' user has full permissions to the client install directory.

Option 3: Custom Globalyzer API Setup

Prerequisites

See #Base Prerequisites for the Build Server

Installation

For the Globalyzer API for Continuous Globalization scenario.

This option offers a lot of power, and may take on a variety of forms.

may be set up at your own discretion. You will quite possibly (but not necessary) want to set up MySQL 5.1 (or greater) for use with the Globalyzer API.

TODO: Go to [| www.globalyzer.com ] and read up on the API


Install the Lingoport Resource Manager Server on the Build Server

Deployment Scenarios

Prerequisites

All #Base Prerequisites for the Build Server

  • The OS for the build server must be Linux, preferably Ubuntu.

Pre-Installation

You will probably want to be familiar with the pages under About LRM before continuing. It's good to know what you are dealing with.

Installation

The LRM Installation is a complicated process. Follow the instructions under LRM Installation and Configuration.


Setup the Dashboard Server System

Deployment Scenarios

It is also recommended for:


Prerequisites

Installation

See the Dashboard Installation page for the full instructions.


Finishing Up

If you installed either LRM or the dashboard, but did not get through all of their configuration steps, now is the time to go back and complete these steps.

If you plan to use the Globalyzer Workbench and/or Globalyzer Lite, but skipped their installation steps, then now is the time to go back and do them. See:

Retrieved from "http://wiki.lingoport.com/index.php?title=Lingoport_Suite_Installation_Instructions&oldid=87582"