Creating an options file for silent or unattended installation of the Talend product suite

Overview

This article explains how to install Talend products using the silent or unattended installation method, which involves the creation of an options file.

 

The installation of Talend products is usually performed using the graphical mode installer, or on Linux, the text mode installer. There are, however, situations where an unattended or silent installation is desirable, and this document details this process.

 

See Installation modes of Talend Installer and Talend Studio Installer for more information about the different modes that the Talend installer can run in.

 

General observations

  • Just like the graphical installer, the silent installer can only be run on the target server where Talend is installed. There is no concept of a remote installation.

  • There is no option to accept or decline the license agreement—agreement can only be implicit.

  • All options in the options file are case sensitive: licensefile is not the same as licenseFile. Some options also have spaces in the name, which must be adhered to. For example, Nexus Host is the actual option, and is not the same as NexusHost, nexusHost, or nexushost, all of which will cause errors.

  • Should there be any problems in the options file, the installer will notify you on the commandline.

 

Preparation

  1. Talend recommends performing a graphical or text installation first, at least to the point where the installer reports it is ready to install Talend. This ensures that, if the installer checks the database settings and finds any problems, they can be corrected before installation.

  2. Run the installer with the --help flag to get a list of the installer options:

    • The view in Windows:

      Windows_Help.png

       

    • The view in Linux:

      Linux_Help.png

       

      You can find the full list of unattended mode installer options in the Talend Help Center. These options correspond to those that are normally supplied by the installer, and can be entered on the commandline when the installer is invoked. For a complicated installation, this can become unwieldy, which is why it is possible to supply the parameters as key/value pairs in a text file—the options file.

 

Create the options file

This section explains how to create an options file using screenshots from both a graphical and a text installation. In this example the following modules are installed:

  • TAC
  • Nexus
  • Log Server
  • JobServer

This article shows how the options file is built. The options themselves often have a set of choices and there is always a default option, which will be used if the option is not set in the options file.

 

License agreement

The first part of an installation is to accept the license agreement. As explained earlier, this is implicit in an unattended installation.

 

On the next page are the general settings:

  • Installation Directory
  • Installation Style
  • Installation Type
  • License File

 

Installation Directory

Installer_Directory.png

 

This is specified using the prefix option, as shown below:

options_directory.png

 

Installation Style

This example uses the Advanced install style due to the level of control offered.

Installer_Style.png

 

This is specified using the installStyle option, the two possibilities are [easy, advanced].

Options_Style.png

 

Installation Type

This example uses the Custom installation style due to the level of control offered.

Installer_Type.png

 

This is specified using the installType option, the three possibilities are [client, server, custom].

Options_Type.png

 

License File

Installer_License.png

 

This is specified by the licenseFile option. The file must be local to the installer.

Options_License.png

 

Select Components

The next page is where you specify the required components. For this example, choose the following:

Select_Components.png

Text mode installation component specifiers:

  • tac
  • logserv
  • iam
  • mdm
  • tds
  • cmdline
  • runtime
  • jobserver
  • tdqp
  • dataprep
  • sap_rfc
  • studio
  • esb
  • serv – specifies to install services

 

In the options file the required components are specified using the enable-components and disable-components options.

Note: For text mode installations, both options must be specified. It is not enough to use one or the other. The component specifiers must be supplied as a comma separated list.

options_components.png

 

Like the graphical installer, various components cannot be explicitly selected, for example:

  • MongoDB
  • Apache Kafka
  • Apache Zookeeper

They will be installed implicitly when needed, but the options to configure them will be required.

 

Configuring TAC

Select which Tomcat to use.

install_select_tac_tomcat.png

 

The option is tomcat and the possibilities are [install8, use]. install8 is used to install an embedded Tomcat, use will use an existing Tomcat.

option_select_tac_tomcat.png

 

TAC Security User

These options set up the initial TAC user or the SSO connection.

installer_tac_admin_user.png

 

For a text installation, the first option is: tacUserSelection, which specifies whether you want to set up an initial user, or set up an SSO connection (using Okta or SiteMinder). The choices are: [tacStdUser, tacSsoLabel]. For this example, specify tacStdUser.

option_select_user.png

 

To supply the user name and password, use the tacAdminUser and tacAdminPwd options.

options_security_user.png

 

The admin password must be supplied in clear text, so if this is seen to be a security hazard there are two options:

  • Do not supply a password in the file – the install will default the password to admin.
  • Supply an initial password and change it immediately after installation.

 

Set the log server details for TAC

installer_tac_logserver.png

 

In a text installation, whether to use a Log Server is specified with tacLogServ, which is a Boolean value and therefore can be set to 0 or 1. The default is 1, that is, to set the values and send TAC messages to the Log Server. If this is 1, the other options are: tacLogServerHost and tacLogServerPort. The default values are localhost and 5044.

 

TAC Database

Select the type of database to host the TAC Administration Database.

installer_choose_db.png

 

Specify this in a text mode installation using the tacDB option with the allowed values of [H2, MySql, Oracle, MS SQL, PostgreSQL]. For this example, use a local MySQL database.

 

TAC web application

installer_tac_setup.png

 

  • If installing an embedded Tomcat, set the port using tacPort.

  • Set the web application name using tacWebAppName (the default is org.talend.administrator)

  • Specify whether or not to install Nexus using tacInstallNexus (values are 0 or 1). The default is 1, that is, to install.

  • Specify whether or not to set up email notifications using tacSetupEmailNotification (values are false or true). The default is false.

     

    options_tac_setup.png

 

TAC database configuration

This set of options will vary according to which type of database is being used as will the default values. The options are:

  • tacDBHost
  • tacDBPort
  • tacDBName
  • tacDBUser
  • tacDBPswd

You can also specify the location of the database driver JAR file using tacDBDriver. If this is not set, you will need to upload the driver JAR file using the DBConfig page in the GUI once the TAC has started.

 

Nexus Configuration

installer_nexus_configuration.png

 

If Nexus is to be installed with a text installation, specify the configuration with the following options:

  • Nexus Host (yes, with the space) The default is 0.0.0.0.
  • nexusPort The default is 8081.

 

Log Cluster Name

Talend recommends that you always change this value, and the best way is to reflect the environment, for example, talend-dev-central. For a text installation, the option is logservClusterName.

 

Job Server Settings

installer_job_server.png

 

The associated options are:

  • jobserverCommandPort The default is 8000.
  • jobserverFilePort The default is 8001.
  • jobserverMaxCacheDuration The default is 90.
  • jobserverMonitorPort The default is 8888.
  • Process messaging port (yes with the spaces) The default is 8555.

 

Set up the services

You can specify the serv component within enable-components to set up all modules as services. It is also possible to specify individual services, should it be necessary that not all components be set up as services. The serv option must still be specified in enable-components, but there are extra options to enable the individual components to be set up as services, for example:

  • installServiceTAC
  • installServiceLogserv

 

Running the installer

Once the options file is created, run the installer with the --optionfile and --unattendedmodeui parameters explicitly set to none, and the --mode parameter explicitly set to unattended.

Version history
Revision #:
5 of 5
Last update:
‎09-29-2018 12:16 AM
Updated by:
 
Labels (3)