Installation Overview

This installation guide describes how to install and configure the products Terracotta 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 places the following components on your machine. You can select all of the components for installation or just a subset:

1. 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.

A set of command-line utilities that allows you to perform a variety of cluster configuration and management tasks. The utilities include the cluster tool and the config tool.

For information about these utilities, see the sections Cluster Tool and Config Tool in the Terracotta Server Administration Guide.

Other utilities are described where required; for example, the use of the voter script is described in the section Failover Tuning in the Terracotta Server Administration Guide.

3. 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.

4. 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.

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, 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 Utilities sub-component or the Management Console sub-component. The Installer renames the license file if necessary to the default name license.xml, and places it in the directory TerracottaDB under the product installation directory. The license file can be used later during execution of the activate command of the config tool.

If you install using the native installation procedure, you can put the license file manually into the same location as for the Software AG Installer, 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 hosts, you will typically aim to set up the following configuration:

the Terracotta Management Console on one host (should not be one of the server machines, can be the same as the machine containing the command line utilities);

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

There is an upgrade path from earlier Terracotta 10.x releases to the current release. For details, see the section Migrating from older Terracotta versions to 10.7 in the Terracotta Server Administration Guide.

There is no upgrade path or data migration path from BigMemory product releases to the current Terracotta product release.