Call us: +1-415-738-4000

The Terracotta Management Console

Introduction

The Terracotta Management Console (TMC) is a web-based administration and monitoring application providing a wealth of advantages, including:

  • Multi-level security architecture, with end-to-end SSL secure connections available
  • Feature-rich and easy-to-use in-browser interface
  • Remote management capabilities requiring only a web browser and network connection
  • Cross-platform deployment
  • Role-based authentication and authorization
  • Support for LDAP directories and Microsoft Active Directory
  • Aggregate statistics from multiple nodes
  • Flexible deployment model plugs into both development environments and secure production architectures

The TMC can monitor BigMemory nodes and clusters through the Terracotta Management Server (TMS). The TMS acts as an aggregator and also provides a connection and security context for the TMC. The TMS must be available and accessible for the TMC to provide management services.

The TMS is included with your BigMemory kit under the tools/management-console directory.

For more information on using the TMC, see the following:

Installing and Configuring the TMS

The TMS files are stored in the BigMemory kit's management-console directory. You can copy this directory with all of its contents to the location where the TMS will run. Be sure to place a copy of the license file inside the management-console directory.

Running With a Different Container

The TMS can be run directly with the provided container. To run it with an application server of your choice, use the file management-console/webapps/tmc.war. Follow the specifications and requirements of your chosen application server for deploying a WAR-based application.

Configuration

A Terracotta BigMemory Max cluster can be managed directly by connecting the TMC to any one of the servers in the cluster. All other servers and clients become visible to the TMC through that initial connection. No special setup or configuration is required. Simply create a new connection and enter the URI to a server in the form

<scheme>://<host-address>:<tsa-port>.

To manage a client or standalone node (Terracotta Ehcache client or BigMemory Go) directly using the TMC, you must enable the REST management service on that node. To enable the REST management service on a BigMemory Go or Ehcache node, set the following element in the ehcache.xml configuration:

<ehcache ... >
...
  <managementRESTService enabled="true" bind="<ip_address>:<port>"/>
...
</ehcache>

where <ip_address> is the local network interface's IP address and <port> is the port number used to manage the node. The following defaults are in effect for <managementRESTService>:

  • enabled="false" (This must be set to "true" for standalone caches)
  • bind="0.0.0.0:9888" (This IP address binds the specified port all network interfaces on the local node)

The REST management service can also be enabled programmatically:

ManagementRESTServiceConfiguration rest = new ManagementRESTServiceConfiguration(); 
rest.setBind("0.0.0.0:9888"); 
rest.setEnabled(true); 
config.addManagementRESTService(rest); 

Displaying Update Statistics

By default, distributed caches (caches distribute in BigMemory Max) generate put events whenever elements are put or updated. To have the TMC track and display updates separately from puts, set the Terracotta property ehcache.clusteredStore.checkContainsKeyOnPut at the top of the Terracotta configuration file (tc-config.xml by default) before starting the Terracotta Server Array:

<tc-properties>
  <property name="ehcache.clusteredStore.checkContainsKeyOnPut" value="true" />
</tc-properties>

Enabling this property can substantially degrade performance. Before using in production, the effect of enabling this property should be thoroughly tested.

Using Multiple Instances of BigMemory Go CacheManagers With the TMC

When loading multiple instances of BigMemory Go CacheManagers with the TMC rest agent enabled in the same JVM, CacheManagers must be loaded by distinct classloaders. Two different web applications (two different WARs), for example, are loaded by different classloaders.

The TMC Update Checker

The Update Checker automatically checks to see if you have the latest updates, and collects diagnostic information on TMC usage. The Update Checker is on by default. To disable the update checker, use the following system property:

-Dcom.terracotta.management.skipUpdateCheck=true

Starting and Connecting to the TMC

Start the TMC by running the following script:

management-console/bin/start-tmc.sh

To stop the TMC, use the following script:

management-console/bin/stop-tmc.sh

For Microsoft Windows, use start.bat and stop.bat, available in the same directory.

Connect to the TMC using the following URI with a standard web browser:

http://localhost:9889/tmc

If you are connecting remotely, substitute the appropriate hostname. If you have set up secure browser connections, use "https:" instead of "http:".

When you first connect to the TMC, the security setup page appears, where you can choose to run the TMC with authentication or without. Authentication can also be enabled/disabled in the TMC Settings panel once the TMC is running. For more information, refer to the Security Setup page.

For more information on using the TMC, click the Help links available on certain pages within the UI, or choose Help from the tool bar to access the TMC online help. You can also view information about using the TMC on this page.

Updating the TMS

Installing a new version of a Terracotta kit also installs an updated version of the TMS. When this new version is started, it will check for existing configuration files under <user.home>/.tc/mgmt, backing up any incompatible files (extension .bak). In this case, previously configured connections will not appear in the TMC and must be re-added.

Uninstalling the TMC

If you want to remove the Terracotta Managment Console, delete the ~/.tc/mgmt/ directory.