1.1 Distributed Ehcache Express Installation

1.1.3a Add Terracotta to Specific Caches

For any cache that should be clustered by Terracotta, add the sub-element <terracotta /> to that cache's <cache> block in ehcache.xml . For example, the following cache is clustered with Terracotta:

<cache name="myCache" maxElementsInMemory="1000" 

       maxElementsOnDisk="10000" eternal="false" timeToIdleSeconds="3600" 

       timeToLiveSeconds="0" memoryStoreEvictionPolicy="LFU"> 

  <!-- Adding the element <terracotta /> turns on Terracotta clustering for the cache myCache. -->

  <terracotta /> 

</cache> 

1.1.3b Edit Incompatible Configuration

For any clustered cache, you must delete, disable, or edit configuration elements that are incompatible when clustering with Terracotta. Clustered caches have a <terracotta> or <terracotta clustered="true"> element.

The following Ehcache configuration attributes or elements should be deleted or disabled:

• DiskStore-related attributes overflowToDisk and diskPersistent .

The Terracotta server automatically provides a disk store.

• Replication-related attributes such as replicateAsynchronously and replicatePuts .
• The attribute MemoryStoreEvictionPolicy must be set to either LFU or LRU.

Setting MemoryStoreEvictionPolicy to FIFO causes the error IllegalArgumentException .

UNIX/Linux

[PROMPT] ${TERRACOTTA_HOME}/bin/start-tc-server.sh &

Microsoft Windows

[PROMPT] ${TERRACOTTA_HOME}\bin\start-tc-server.bat

• 2. Start the application servers.
• 3. Start the Terracotta Developer Console:

UNIX/Linux

[PROMPT] ${TERRACOTTA_HOME}/bin/dev-console.sh &

Microsoft Windows

[PROMPT] ${TERRACOTTA_HOME}\bin\dev-console.bat

• 4. Connect to the Terracotta cluster.

Click Connect... in the Terracotta Developer Console.

• 5. Click the Ehcache node in the cluster navigation window to see the caches in the Terracotta cluster.

Your console should have a similar appearance to the following annotated figure.

1.1.5a Procedure:

• 1. Shut down the Terracotta cluster.
• 2. Create a Terracotta configuration file called tc-config.xml with contents similar to the following:

<?xml version="1.0" encoding="UTF-8"?>

<!-- All content copyright Terracotta, Inc., unless otherwise indicated. All rights reserved. -->

<tc:tc-config xsi:schemaLocation="http://www.terracotta.org/schema/terracotta-5.xsd" 

xmlns:tc="http://www.terracotta.org/config" 

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <servers>

    <!-- Sets where the Terracotta server can be found. Replace the value of host with the server's IP address. -->

    <server host="server.1.ip.address" name="Server1">

      <data>%(user.home)/terracotta/server-data</data>

      <logs>%(user.home)/terracotta/server-logs</logs>

    </server>

    <!-- If using a standby Terracotta server, also referred to as an ACTIVE-PASSIVE configuration, add the second server here. -->

    <server host="server.2.ip.address" name="Server2">

      <data>%(user.home)/terracotta/server-data</data>

      <logs>%(user.home)/terracotta/server-logs</logs>

  </server>

<!-- If using more than one server, add an <ha> section. -->

    <ha>

      <mode>networked-active-passive</mode>

      <networked-active-passive>

        <election-time>5</election-time>

      </networked-active-passive>

    </ha>

  </servers>

  <!-- Sets where the generated client logs are saved on clients. Note that the exact location of Terracotta logs on client machines may vary based on the value of user.home and the local disk layout. -->  

  <clients>

    <logs>%(user.home)/terracotta/client-logs</logs>

  </clients>

</tc:tc-config>

• 3. Install Terracotta 3.2.1 on a separate machine for each server you configure in tc-config.xml .
• 4. Copy the tc-config.xml to a location accessible to the Terracotta servers.
• 5. Perform Step 2: Install the Distributed Cache and Step 3: Configure the Distributed Cache on each application node you want to run in the cluster.

Be sure to install your application and any application servers on each node.

• 6. Add the following to the Ehcache configuration file, ehcache.xml :

<!-- Add the servers that are configured in tc-config.xml. -->

<terracottaConfig url="server.1.ip.address:9510,server.2.ip.address:9510" />

• 7. Copy ehcache.xml to each application node and ensure that it is on your application's classpath. If you are using a WAR file, add the Ehcache configuration file to WEB-INF/classes or to a JAR file that is included in WEB-INF/lib .
• 8. Start the Terracotta server in the following way, replacing "Server1" with the name you gave your server in tc-config.xml :

[PROMPT] ${TERRACOTTA_HOME}/bin/start-tc-server.sh -f <path/to/tc-config.xml> -n Server1 &

[PROMPT] ${TERRACOTTA_HOME}\bin\start-tc-server.bat -f <path\to\tc-config.xml> -n Server1 &