Toolpack installer B

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "'''<big>Applies to version(s) v2.4 to v2.8</big>''' {{DISPLAYTITLE:Installing Toolpack}} == Get installation package == *You need to obtain the new version of the Toolpack s...")
 
(Toolpack installation options)
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
'''<big>Applies to version(s) v2.4 to v2.8</big>'''
+
'''<big>Applies to version(s) v2.8 to v2.9</big>'''
 
{{DISPLAYTITLE:Installing Toolpack}}
 
{{DISPLAYTITLE:Installing Toolpack}}
  
Line 6: Line 6:
 
*You need to obtain the new version of the Toolpack software from the designated location. Please contact the [mailto:support@telcobridges.com TelcoBridges support team] to know which version to use. The package name starts with TBToolPack.
 
*You need to obtain the new version of the Toolpack software from the designated location. Please contact the [mailto:support@telcobridges.com TelcoBridges support team] to know which version to use. The package name starts with TBToolPack.
 
*Upload this package to the server running Toolpack with scp or a SFTP tool like [http://filezilla-project.org/ FileZilla]
 
*Upload this package to the server running Toolpack with scp or a SFTP tool like [http://filezilla-project.org/ FileZilla]
 +
 +
=== Usage examples ===
 +
Start the installer with no arguments will start the "Text-mode" installation.
 +
 +
  # ./TBToolPack-2.9.26-Linux-centos7-x86_64-Install
  
 
== Toolpack installation options ==
 
== Toolpack installation options ==
 +
Those options will be prompt by the installer.
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
Line 13: Line 19:
 
!! width="275" style="background:LightBlue"  | Description
 
!! width="275" style="background:LightBlue"  | Description
 
|-
 
|-
| dbhost || Toolpack database hostname
+
| Primary Database IP (dbhost) || Toolpack database hostname or IP
 
|-
 
|-
| dbpass || Toolpack database password
+
| Primary Database Password (dbpass)|| Toolpack database password
 
|-
 
|-
| dbuser || Toolpack database user
+
| Primary Database Username (dbuser)|| Toolpack database user
 
|-
 
|-
| dbdriver || Toolpack database ODBC driver
+
| OdbcDriver (dbdriver) || Toolpack database ODBC driver (MySQL by default)
 
|-
 
|-
| [[System_Id|systemid]] || Toolpack System Id (previously know as [[Gateway_Port|tbxgwport]])
+
| System Id ([[System_Id|systemid]]) || Toolpack System Id (previously know as [[Gateway_Port|tbxgwport]])
 
|-
 
|-
| primip || IP address of primary ethernet interface of the localhost. Also known as [[Gateway_Address|tbxgwaddr0]]
+
| Primary Local IP (primip) || This is the local host IP address of the Primary ethernet interface by which communication with the TMedia takes place. If the field is left blank, IP address gets auto-detected. Also known as [[Gateway_Address|tbxgwaddr0]]
 
|-
 
|-
| redip || IP address of the redundant ethernet interface of the localhost. Also known as [[Gateway_Address|tbxgwaddr1]]
+
| Redundant local IP (redid) || This is the local host IP address, of the Redundant ethernet interface, by which communication with the TMedia takes place when Primary interface is down. This Field can be left blank on a non-redundant network system. Also known as [[Gateway_Address|tbxgwaddr1]]
 
|}
 
|}
 
 
=== Usage examples ===
 
TMP6400 usage example installing release 2-4-24 on a CentOS 5 64 bits host:
 
 
  TBToolPack-2.4.24-Linux-centos5-x86_64-Install
 
  
 
==== TMG3200/TMG800 ====
 
==== TMG3200/TMG800 ====
  
For the TMG3200/TMG800 you need to use the right installer.
+
The --[[Gateway_Address|primip]] and --[[Gateway_Address|redip]] are mandatory and needs to be set to 172.31.1.2 for both "primip" and "redip".
  
<span style="color:#DC143C; background:#F0E68C">
+
Usage example, installing release 2.9.26:
WARNING: Failure to use the correct installer for the TMG3200/TMG800 will damage your system.
+
</span>
+
  
