Jetty

Installation of Jetty
Installation of CloverETL Server
Configuration of CloverETL Server on Jetty
[Important]Important

See Application Server in system requirements for currently supported Jetty versions and required Java versions.

If you encounter any problems during the installation, the Possible Issues during Installation section may provide a solution.

Installation of Jetty

  1. Download the Jetty release from the official download page.

    CloverETL Server is currently developed and tested with Jetty 9.2.11 (v20150529) container. Since CloverETL 4.0, Jetty 6 is no longer supported (latest tested version is 6.1.22). Running the Server with other versions may result in unpredictable behavior.

  2. Extract the downloaded archive (zip or tar.gz).

  3. Run Jetty.

    • Unix-like systems:

      • Run [Jetty_home]/bin/jetty.sh start

    • Windows system:

      • Run the [Jetty_home]\java -jar start.jar --exec command in Windows command prompt.

  4. Check whether Jetty is running.

    • Open a new tab in your browser and type http://localhost:8080/ in the address bar.

      [Note]Note

      Since the clover.war file is not yet implemented, you may see the Error 404 - Not found status code (see the figure below). However, it means that the server is running.

      Jetty welcome page

      Figure 3.4. Jetty welcome page


Installation of CloverETL Server

  1. Check if you meet the prerequisites:

  2. It is strongly recommended to adjust the default limits for Memory allocation (see the Memory Settings section).

    You can set the minimum and maximum memory heap size by adjusting the "Xms" and "Xmx" JVM parameters and classloaders memory limit by adjusting the "XX:MaxMetaspaceSize" parameter:

    • Unix-like systems:

      Edit the [Jetty_home]/bin/jetty.sh file.

      Type or paste the following line at the end of the file:

      JAVA_OPTIONS='$JAVA_OPTIONS -Xms128m -Xmx1024m -XX:MaxMetaspaceSize=256m'

    • Windows system:

      Edit the [Jetty_home]\start.ini file.

      Type or paste the following line at the end of the file:

      JAVA_OPTIONS='$JAVA_OPTIONS -Xms128m -Xmx1024m -XX:MaxMetaspaceSize=256m'

    [Important]Important

    If you use Java 7, change -XX:MaxMetaspaceSize to -XX:MaxPermSize.

  3. Go to the download section of your CloverETL account and download the clover.war (web archive) file containing CloverETL Server for Jetty.

  4. Copy clover.war to the [Jetty_home]/webapps directory.

  5. Run Jetty.

    • Unix-like systems:

      • Run [Jetty_home]/bin/jetty.sh start

    • Windows system:

      • Run the [Jetty_home]\java -jar start.jar --exec command in Windows command prompt.

  6. Check whether CloverETL Server is running:

    • Open a new tab in your browser and type http://localhost:8080/clover/ in the address bar.

    • Use the default administrator credentials to access the web GUI: username: clover, password: clover.

Configuration of CloverETL Server on Jetty

[Tip]Tip
Default installation (without any configuration) is only recommended for evaluation purposes. For production use, at least a dedicated database and SMTP server configuration is recommended.

For detailed configuration of CloverETL Server, use a properties file. Here you can configure various properties, including the connection to the database, username and password, path to the license file, private properties, number of active threads, clusters and much more (see Chapter 9, List of Properties and Chapter 35, Cluster Configuration). The file can be placed either on a default, or specified location.

Content of such a file (example with MySQL database):

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/clover?useUnicode=true&characterEncoding=utf8
jdbc.username=yourUsername
jdbc.password=yourPassword
jdbc.dialect=org.hibernate.dialect.MySQLDialect

[Note]Note

JDBC Driver must be JDBC 4 compliant and stored in the [Jetty_home]/lib/ext.

Properties file in Specified Location

The properties file is loaded from a location which is specified by the environment/system property clover_config_file or clover.config.file. This is a recommended way of configuring Jetty.

  1. Create the cloverServer.properties file in a directory readable by Jetty. (If you need an example of connection to any of supported databases, see Chapter 8, Examples of DB Connection Configuration.)

  2. Unix-like systems:

    1. Edit the [Jetty_home]/bin/jetty.sh file.

    2. Set the system property by adding the following line into the file:

      JAVA_OPTIONS="$JAVA_OPTIONS -Dclover_config_file=/path/to/cloverServer.properties"

    Windows system:

    1. Edit the [Jetty_home]\start.ini file.

    2. Set the system property by adding the following line into the file just after the memory settings:

      JAVA_OPTIONS="$JAVA_OPTIONS -Dclover_config_file=/path/to/cloverServer.properties"