6.2 Installing tc Server: Main Steps

This section describes how to install tc Server. It is divided into sub-sections, depending on the edition of tc Server you are going to install and the way it is packaged. Be sure to read tc Server Editions for information about each edition, what they contain, and the names of the *.zip or *.tar.gz files into which each edition is packaged.

The procedures cover both Unix and Windows installation. Most of the instructions, however, are for Unix. If you are installing on Windows, change the forward slashes (/) to back slashes (\); other differences in the installation are called out.

[Note]Note

It is assumed that you are installing tc Server for the first time. If you have already installed a previous version of tc Server, have created one or more tc Runtime instances, and now want to upgrade all the components to the latest version, see Upgrade and Migration Guide. The upgrade guide also describes how to upgrade an existing HQ installation so that it can manage tc Runtime instances.

Installing Developer Edition

  1. Download and install a JDK or JRE, if you do not already have one installed on your computer. See Before you Begin: System Requirements.

  2. Download the tc Server Developer Edition distribution from the SpringSource Download Center.

    The Developer Edition is distributed as either a ZIP or compressed TAR file with the following names:

    • springsource-tc-server-developer-2.0.X.RELEASE.zip
    • springsource-tc-server-developer-2.0.X.RELEASE.tar.gz
  3. Open a terminal (Unix) or command window (Windows) and create the main tc Server installation directory, such as /home/tcserver. For example, on Unix:

    prompt$ mkdir /home/tcserver
  4. Unzip or untar the tc Server distribution file into the new directory.

    This creates a directory called springsource-tc-server-developer in the main tc Server installation directory that contains the tc Runtime utility scripts, the templates directory, the tomcat-version directory, and so on.

    See Overview of tc Server Directories, Variables, and Configuration Files for details.

    This directory also contains a prepackaged tc Runtime instance called spring-insight-instance that contains the Spring Insight feature.

  5. Start the prepackaged tc Runtime instance. The exact steps depend on your platform (Unix or Windows.)

    Unix: Change to the /home/tcserver/springsource-tc-server-developer directory and execute the tcruntime-ctl.sh script to start the instance. For example:

    prompt$ cd /home/tcserver/springsource-tc-server-developer
    prompt$ ./tcruntime-ctl.sh spring-insight-instance start

    Windows: Change to the c:\home\tcserver\springsource-tc-server-developer directory and execute the tcruntime-ctl.bat script to first install the tc Runtime instance as a Windows service and then start it:

    prompt> cd c:\home\tcserver\springsource-tc-server-developer
    prompt> tcruntime-ctl.bat spring-insight-instance install
    prompt> tcruntime-ctl.bat spring-insight-instance start

    Subsequently, Springsource recommends that you start and stop the tc Runtime instance by using the Windows Services console. The tc Runtime instance is displayed in the console with the name SpringSource tc Runtime - unique-name, where unique-name is a unique combination of server name and server directory.

  6. After the tc Runtime instance starts, invoke Spring Insight in your browser:

    http://host:8080/insight

    where host refers to the computer on which it is running; if this is the same computer as the browser, you can use localhost:

    http://localhost:8080/insight

See Using Spring Insight for overview and usage information about Spring Insight as well as information about creating plug-ins that extend Spring Insight.

For general tc Server post-installation tasks, see Next Steps.

Installing Standard Edition (Runtime Package)

  1. Download and install a JDK or JRE, if you do not already have one installed on your computer. See Before you Begin: System Requirements.

  2. On the SpringSource Download Center page under tc Server, click the tc Server Standard Edition link and navigate to the download page.

  3. Download the Standard Edition Runtime package distribution.

    Choose the ZIP or the compressed TAR file distribution:

    • springsource-tc-server-standard-2.0.X.RELEASE.zip
    • springsource-tc-server-standard-2.0.X.RELEASE.tar.gz
  4. Open a terminal (Unix) or command window (Windows) and create the main tc Server installation directory, such as /home/tcserver. For example, on Unix:

    prompt$ mkdir /home/tcserver
  5. Unzip or untar the tc Server distribution file into the new directory.

    This creates a directory called springsource-tc-server-standard in the main tc Server installation directory that contains the tc Runtime utility scripts, the templates directory, the tomcat-version directory, and so on.

    See Overview of tc Server Directories, Variables, and Configuration Files for details.

See Next Steps for links to post-installation procedures.

Installing Standard Edition (Managed Node Package)

This section describes how to install a managed node (tc Runtime and HQ Agent) as well as an HQ Server; both HQ components are preconfigured with the tc Server HQ plug-in.

Read How tc Server and HQ Work Together to understand the various installation scenarios for managed nodes and the HQ Server. Then decide which tc Server components (tc Runtime, HQ Agent, and HQ Server) you are going to install on your computer(s). The typical scenarios are:

  • Install all components on the same computer.

  • Install HQ Server on one computer and install the managed node (HQ Agent and tc Runtime) on one or more different computers.