Follow this link for the [[TBLinux:How_to_select_the_proper_installer|How to select the proper TBLinux installer]]
+
  # ./TBToolPack-2.9.26-Linux-centos7-x86_64-Install --[[Gateway_Address|primip]] 172.31.1.2 --[[Gateway_Address|redip]] 172.31.1.2
  
TMG3200/TMG800 usage example, installing release 2-4-24:
 
 
'''Warning''': For TMG3200/TMG800 setting --[[Gateway_Address|primip]] and --[[Gateway_Address|redip]] is mandatory and needs to be set to --[[Gateway_Address|primip]] 172.31.1.2 --[[Gateway_Address|redip]] 172.31.1.2.
 
 
  TBToolPack-2.4.24-Linux-tbrel-1-28-ppc-Install --[[Gateway_Address|primip]] 172.31.1.2 --[[Gateway_Address|redip]] 172.31.1.2
 
  
 
=== Toolpack Multi system support ===
 
=== Toolpack Multi system support ===
Line 70: Line 63:
  
 
'''Note:''' If no [[System_Id|SystemId]] is given, the tbtoolpack will prompt the user to select one among the installed one.
 
'''Note:''' If no [[System_Id|SystemId]] is given, the tbtoolpack will prompt the user to select one among the installed one.
 
== Toolpack Graphical Installation ==
 
 
 
===== Welcome screen Pane =====
 
 
[[Image:Toolpack_welcome_screen_2-4.jpg|||Toolpack Welcome Screen Release 2-4]]
 
 
===== Installation Type Pane =====
 
 
[[Image:Toolpack_typical_screen_2-3.jpg|||Toolpack Typical Pane Screen Release 2-4]]
 
[[Image:Toolpack_custom_screen_2-3.jpg|||Toolpack Custom Pane Screen Release 2-4]]
 
 
 
===== Basic parameters Pane =====
 
 
Fields with <span style="color:Red">*</span> are advanced parameters not show in typical setup.
 
 
[[Image:Toolpack_basic_param_screen_2-3.jpg|||Toolpack Basic Parameter Pane Screen Release 2-4]]
 
 
* [[System_Id|'''System Id''']]: This is the unique id of the system and will install '''tbtoolpack_${SystemId}''' OS service.
 
* '''Multi-Host System''': Tells if the system wil be composed of more than one host.  (Must be true for DBHA)
 
* '''Service Start Type''': "Auto Start" is use to start the Toolpack service at host boot up, "Demand Start" requires manual start.
 
* [[Gateway_Address|'''Primary local IP''']]: For TMG3200, it must always be set to 172.31.1.2. For TMP6400, this value should be set if the host has multiple network interfaces.
 
* [[Gateway_Address|'''Redundant local IP''']]: For TMG3200, it must always be set to 172.31.1.2. For TMP6400, this value should be set if the host has multiple network interfaces.
 
 
===== Multi-Host parameters Pane =====
 
 
[[Image:Toolpack_multi_host_screen_2-3.jpg|||Toolpack Multi-Host Pane Screen Release 2-4]]
 
 
* '''HostRole''': Set to '''Primary''' on host responsible for '''File replication''' and/or the '''HA database''' configuration.
 
* '''Database HA''': Yes to use two databases in HA mode.
 
 
 
===== Primary Database Connection Pane =====
 
 
Toolpack requires access to a MySQL database through ODBC. Provide required connection parameters.
 
 
Fields with <span style="color:Red">*</span> are advanced parameters not show in typical setup.
 
 
[[Image:Toolpack_prim_db_screen_2-4.jpg|||Toolpack Primary Database Pane Screen Release 2-4]]
 
 
* '''HostName''': localhost and 127.0.0.1 are not allowed.
 
* '''OdbcDriver''': Name of the ODBC driver to use.
 
 
'''Note''': MySQL® Connector/ODBC (aka MyODBC) version 3.51 needs to be installed on all platforms prior to toolpack installation.  On Unix machines, unixODBC must also be installed and properly configured (ie: must have an entry [MySql] in /etc/odbcinst.ini).  See [[Toolpack_installation_2-3|Toolpack prerequisite]] for details.
 
 
===== Secondary Database Connection Pane =====
 
