Installation Overview

This installation guide describes how to install and configure the products Terracotta DB and Terracotta Ehcache.

You can install your Terracotta product in two different ways:

By using the Software AG Installer. This simplifies the integration with other Software AG products, such as the components of the webMethods product suite.

The installation procedure for Terracotta DB places the following components on your machine. You can select all of the components for installation or just a subset:

1. Terracotta Server: The server component that manages the resources of all of the Ehcache caches and TCStore stores. For information about this component, see the Terracotta Server Administration Guide.

2. Cluster tool: A command-line utility that allows you to perform a variety of server and cluster management tasks. You require this tool in order to install the license file on the server and make it usable, regardless of whether your server configuration is single-node or multi-node. For information about this component, see the related section in the Terracotta Server Administration Guide.

3. Management Console: The browser-based graphical user interface that allows you to monitor and manage the current status of all caches and stores managed by the Terracotta Server. For information about this component, see the Terracotta Management Console User Guide.

4. Ehcache Client Libraries: The Ehcache API client libraries that you integrate into your Ehcache-based applications. These libraries are available both as OSGi and non-OSGi builds. For information about using the Ehcache API, see the Ehcache API Developer Guide.

5. TCStore Client Libraries: The TCStore API client libraries that you integrate into your TCStore-based applications. These libraries are available both as OSGi and non-OSGi builds. For information about using the TCStore API, see the TCStore API Developer Guide.

If you are installing Terracotta Ehcache, the product scope does not include the TCStore component. Therefore the installation procedure allows you to install the same components as for Terracotta DB, except the TCStore Client Libraries component.

As part of the installation procedure, you will need the product license file that you receive as part of the product delivery.

If you install Terracotta using the Software AG Installer, you will be asked to provide the license file during the installation process if you select the cluster tool sub-component. The Installer renames the file if necessary, and places it under the default location, which is /tools/cluster-tool/conf under the product installation location, so that it is discovered automatically during the cluster configuration phase later.

If you install using the native installation procedure, you can put the license file manually under the default location, or provide it at the time of cluster configuration.

For a list of system requirements such as supported operating systems and web browsers, see the section System Requirements.

If you intend to use Terracotta in a distributed environment with multiple nodes (i.e. physical machines), you will typically aim to set up the following configuration:

the Terracotta Management Console on one node (should not be one of the server nodes, can be same as the Cluster Tool node);

These components are individually selectable when you use the Software AG Installer to perform the installation.

There is no upgrade path or data migration path from Terracotta v4.x products to the current product version.

There is also no upgrade path or data migration path from Terracotta Ehcache 10.0 to the current product version.