TIBCO OpenSpirit Silent Installation

TIBCO OpenSpirit Silent Installation

book

Article ID: KB0081408

calendar_today

Updated On:

Products Versions
TIBCO OpenSpirit Runtime v4.3, v4.2, v4.1

Description

The TIBCO OpenSpirit Runtime Installation can be performed without the need for a graphical display or user interaction. 
 

This is done by providing the installation settings in a text file and supplying a command line option to the installer to instruct it to run in silent mode. The installation settings must be placed in a file named installer.properties which must be located in the same directory as the install kit. Add -i silent as command line options when running the installer to perform a silent install. The installer.properties file can include options to pass to the Install Config Manager to configure a master or a satellite at the end of the install without the need to run the Install Config Manager interactively.

Templates for an installer.properties file for creating a master and for creating a satellite are provided in the TIBCO software download page for the TIBCO OpenSpirit Runtime product. The properties is slightly different for each version of OpenSpirit; for your convenience, the installer.properties files for OpenSpirit v4.3.0 have been added to this document.

Issue/Introduction

The TIBCO OpenSpirit Runtime installation can be performed without the need for a graphical display or user interaction.

Environment

Windows & Linux

Resolution

OpenSpirit v4.3.0 installer.properties for a master installation:

==
# This is an example 'installer.properties' file for a silent *master* installation.

# IMPORTANT NOTE: This file needs to be located adjacent to the OpenSpirit installer
#                 executable and be named 'installer.properties'
#   Usage: <OSP_installer> -i silent
#
# If you already have a binary installation and just want to configure a new master from it, you
# can run the InstallConfig tool in silent mode on this file also:
#   Usage: InstallConfig -nosplash -silent installer.properties

# This is for a master installation.
CHOSEN_INSTALL_SET=master

# The location of your runtime OpenSpirit installation directory.
# NOTE: InstallConfig will append "/v4.3" to USER_INSTALL_DIR to make the the OSP_HOME directory value.
### USER_INSTALL_DIR=C:\\Program Files (x86)\\OpenSpirit\\
USER_INSTALL_DIR=/apps/OpenSpirit

# For UNIX only. The location of the config directory, typically 'OSP_HOME/config'
# For the default config directory location, leave this value blank.
# On Windows this value is not used, the location is fixed to be under the CSIDL_COMMON_APPDATA folder.
#OSP_CONFIG_FILE_DIR=/apps/OpenSpirit/v4.3/config

# The location of the embedded OpenSpirit database, typically 'OSP_CONFIG_FILE_DIR/data'
# If not supplied the default value is 'OSP_CONFIG_FILE_DIR/data'.
# For Windows, the default is under the CSIDL_COMMON_APPDATA folder, e.g. 'C:\ProgramData\OpenSpirit\v4.3\config\data' for Windows7
###OSP_DATA_FILE_DIR=C:\\ProgramData\\OpenSpirit\\v4.3\\config\\data
#OSP_DATA_FILE_DIR=/apps/OpenSpirit/v4.3/config/data

# The location of the log files, typically 'OSP_CONFIG_FILE_DIR/logs'
# If not supplied, the default value is 'OSP_CONFIG_FILE_DIR/logs'.
# For Windows, it is fixed under the CSIDL_COMMON_APPDATA folder, e.g. 'C:\ProgramData\OpenSpirit\v4.3\config\logs' for Windows7
###OSP_LOGS_FILE_DIR=C:\\ProgramData\\OpenSpirit\\v4.3\\config\\logs
#OSP_LOGS_FILE_DIR=/apps/OpenSpirit/v4.3/config/logs

# The port number to use for the master installation. The master host will be set to the current host.
OSP_PORT=15430

# The OpenSpirit Admin password
OSP_ADMIN_ACCOUNT_PASSWORD=spirit

# What method of remotely starting servers you are choosing, the options are:
#   - "SSH with Password Authentication"
#   - "REXEC"
#   - "SSH with Password Authentication (Interactive)"
#   - "REXEC (Interactive)"
#   - "External Executable"
# For the last three options above, you need to read the documentation for proper usage. The "External Executable"
# option will require that you set the MASTER_REMOTING_EXECUTABLE_* variables below properly.
OSP_RemoteStartMethod=SSH with Password Authentication

# The OSP license path (port@host format)
OSP_LICENSE_PATH=27001@flexhost.domain.com

# Optional description of this installation
DESCRIPTION=Master OpenSpirit installation on myHost