Toolpack requires access to a MySQL database through ODBC. Provide required connection parameters.
 
Fields with <span style="color:Red">*</span> are advanced parameters not show in typical setup.
 
 
[[Image:Toolpack_sec_db_screen_2-4.jpg|||Toolpack Secondary Database Pane Screen Release 2-4]]
 
 
* '''HostName''': localhost and 127.0.0.1 are not allowed.
 
 
'''Note''':  Hostname for the Secondary database must differ from the Primary database hostname.
 
 
===== ''Optional'' License Installation Pane =====
 
Installer can optionally install license(s) for the Tmedia products.
 
License file can be either a single license (*.dat), or a group of licenses (*.zip).
 
To skip license installation , press '''Next''' button.
 
 
[[Image:Toolpack_license_screen_2-3.jpg|||Toolpack License Pane Screen Release 2-4]]
 
 
'''Note''': If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation.
 
 
===== Installation Review Pane =====
 
 
[[Image:Toolpack_review_screen_2-3.jpg|||Toolpack Review Screen Release 2-4]]
 
 
 
=====Installation Progress Pane =====
 
 
[[Image:Toolpack_progress_screen_2-3.jpg|||Toolpack Progress Screen Release 2-4]]
 
 
 
===== Installation Complete Pane =====
 
 
After having clicked '''Finish'''. Type <span style="color:Blue">tbtoolpack start</span> at a shell prompt to start the service, or simply launch the service
 
 
For 2.2.X Release: <span style="color:Blue">${INSTALLDIR}/toolpack/service/tbtoolpack_service</span>
 
with <span style="color:Green">administrator</span> rights.
 
 
For 2.3.X Release and up:<span style="color:Blue">${INSTALLDIR}/toolpack/setup/{[[System_Id|SystemId]]}/service/tbtoolpack_service</span>
 
with <span style="color:Green">administrator</span> rights.
 
 
For 2.4.X Release and up:<span style="color:Blue">${INSTALLDIR}/toolpack/setup/{[[System_Id|SystemId]]}/service/tbtoolpack_service</span>
 
with <span style="color:Green">administrator</span> rights.
 
 
 
[[Image:Toolpack_complete_screen_2-3.jpg|||Toolpack complete Screen Release 2-4]]
 
  
 
== Toolpack Text-mode Installation ==
 
== Toolpack Text-mode Installation ==
  
If your host has more than one network interface. It is recommended to set --[[Gateway_Address|primip]] and --[[Gateway_Address|redip]] parameters.
+
   # ./TBToolPack-2.9.26-Linux-centos7-x86_64-Install --nodeps
 
+
==== TMG3200/TMG800  ====
+
 
+
TMG3200/TMG800 usage example, installing release 2-4-44:
+
 
+
'''Warning''': For TMG3200 setting --[[Gateway Address|primip]] and --[[Gateway Address|redip]] is mandatory and needs to be set to --[[Gateway Address|primip]] 172.31.1.2 --[[Gateway Address|redip]] 172.31.1.2.
+
 
+
  TBToolPack-2.4.44-Linux-tbrel-1-28-ppc-Install --primip 172.31.1.2 --redip 172.31.1.2
+
 
+
<br> The next example shows the installation of Toolpack on the TB Linux
+
 
+
   # ./TBToolPack-2.4.44-Linux-tbrel-1-28-ppc-Install --primip 172.31.1.2 --redip 172.31.1.2
+
 
    
 
    
  1.8.6 &gt;= 1.8.5
+
This will install TBToolpack version 2.9.26 on your computer. Continue? [n/Y]
  0.9.4 &gt;= 0.9.0
+
  
This will configure TBToolPack version 2.4.44 on your computer. Continue? [n/Y]Y
+
===== Basic parameters  =====
 +
Where do you want to install TBToolpack? [/lib/tb]  
 +
*'''/lib/tb''' is the default directory where all TelcoBridges packages is installed.
  