The procedure below breaks the steps into those you do on the managed node computer(s) and those you do on the HQ Server computer. If you are installing everything on the same computer, then simply execute all steps on the same computer.

[Note]Note

If you will be installing tc Runtime instances on multiple computers you must install HQ Agent on each computer.

If you have an existing HQ installation, see Upgrade and Migration Guide for details about upgrading HQ with the tc Server HQ plug-in.

  1. On the computer on which you are going to install the managed node (tc Runtime and HQ Agent), download and install a JDK or JRE, if you have not already done so. See Before You Begin: System Requirements.

  2. On the SpringSource Download Center page under tc Server, click the tc Server Standard Edition link and navigate to the download page.

  3. Download the tc Server Managed Node distribution.

    Choose the ZIP or compressed TAR file distribution:

    • springsource-tc-server-node-2.0.X.RELEASE.zip
    • springsource-tc-server-node-2.0.X.RELEASE.tar.gz
  4. Open a terminal (Unix) or command prompt (Windows) and create the main tc Server managed node installation directory, such as /home/tcserver. For example, on Unix:

    prompt$ mkdir /home/tcserver

    This directory will contain the managed node components (tc Runtime and HQ Agent).

  5. Unzip or untar the tc Server distribution file into the new directory.

    A directory called springsource-tc-server-node is created in the main tc Server installation directory that contains the tc Runtime utility scripts, the templates directory, the tomcat-version directory, and so on.

    See Overview of tc Server Directories, Variables, and Configuration Files for details.

    This directory also contains the HQ Agent that has been preconfigured with the tc Server HQ plug-in. The agent is contained in the hyperic-hq-agent-4.2.X.X-EE sub-directory (such as /home/tcserver/springsource-tc-server-node/hyperic-hq-agent-4.2.X.X-EE).

  6. On the computer on which you are going to install HQ Server, download and install a JDK or JRE, if you have not already done so. See Before you Begin: System Requirements.

  7. If you have not already done so, download and install a database server on the computer that will host HQ Server or on a remote computer that is accessible to the HQ Server host computer. See Before You Begin: System Requirements.

    Obtain the URL and username/password used to connect to your database server, because the installation program for HQ Server will ask for it.

  8. Open a terminal (Unix) or command prompt (Windows) and create the directory that will contain the HQ Server, such as /home/hyperic. For example, on Unix:

    prompt$ mkdir /home/hyperic

    If you are installing all components on the same computer, you can install the HQ Server into the same tc Server directory that you already created (/home/tcserver in our example.)

  9. From the same page that you downloaded the tc Server Managed Node distribution (step 2 and 3), download the HQ Server distribution. This version of HQ Server is platform-neutral and is preconfigured with the tc Server HQ plug-in.

    Choose the ZIP or compressed TAR file:

    • hyperic-hq-installer-noJRE-tc-server-2.0.X.RELEASE.zip
    • hyperic-hq-installer-noJRE-tc-server-2.0.X.RELEASE.tar.gz
  10. Unzip the HQ Server distribution into a temporary directory.

  11. From your terminal window or command prompt, change to this temporary directory and execute the setup.sh (Unix) or setup.bat (Windows) script. For example, on Unix:

    prompt$ cd /tmp/hyperic-hq-installer-noJRE-tc-server-2.0.X.RELEASE
    prompt$ ./setup.sh

    After accepting the terms of agreement, enter 1 to install just the HQ Server, because you installed the HQ Agent in a preceding step. The script asks a few more questions, such as information about your database and the directory into which you want to install the HQ Server (/home/hyperic or /home/tcserver in our example.)

    When the setup.sh script completes, the HQ Server will be installed in the directory /home/hyperic/server-4.2.X.X-EE.

    See Installing the Agent and Server from a Tarball or Zip Archive for additional details about the questions asked by the setup.sh script.

See Next Steps for links to post-installation procedures.

Installing Spring Edition

  1. On the SpringSource Download Center page under tc Server, click the tc Server Spring Edition link and navigate to the download page. You will see downloads for the tc Server Standard Edition Managed Node, HQ Server, and the Instrumented Spring JARs.

  2. Follow the instructions in Installing Standard Edition (Managed Node Package) to download and install the tc Server managed node and HQ Server.

  3. Download the distributions of Spring Framework, Spring Web Flow, Spring Security, and Spring Web Services that have been specifically instrumented for management with Hyperic HQ.

  4. See Spring Instrumentation Documentation for information about using these instrumented JARs with your Spring application.

Next Steps

See Overview of tc Server Directories, Variables, and Configuration Files for conceptual information about tc Server directories and configuration files. See Post-Installation Tasks for the list of typical post-installation procedures, such as creating tc Runtime instances, starting the various components of tc Server and getting started with the HQ user interface.

Then try out the tutorials: Tutorial: Using HQ to Configure and Manage tc Runtime Instances and Tutorial: Very Simple Web Application Development.