vFabric tc Server has several options for installation and setup. Installation options vary according to the tc Server edition you choose; whether you install tc Server standalone or as part of vFabric Platform installation; and whether your operating system is Linux or another supported platform. Installation also varies according to whether you are installing tc Server for the first time or are upgrading from a previous version.
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 components to the latest version, see Upgrade and Migration Guide. The upgrade guide also describes how to upgrade an existing pre-4.5 Hyperic installation so that it can manage tc Runtime instances.
Subtopics
Meeting Software System Requirements for tc Server
Installing tc Server as Part of vFabric Cloud Application Platform Install tc Server Developer Edition
Install tc Server Standard Edition (tc Runtime Only)
Install tc Server Standard Edition with Hyperic Management Components Activate a Local vFabric tc Server License
Overview of tc Server Directories, Variables, and Configuration Enabling Bash Completion for tc Server Scripts
Setting Up Unix Users for tc Server and Hyperic
Meeting System Software Requirements for tc Server
tc Server requires the Java Development Kit (JDK) or Java Runtime Environment (JRE). Depending on your installation, you might also need to install GNUtar and a database server.
Determine whether you must install these components:
• GNUtar. If you install the compressed TAR file of tc Server in a Unix environment and your tar command does not support the -z option, you must install GNUtar.
• Database server. If you install tc Server Standard Edition and the platform-neutral version of Hyperic Server and Agent, you must install a database server.
It is also recommended that you install a database server for production purposes, if you install the platform-neutral or platform-specific version of the Hyperic distribution. The platform-specific versions of the Hyperic distribution bundle a database to get you started, but this database is not recommended for production.
For Hyperic Server and Agent requirements, see "Installation Requirements" in vFabric Hyperic Installation Guide.
Subtopics
Required: Install JDK or JRE
Possibly Required: Install a Database Server Possibly Required: Install GNUtar
Required: Install JDK or JRE
All tc Server editions require you to download a JDK or JRE. If you are installing the Hyperic components, the JDK or JRE requirement depends on whether you install a platform-specific version or the platform-neutral version. The platform-neutral version requires a JDK or JRE, and the platform-specific versions bundle one.
Prerequisites
• For platform-specific details of supported and tested JDK or JRE versions, see the tc Server Release Notes on the tc Server Documentation Web site.
• Go to the appropriate download site for your platform: Java SE Downloads or IBM JDK and JRE Downloads.
Procedure
1. On each computer where you plan to install the tc Runtime component of tc Server, download and install a JDK or JRE.
2. If you plan to install the platform-neutral version of the Hyperic components, install a JDK or JRE on each computer on which you will install Hyperic Server or a Hyperic Agent.
Each computer requires one JDK or JRE. If you already installed a JDK or JRE on the computer in step 1, you do not need to install another one.
3. Set your JAVA_HOME environment variable to point to your installation and update your PATH environment variable to point to the JAVA_HOME/bin directory.
4. If you are installing the management components of tc Server (Hyperic Server and Hyperic Agent) on a Windows platform, set HQ_JAVA_HOME as a system environment variable that points to the location of your JDK or JRE.
Make sure you set HQ_JAVA_HOME as a system environment variable. If you set it as a user environment variable, the Hyperic Agent aborts on startup.
Possibly Required: Install a Database Server
The Hyperic Server uses a database to store its metadata. The platform-neutral version of Hyperic Server does not, however, bundle a database. If you install tc Server Standard edition and you want to install the platform-neutral version of the Hyperic Server and Agent components, you need to install a database server.
It is also recommended that you install a database server for production purposes, if you install the platform-neutral or platform-specific version of the Hyperic distribution. The platform-specific versions of the Hyperic distribution bundle a database for you to get started, but this database is not recommended for production.
Procedure
• Follow the procedure in "Set Up Hyperic Database" in vFabric Hyperic Installation Guide.
Hyperic Server supports Oracle 10g/11g, PostgreSQL, and MySQL 5.x.
Possibly Required: Install GNUtar
If you are installing tc Server on Unix and have downloaded the compressed TAR file format (*.tar.gz), the tar command on your computer must be compatible with the tar command required by the tc Server. If the commands are not, compatible, you must install GNUtar.
Procedure
1. Open a terminal window and enter:
prompt$ tar --help
2. Search the help output for a -z option, which filters the output through gzip.
• If the tar command on your computer supports the -z option, then it is compatible with the one required by tc Server and you can begin installing tc Server.
• If your tar command does not support this option, then you must install GNUtar (gtar) from an external source.
Proceed to step 3.
3. Download GNUtar for free from Sunfreeware.com.
4. Update the PATH environment variable (either of the user installing tc Server or the system-wide environment variable) to include the location of the gtar command.
The location depends on the directory in which you installed GNUtar.
5. For any references to tar in the tc Server installation procedures, substitute the command gtar.
Installing tc Server as Part of vFabric Cloud Application Platform
As with previous versions of the product, this version of vFabric tc Server is available as a standalone product installation.
Beginning with version 2.6, tc Server is also available as part of vFabric Cloud Application Platform, a set of runtime components that let you build, scale, and run modern, agile applications in virtual environments.
If you obtain tc Server standalone, you can install it on both physical and virtual machines according to the procedures in this document.
If you obtain tc Server as part of a Standard or Advanced vFabric Platform package, you install it exclusively on VMware virtual machines that run on vSphere. The platform install process adds the vFabric License Server to an existing vCenter server. The vFabric License Server accepts a network license, actually a pool of licenses for vFabric components, which makes it easy to manage the licensing of all components installed on the VMs.
If you obtain tc Server as part of vFabric Platform, first complete the license activation and installation procedures in Getting Started with vFabric Cloud Application Platform. Then follow procedures in this document to install tc Server and complete any remaining tc Server-specific installation and configuration tasks.
Install tc Server Developer Edition
When you install the Developer Edition of tc Server, you create a tc Runtime instance that contains Spring Insight Developer.
The procedure covers Unix and Windows installation, although most instructions are specific to Unix. If you install on Windows, change the forward slashes (/) to back slashes (\); other differences in the installation are called out.
Prerequisites
• Verify that your system meets the installation requirements. See Meeting System Software Requirements for tc Server.
• Review information about tc Server Developer edition and its *.zip or *.tar.gz distribution files. See tc Server Editions.
• Determine the user that is going to create and run the tc Runtime instances, and create it if necessary. Consider creating a user dedicated to tc Server tasks, putting the user in a separate group from regular users, and disabling its interactive login for security purposes. See Setting Up Unix Users for tc Server and Hyperic.
On Unix, never run tc Runtime instances as the root user.
For clarity, it is assumed in this topic that you will install and run tc Server as the tcserver user.
Procedure
1. On the VMware Download page, navigate to the tc Server download page and download the Developer Edition distribution in ZIP or compressed TAR file format.
• vfabric-tc-server-developer-2.6.X.RELEASE.zip
• vfabric-tc-server-developer-2.6.X.RELEASE.tar.gz
2. Login to the computer on which you are installing tc Server as the appropriate user, such as tcserver. On Unix, if you have disabled interactive login, login as the root user and use su - tcserver to become the user.
3. Open a terminal (Unix) or command window (Windows) and create the main tc Server installation directory, such as /opt/
vmware.
For example, on Unix:
prompt$ mkdir /opt/vmware
4. Extract the tc Server distribution file into the new directory.
This action creates a directory called vfabric-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.
The templates directory contains a template called insight that contains the Spring Insight application.
5. Create a tc Runtime instance that contains Spring Insight by specifying the insight template.
Unix: Change to the /opt/vmware/vfabric-tc-server-developer directory and execute the tcruntime-instance.sh script to create an instance.
VMware recommends that you use the -i option to specify the full pathname of a directory in which the new instance will be created, and that this directory be different from the installation directory. Be sure the tcserver user can write to this directory and that the directory already exists.
For example:
prompt$ cd /opt/vmware/vfabric-tc-server-developer prompt$ ./tcruntime-instance.sh create -t insight \
-i /var/opt/vmware/vfabric-tc-server-developer insight-instance
Windows: Change to the \opt\vmware\vfabric-tc-server-developer directory and execute the tcruntime-instance.bat script to create an instance:
prompt> cd \opt\vmware\vfabric-tc-server-developer
prompt> tcruntime-instance.bat create insight-instance -t insight \ -i \var\opt\vmware\vfabric-tc-server-developer
6. Start the new tc Runtime instance.
Unix: Execute the tcruntime-ctl.sh script to start the instance; use the -n option to specify the directory in which the instance is located. For example:
prompt$ ./tcruntime-ctl.sh insight-instance start -n /var/opt/vmware/vfabric-tc-server-developer
Windows: Execute the tcruntime-ctl.bat script to first install the tc Runtime instance as a Windows service and then start it; for both commands, use the -n option to specify the directory in which the instance is located:
prompt> tcruntime-ctl.bat insight-instance install -n \var\opt\vmware\vfabric-tc-server-developer prompt> tcruntime-ctl.bat insight-instance start -n \var\opt\vmware\vfabric-tc-server-developer
On Windows, VMware recommends that you subsequently start and stop the tc Runtime instance through 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 servger directory.
7. After the tc Runtime instance starts, invoke Spring Insight in your browser:
http://host:8080/insight
where host refers to the computer on which Spring Insight is running. If you are on the same computer, you can use localhost:
http://localhost:8080/insight
What to do next
• For details about the directories you installed, see Overview of tc Server Directories, Variables, and Configuration Files.
• For Spring Insight overview information and to create plug-ins that extend Spring Insight, see Spring Insight Developer.
• Try out the tutorials. See Tutorial: Using Hyperic to Configure and Manage tc Runtime Instances and Tutorial: Very Simple Web Application Development.
Install tc Server Standard Edition (tc Runtime Only)
When you install tc Server Standard Edition, you can choose to install the tc Runtime component only, without installing any Hyperic components.
Prerequisites
• Verify that your system meets the installation requirements. See Meeting System Software Requirements for tc Server.
• Review information about tc Server Standard edition and its *.zip or *.tar.gz distribution files. See tc Server Editions.
• Determine the user that is going to create and run the tc Runtime instances, and create it if necessary. Consider creating a user dedicated to tc Server tasks, putting the user in a separate group from regular users, and disabling its interactive login for security purposes. See Setting Up Unix Users for tc Server and Hyperic.
On Unix, never run tc Runtime instances as the root user.
For clarity, it is assumed in this topic that you will install and run tc Server as the tcserver user.
Procedure
1. From the VMware Download page, navigate to the VMware vFabric tc Server download page.
2. Download the Standard Edition Runtime package distribution in ZIP or compressed TAR format to a directory on your computer, for example /home/Downloads.
• vfabric-tc-server-standard-2.6.X.RELEASE.zip
• vfabric-tc-server-standard-2.6.X.RELEASE.tar.gz
3. Login to the computer on which you are installing tc Server as the appropriate user, such as tcserver. On Unix, if you have disabled interactive login, login as the root user and use su - tcserver to become the user.
4. Open a terminal (Unix) or command window (Windows) and create the main tc Server installation directory, such as /opt/
vmware.
For example, on Unix:
prompt$ mkdir /opt/vmware
5. Extract the tc Server distribution file into the new directory.
This action installs tc Runtime; there is no installer program.
For example, if you created a directory called /opt/vmware in the preceding step, and downloaded the Standard Edition ZIP file in the /home/Downloads directory:
prompt$ cd /opt/vmware
prompt$ unzip /home/Downloads/vfabric-tc-server-standard-2.6.0.RELEASE.zip
This action creates a directory called vfabric-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.
What to do next
• If you installed tc Server standalone, activate a local tc Server license as described in Activate a Local vFabric tc Server License.
If you installed tc Server as part of vFabric Cloud Application Platform, then you should have already activated a network license using the vSphere client, as described in Installing tc Server as Part of vFabric Cloud Application Platform.
• For details about the directories you installed, see Overview of tc Server Directories, Variables, and Configuration Files
• For typical post-installation procedures such as creating tc Runtime instances, starting tc Server components, and getting started with the Hyperic user interface, see Post-Installation Tasks.
• Try out the tutorials. See Tutorial: Using Hyperic to Configure and Manage tc Runtime Instances and Tutorial: Very Simple Web Application Development.
Install tc Server Standard Edition and Hyperic Management Components
When you install tc Server Standard Edition, you have the option of also installing VMware vFabric Hyperic to monitor and manage tc Server. Hyperic 4.5 and later includes the tc Server Hyperic plug-in, which allows you to use the Hyperic interface to monitor and manage tc Runtime instances.
There are two Hyperic components to install. Hyperic Agent is installed on every computer running a tc Runtime instance.
Hyperic Agent discovers tc Runtime processes, adds them to the inventory and manages them, through the tc Server plug-in.
A computer with tc Server runtime instances and Hyperic Agent is called a "managed node." The other component, Hyperic Server, can be installed on any computer in the network and provides the central control point and user interface to use Hyperic to manage multiple deployments.
The procedure breaks the installation steps into those you do on managed node computer(s) and those you do on the Hyperic Server computer. If you are installing everything on the same computer, then simply execute all steps on the same computer.
If you are installing tc Runtime instances on multiple computers you must install Hyperic Agent on each computer.
Prerequisites
• Verify that your system meets the installation requirements for installing tc Server with Hyperic management components. See Meeting System Software Requirements for tc Server.
• Review information about tc Server Standard edition and it's *.zip or *.tar.gz distribution files. See tc Server Editions.
• Determine the user that is going to create and run the tc Runtime instances, and create it if necessary. Consider creating a user dedicated to tc Server tasks, putting the user in a separate group from regular users, and disabling its interactive login for security purposes. See Setting Up Unix Users for tc Server and Hyperic for additional information about the Hyperic user.
On Unix, never run tc Runtime instances as the root user.
For clarity, it is assumed in this topic that you will install and run tc Server and Hyperic Agent as the tcserver user and install and run the Hyperic Server as the hyperic user.
• If you have an existing Hyperic installation, see Upgrade and Migration Guide for details about upgrading Hyperic with the tc Server Hyperic plug-in.
• To understand the various installation scenarios for managed nodes and the Hyperic Server, read How tc Server and Hyperic Work Together. Then decide how you will install the components:
• Install all components on the same computer.
• Install Hyperic Server on one computer and install the managed node (Hyperic Agent and tc Runtime) on one or more different computers.
Procedure
1. On the computer on which you plan to install the managed node (tc Runtime and Hyperic Agent), login as the appropriate user, such as tcserver. On Unix, if you have disabled interactive login, login as the root user and use su -tcserver to become the user.
2. Open a terminal (Unix) or command prompt (Windows) and create two new directories: one to contain the tc Runtime component (such as /opt/vmware/tcserver) and one to contain the Hyperic Agent (such as /opt/vmware/
hyperic.)
You can install tc Runtime and Hyperic Agent in the same directory, but in this procedure it is assumed that you install them in different directories.
For example, on Unix:
prompt$ mkdir /opt/vmware/tcserver prompt$ mkdir /opt/vmware/hyperic
3. From the VMware Download Center, navigate to the VMware vFabric tc Server download page, and download the tc Server Standard edition ZIP or compressed TAR file distribution into a directory on your computer, for example /home/
Downloads:
• vfabric-tc-server-standard-2.6.X.RELEASE.zip
• vfabric-tc-server-standard-2.6.X.RELEASE.tar.gz
4. Extract the tc Server distribution file into the /opt/vmware/tcserver directory.
This action installs tc Runtime; there is no installer program.
For example, if you created a directory called /opt/vmware/tcserver in the preceding step, and downloaded the Standard Edition file to the /home/Downloads directory:
prompt$ cd /opt/vmware/tcserver
prompt$ unzip /home/Downloads/vfabric-tc-server-standard-2.6.0.RELEASE.zip
A directory called vfabric-tc-server-standard 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.
A directory called vfabric-tc-server-standard 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.