<br> <br>
+
[[System Id|System Id]] [12358]
 +
*This is the tbx gateway port and will install '''tbtoolpack_${[[System Id|SystemId]]}''' OS service.
  
===== Basic parameters =====
+
  Service Start Type ("Auto Start" "Demand Start") [Auto Start]
 
+
*"Auto Start" is use to start the Toolpack service at host boot up, "Demand Start" requires manual start.
  [[System Id|System Id]] [12358]
+
 
+
 
+
  Service Start Type ("Auto Start" "Demand Start") [Auto Start]
+
  
*[[System Id|'''System Id''']]: This is the tbx gateway port and will install '''tbtoolpack_${[[System Id|SystemId]]}''' OS service.  
+
Primary local IP []
*'''Service Start Type''': "Auto Start" is use to start the Toolpack service at host boot up, "Demand Start" requires manual start.
+
 +
Redundant local IP []
 +
*Local host IP address of the Primary and Secondary ethernet interface by which communication with the TMedia takes place. If the field is left blank, IP address gets auto-detected.
  
 
===== Multi-Host parameters  =====
 
===== Multi-Host parameters  =====
Line 199: Line 89:
 
   Multi-Host System [y/N] N
 
   Multi-Host System [y/N] N
  
*'''Multi-Host System''': Tells if the system wil be composed of more than one host. For TMG users, only choose "N".
+
*Tells if the system wil be composed of more than one host. For TMG, only choose "N" (unless installing for 1+1 system)
  
 
===== Primary Database Connection  =====
 
===== Primary Database Connection  =====
Line 206: Line 96:
 
    
 
    
 
    
 
    
   Primary Database Hostname [TB005996] 172.31.1.2
+
   Primary Database Hostname [centos-tb]
 
+
* localhost and 127.0.0.1 are not allowed. Put the hostname or the IP of the primary control interface. 
 
+
 
 
   Primary Database Redundant IP []
 
   Primary Database Redundant IP []
 
+
* localhost and 127.0.0.1 are not allowed. Can be left blank on a non Multi-Host System.
 
    
 
    
 
   Primary Database Username [tbdb]
 
   Primary Database Username [tbdb]
 
 
 
    
 
    
 
   Primary Database Password [tbdbpw]
 
   Primary Database Password [tbdbpw]
 
 
 
    
 
    
 
   Primary Database Port [3306]
 
   Primary Database Port [3306]
 
+
* press "Enter" to use the default values.
* '''HostName''': localhost and 127.0.0.1 are not allowed.
+
  
 
===== ''Optional'' License Installation  =====
 
===== ''Optional'' License Installation  =====
  