# ----------- Optional advanced settings -----------
# If values are not supplied, default values will be used.
MASTER_SERVICE_TIMEOUT=3600
MASTER_LOCATOR_TIMEOUT=3600
MASTER_ERROR_EXPIRY_TIME=86400
MASTER_LOGRETENTION_DAYS=7
MASTER_LOGRETENTION_COUNT=3
MASTER_REMOTE_ACTIVATION=true
MASTER_HOST_DISCOVERY=true
# These next three REMOTING values are only used if the OSP_RemoteStartMethod was set to "External Executable"
MASTER_REMOTING_EXECUTABLE_WINDOWS="C:\\Program Files (x86)\\PuTTY\\plink.exe" -batch $host $command
MASTER_REMOTING_EXECUTABLE_LINUX=/usr/bin/ssh -o BatchMode=yes -o StrictHostKeyChecking=no -o GSSAPIAuthentication=yes -o PasswordAuthentication=no -o PubkeyAuthentication=no $host $command
# optionally set a SMTP host
# MASTER_SMTP_HOST=smtp.bigoil.com
# optionally set SMTP password required
# MASTER_SMTP_PASSWORD_REQUIRED=false

# ----------- Configuration import values -----------
# For Windows only:
# We only support importing from a manually created v4.0+ metadataExport directory for Windows (see Support for details)
### #IMPORT_FROM_METADATA_DIR=C:\\metadataExport

# For UNIX only:
# If you are importing configuration data from another OpenSpirit installation, you need to set only *ONE* of these:
#
# Set this one if you are importing from a previously exported v4.x OpenSpirit installation:
IMPORT_FROM_METADATA_DIR=/apps/OpenSpirit/exported_config/v4x_ExportedMetadata

# Set this one if you are importing from an existing (same architecture) v4.x OpenSpirit installation:
###IMPORT_FROM_v4x_OLD_CONFIG_DIR=/apps/OpenSpirit/v4.x/master/config
# ---------------------------------------------------

# This flag is used only if importing from v4x. Enter YES or NO. This prevents importing the copy and scan
# job histories, which can be a quite large amount of data, possibly taking a very long time to import.
# A default value of 'YES' will be used if this value doesn't exist or has no value.
SKIP_COPY_SCAN_JOB_RUN_HISTORIES=YES

# ----------- Backup configuration values -----------
# Enables or disables backups in the master installation. 
# Backups are enabled by default.
# BACKUP_ENABLED=true

# Backup path. Specify a folder that is writable to the OSP administrator user.
# If the folder does not exists it will be created.
# The default path is OSP_HOME/config/backup
# BACKUP_PATH=

# Backup interval in hours. The default is 24 hours.
# BACKUP_INTERVAL=24

# Use the backup time property to run backups at a specific hour of the day.
# By default the backup runs around 2:00 AM.
# BACKUP_TIME=2

# Backup retention will control how many backups will be kept.
# The default value is 3 backups to be kept.
# BACKUP_RETENTION_COUNT=3
==

OpenSpirit v4.3.0 installer.properties for a satellite installation:
==
# This is an example 'installer.properties' file for a silent *satellite* installation.
#
# IMPORTANT NOTE: This file needs to be located adjacent to the OpenSpirit installer
#                 executable and be named 'installer.properties'
#   Usage: <OSP_installer> -i silent
#
# If you already have a binary installation and just want to configure a new satellite from it, you
# can run the InstallConfig tool in silent mode on this file also:
#   Usage: InstallConfig -nosplash -silent installer.properties

# This is for a satellite installation.
CHOSEN_INSTALL_SET=satellite

# The location of your runtime OpenSpirit installation directory.
# NOTE: InstallConfig will append a "v4.3" directory to make the OSP_HOME directory value.
###USER_INSTALL_DIR=C:\\Program Files\\OpenSpirit\\
USER_INSTALL_DIR=/apps/OpenSpirit-satellite

# For UNIX only. The location of the config directory, typically 'OSP_HOME/config'
# For default config location, leave this value blank.
# On Windows this value is not used, the location is fixed to be under the CSIDL_COMMON_APPDATA folder.
#OSP_CONFIG_FILE_DIR=/apps/OpenSpirit-satellite/v4.3/config

# The host/port of the master installation this satellite connects to.
OSP_HOST=myhost.domain.com
OSP_PORT=15430

# Optional flag to register a windows satellite installation for remote activation.
# Only registered satellites can start data server processes via. ssh process activation.
# Linux satellites are always registered during the installation process.
# REGISTER_SATELLITE=true

# Optional description of this installation (UNIX only, ignored for Windows)
# DESCRIPTION=satellite OSP installation on myHost
==