Installation
Installing UltraESB is simply downloading and extracting (.zip) the binary distribution, hosted at the downloads page of AdroitLogic, into your software installation directory.
Obtaining the UltraESB
Use your web browser and navigate to the UltraESB 2.x download page of AdroitLogic at;
Select the complete distribution to proceed with download. Next you will be directed to the UltraESB temporary evaluation license agreement. Please read this carefully and agree to continue.
When you scroll down, you will be shown the following form. Please enter your details and proceed.
An email will be sent with download links for the binary distribution and client key along with additional information.
| Download link to the binary distribution Download links for the binary distributions are sent ONLY via email. Hence you MUST provide a valid email address. |
Installation
On Linux based systems, use unzip command to extract the downloaded binary distribution into your software installation directory (e.g.- /opt).
$ unzip adroitlogic-ultraesb-2.6.1.zip -d /opt/
|
Note Extracting the downloaded binary distribution into your home folder is recommended if you are using it for development purposes. |
On Windows operating systems right click on the .zip file and extract archive in to "C:\Program Files\" directory.
Given that the prerequisites are met, and above steps are successful, the installation is complete.
|
Documentation Convention - ULTRA_HOME Installation archive will be extracted into a directory similar to following, which will be referred to as the ULTRA_HOME. |
Linux/Unix
/opt/ultraesb-2.6.1
Windows
C:\Program Files\ultraesb-2.6.1
Structure of the UltraESB installation
Some familiarization of the installation structure will be helpful in using the UltraESB and next chapters of the documentation.
If you are on a Linux based system the tree command will give you something along the structure explained below.
$ tree /opt/ultraesb-2.6.1
If you are on a Windows based system, you can use the File browser to view the installation directory in a tree view.
|
Note Order of the directories/files listed below is based on the relevance, and not the alphabetical order. |
/bin
ultraesb.sh/bat - starts the UltraESB
uterm.sh/bat - starts the UltraESB management terminal
toolbox.sh/bat - starts the SOA ToolBox
encrypt.sh/bat - encrypts password to be stored on the configuration file
ultraesb-daemon.sh - starts and manages the UltraESB on production deployments (start | stop | etc…)
zkServer.sh/cmd - startup script for starting ZooKeeper for UltraESB clustering
zkCli.sh/cmd - command line client for ZooKeeper
zkEnv.sh/cmd - helper script to setup the environment for the zkServer and zkCli
zkCleanup.sh - cleanup old transaction logs, snapshots of ZooKeeper
zkServer-daemon.sh - starts and manages the Zookeeper on production deployments (start | stop | etc…)
/native - directory containing the wrapper native libraries
/conf
ultra-root.xml - the root configuration file that contains the core engine configuration
ultra-custom.xml - the custom spring beans that are statically included into the root configuration
ehcache.xml - ehcache configuration for the UltraESB caching implementation, better keep it as it is
encrypted.properties - phrases for the encrypted information
log4j2.xml - UltraESB loggers configuration for log4j2
log4j_zk.xml - ZooKeeper logger configuration for log4j2
wrapper.conf - wrapper configuration used by the UltraESB daemon script
zoo.cfg - ZooKeeper configuration
ldap.conf - ldap configuration
/deployments - the directory containing the deployment units
/default - the default deployment unit
ultra-unit.xml - the configuration of the default deployment unit which holds proxy service definitions
/lib - the libraries related to the default deployment unit (this is empty by default as there are no libraries required for the default deployment unit)
/classes - mediation classes for the default deployment unit
/src - mediation sources for the default deployment unit
/monitoring - monitoring related configurations
ultra-metrics.xml - the metrics engine configuration
alert-configs.json - the alert configurations defined in a JSON format
default-alert-actions.json - default alert actions defined for all alerts (alert actions can also be defined per alert configuration)
/uz - Zabbix configuration files
/elasticsearch - elasticsearch configuration files
elasticsearch.yml - embedded ElasticSearch configuration
/management - management related configurations
uterm.properties - configurations of the UltraESB management terminal
log4j2_uterm.properties - UltraESB management terminal loggers configuration for log4j2
/mediation
/classes - default location where mediation sequences are compiled
/src - default location for any Java source code to be picked up by sequences
/keys - the Keystores for private keys and certificates
/license
license.conf.properties - configuration file for license validation
license.key.properties - product license file
/data - default data directory used by the UltraESB
/zookeeper - default data directory used by the ZooKeeper
/elasticsearch - default data directory used by ElasticSearch
/docs - documentation assets of UltraESB
/schema - schema file for ultraesb-2.6.1
/lib - ultraesb and other core libraries
/patches - patches to any of the libraries used by the UltraESB - this location occurs first in the classpath
/custom - libraries developed or third-party libraries added by the user to be used in sequences etc
/endorsed - Java endorsed directory for UltraESB
/optional - contains optional JAR files. Files not used in your installation maybe deleted
/samples - contains JAR files used in samples. Maybe deleted in a production environment
/test - contains JAR files used for unit tests. Maybe deleted in a production environment
/uterm - contains JAR files required for UTerm
/logs - default log directory
/elasticsearch - default log directory for elasticsearch
/samples
/conf - sample configuration files
/resources - XSD’s, WSDL’s, XSLT’s etc. used by samples
/src - source code for samples and unit tests
/webapp - Web application loaded into the sample Jetty server for samples and unit tests
/bin - script files for load tests
/tmp - temporary files
/webapp - UltraESB web application, which can be used to install UltraESB on any J2EE container
Above explanation of the directory/file structure of UltraESB installation gives an overview of the UltraESB contents. These files, their content and its use will be described extensively through out the documentation. The installation structure and any customization will be discussed in detail in the <<../configuration-and-administration/index.adoc#_configuration_and_administration[Configuration and Administration] chapter.
| Refer to the Production Deployment Best Practices guide on how to configure the default installation to cater to a production deployment. |
With that briefing on the installation content, its time to start Running the UltraESB.
In this topic
In this topic