Note: If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation.  
+
License Location (*.zip/*.dat)
 
+
*If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation.  
  License Location (*.zip/*.dat)
+
  
 
===== Installation Progress  =====
 
===== Installation Progress  =====
Line 232: Line 118:
 
   Installing TBToolPack...
 
   Installing TBToolPack...
 
   Copying
 
   Copying
   Copying /lib/tb/toolpack/setup/12358/2.4/apps/toolpack_sys_manager/toolpack_sys_manager
+
   Copying /lib/tb/toolpack/setup/12358/2.9/apps/toolpack_sys_manager/toolpack_sys_manager
 
   Copying /lib/tb/toolpack/tbtoolpack
 
   Copying /lib/tb/toolpack/tbtoolpack
 +
  ...
  
 
===== Installation Complete  =====
 
===== Installation Complete  =====

Latest revision as of 14:57, 13 May 2016

Applies to version(s) v2.8 to v2.9


Contents

Get installation package

  • You need to obtain the new version of the Toolpack software from the designated location. Please contact the TelcoBridges support team to know which version to use. The package name starts with TBToolPack.
  • Upload this package to the server running Toolpack with scp or a SFTP tool like FileZilla

Usage examples

Start the installer with no arguments will start the "Text-mode" installation.

 # ./TBToolPack-2.9.26-Linux-centos7-x86_64-Install

Toolpack installation options

Those options will be prompt by the installer.

Option Description
Primary Database IP (dbhost) Toolpack database hostname or IP
Primary Database Password (dbpass) Toolpack database password
Primary Database Username (dbuser) Toolpack database user
OdbcDriver (dbdriver) Toolpack database ODBC driver (MySQL by default)
System Id (systemid) Toolpack System Id (previously know as tbxgwport)
Primary Local IP (primip) This is the local host IP address of the Primary ethernet interface by which communication with the TMedia takes place. If the field is left blank, IP address gets auto-detected. Also known as tbxgwaddr0
Redundant local IP (redid) This is the local host IP address, of the Redundant ethernet interface, by which communication with the TMedia takes place when Primary interface is down. This Field can be left blank on a non-redundant network system. Also known as tbxgwaddr1

TMG3200/TMG800

The --primip and --redip are mandatory and needs to be set to 172.31.1.2 for both "primip" and "redip".

Usage example, installing release 2.9.26:

 # ./TBToolPack-2.9.26-Linux-centos7-x86_64-Install --primip 172.31.1.2 --redip 172.31.1.2


Toolpack Multi system support

Toolpack installer now allows to have more than one setup being configured on the same host.

To enable this feature, the directory tree changed a little, here's what it looks like now:

 /lib/tb/toolpack/setup/12358/service
 /lib/tb/toolpack/setup/12358/2.4/apps
 /lib/tb/toolpack/setup/12358/2.4/licenses
 /lib/tb/toolpack/setup/12358/2.4

Note: 12358 was added in the setup path.

Each setup is installed as a service of the Operating System, under the following name:

 tbtoolpack_${SystemId}  -> ie: tbtoolpack_12358

Each service instance can be managed individually using "tbtoolpack" command.

 tbtoolpack start 12358
 tbtoolpack stop 12390

Note: If no SystemId is given, the tbtoolpack will prompt the user to select one among the installed one.

Toolpack Text-mode Installation

 # ./TBToolPack-2.9.26-Linux-centos7-x86_64-Install --nodeps
 
This will install TBToolpack version 2.9.26 on your computer.  Continue? [n/Y] 
Basic parameters
Where do you want to install TBToolpack? [/lib/tb] 
  • /lib/tb is the default directory where all TelcoBridges packages is installed.
System Id [12358]
  • This is the tbx gateway port and will install tbtoolpack_${SystemId} OS service.
Service Start Type ("Auto Start" "Demand Start") [Auto Start]
  • "Auto Start" is use to start the Toolpack service at host boot up, "Demand Start" requires manual start.
Primary local IP [] 

Redundant local IP []
  • Local host IP address of the Primary and Secondary ethernet interface by which communication with the TMedia takes place. If the field is left blank, IP address gets auto-detected.
Multi-Host parameters
 Multi-Host System [y/N] N
  • Tells if the system wil be composed of more than one host. For TMG, only choose "N" (unless installing for 1+1 system)
Primary Database Connection
 OdbcDriver (MySQL) [MySQL]
 
 
 Primary Database Hostname [centos-tb]
* localhost and 127.0.0.1 are not allowed. Put the hostname or the IP of the primary control interface.  
 Primary Database Redundant IP []
* localhost and 127.0.0.1 are not allowed. Can be left blank on a non Multi-Host System.
 
 Primary Database Username [tbdb]
 
 Primary Database Password [tbdbpw]
 
 Primary Database Port [3306]
  • press "Enter" to use the default values.
Optional License Installation
License Location (*.zip/*.dat)
  • If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation.
Installation Progress
 Installing TBToolPack...
 Copying
 Copying /lib/tb/toolpack/setup/12358/2.9/apps/toolpack_sys_manager/toolpack_sys_manager
 Copying /lib/tb/toolpack/tbtoolpack
 ...
Installation Complete
 Installation of TBToolPack complete.
 
 To start tbtoolpack service, type the following command at a shell prompt:
 tbtoolpack start
 
 For more options:
 tbtoolpack help
 #

Note: It is not necessary for you to start tbtoolpack again if you didn't stop it before. If you are not sure, always start tbtoolpack at this point.

Personal tools