Table of Contents. Copyright Pivotal Software Inc, x

Transcription

1 Table of Contents Table of Contents Getting Started with Pivotal tc Server Quick Start Overview of tc Server Installing Pivotal tc Server Creating and Managing tc Runtime Instances Security Information Upgrade and Migration Guide Tutorial - Using Hyperic to Configure and Manage tc Runtime Instances Tutorial - Very Simple HelloWorld Web Application Troubleshooting Copyright Pivotal Software Inc, x

2 Getting Started with Pivotal tc Server Getting Started with Pivotal tc Server describes product concepts and provides setup instructions for Pivotal tc Server. Read the documentation to learn how to create, start, and stop tc Runtime instances; and deploy Web applications. Quick Start Overview of tc Server Installing Pivotal tc Server Creating and Managing tc Runtime Instances Security Information Upgrade and Migration Guide Tutorial - Using Hyperic to Configure and Manage tc Runtime Instances Tutorial - Very Simple HelloWorld Web Application Troubleshooting Intended Audience This document is intended for anyone who wants to install, configure, and use tc Server to develop or to serve Web applications. Copyright Pivotal Software Inc, x

3 Quick Start This section provides quick start instructions for installing Pivotal tc Server Standard Edition, creating a tc Runtime instance, and starting the tc Runtime instance. If you are upgrading an existing tc Server installation, see the upgrade documentation. If you are installing tc Server Developer Edition, see Install tc Server Developer Edition. Install tc Server 1. Download and install a JDK or JRE on the computer on which you are installing tc Server. See Supported Configurations and System Requirements. 2. 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 and disabling its interactive login for security purposes. On Unix, never run tc Runtime instances as the root user. See Setting Up Unix Users for tc Server and VMware vcenter Hyperic. For clarity, it is assumed in this topic that you will install and run tc Server as the tcserver user. 3. Login to the computer on which you are installing tc Server as the appropriate user, such as tcserver. 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 Prompt (Windows) and create a directory to contain the tc Runtime component (such as /opt/pivotal ) if it doesn t already exist. Unix example: prompt$ mkdir /opt/pivotal Windows example: prompt> mkdir \opt\pivotal 5. From the Pivotal tc Server product page, click Downloads. 6. Download the most recent pivotal-tc-server-standard-version.zip file and unzip the contents into the directory you created in the preceding step. The version in the zip file name is the release number, for example RELEASE. This is all that is required to install tc Runtime. For example, in Unix, if you specified a directory called /opt/pivotal in the preceding step and downloaded the Standard Edition file to your home directory: prompt$ cd /opt/pivotal prompt$ unzip ~/pivotal-tc-server-standard release.zip In Windows Explorer, double-click the ZIP file you downloaded to launch the Windows Extraction Wizard and extract the file into the directory you created in the preceding step. After you unzip the ZIP file you will have a directory called /opt/pivotal/pivotal-tc-server-standard-version. This directory contains all the tc Runtime files and directories. Create and start a tc Runtime instance 1. From your terminal window or Command Prompt, change to the tc Runtime directory and execute the tcruntime-instance command to create a basic tc Runtime instance (called myserver in the examples). Pivotal recommends that you use the --instance-directory 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. Unix example: prompt$ cd /opt/pivotal/pivotal-tc-server-standard release prompt$./tcruntime-instance.sh create --instance-directory /var/opt/pivotal/pivotal-tc-server-standard myserver Windows example: Copyright Pivotal Software Inc, x

4 prompt> cd \opt\pivotal\pivotal-tc-server-standard release prompt> tcruntime-instance.bat create --instance-directory \var\opt\pivotal-tc-server-standard myserver 2. Execute the tcruntime-ctl command to start the new tc Runtime instance; use the -i option to specify the directory in which the instance is located. Unix example: prompt$./tcruntime-ctl.sh myserver start -i /var/opt/pivotal/pivotal-tc-server-standard Windows example: prompt> tcruntime-ctl.bat myserver start -i \var\opt\pivotal\pivotal-tc-server-standard To confirm that the tc Runtime instance is running, invoke its welcome page in a browser. Use the URL where host is the name or IP address of the computer on which the tc Runtime instance is running ( localhost if local). What to do next Read about tc Server features Install tc Server Developer Edition Read about additional options for creating tc Runtime Instances, such as automatically configuring a NIO HTTPS connector or using Elastic Memory for Java (EM4J) Copyright Pivotal Software Inc, x

5 Overview of tc Server Pivotal tc Server is a Web application server based on open-source Apache Tomcat. It preserves the best of Tomcat and adds many mission-critical operational capabilities that are unavailable in the open-source product. tc Server harnesses the power of traditional JEE architectures and eliminates their complexity and performance drawbacks, making it easier, faster, and more cost-effective to build and run cloud-ready applications. With its lean architecture and small memory footprint, tc Server requires significantly fewer resources than conventional servers, which allows for greater server density in virtual and cloud environments. Usability Enhancements to Apache Tomcat The tc Server runtime component, known as tc Runtime, offers usability advantages that make it easier, faster, and more flexible to configure and operate than Apache Tomcat. tc Runtime includes the following usability enhancements: Improved out-of-the-box configuration. In most cases, you can use tc Server immediately after you install it, with no additional configuration. Easy creation of a tc Runtime instance with the tcruntime-instance command script. You can leverage additional (optional) configuration features by specifying prepackaged or custom templates when you create a tc Runtime instance, such as automatically configuring clustering or SSL. Easy and intuitive startup of a tc Runtime instance on both UNIX and Windows platforms. Default configuration of high-concurrency JDBC connection pool in new tc Runtime instances. tc Server Editions tc Server is available in three different editions. tc Server Developer is geared towards the enterprise application developer. tc Server Standard and Spring Edition are designed for operators and administrators. Table 1. Pivotal tc Server Editions The following sections describe the tc Server editions: Developer Edition Standard Edition Developer Edition The Developer Edition of tc Server is geared towards the application developer. It contains the tc Runtime; utilities to create and start tc Runtime instances; and a set of templates for creating specific preconfigured tc Runtime instances, such as cluster-node ready and SSL-enabled. This edition comes with Spring Insight Developer, an application that provides real-time visibility into the behavior and performance of user applications. The tc Server Developer Edition contains a template called insight that includes the Spring Insight application. You use this template to create new tc Runtime instances enabled with Spring Insight. See About Spring Insight Developer for help setting up and using Spring Insight. tc Server Developer Edition includes Tomcat Web Application Manager, a web application you can use to deploy and manage tc Runtime applications. The Developer Edition is distributed as either a ZIP or compressed TAR file with the following names: pivotal-tc-server-developer-version.release.tar.gz pivotal-tc-server-developer-version.release.zip Standard Edition The Standard Edition of tc Server is for administrators and operators. Similar to the Developer Edition, the Standard Edition contains the tc Runtime, scripts to easily create and start tc Runtime instances, and templates to quickly create specific types of tc Runtime instances (such as cluster-node ready or SSL-enabled). This edition provides you with access to Spring Insight Operations along with production open source support as noted on the Pivotal App Suite page. With the Standard Edition, you have access to the vcenter Hyperic management system. 1 Spring Insight Operations differs from Spring Insight Developer, which is included in the tc Server Developer Edition, in that it is designed to be used with Copyright Pivotal Software Inc, x

6 an in-production system. It allows you to view real-time behavior and health of your production applications. You can see application behavior across all servers and drill down to see specific servers. With Spring Insight Operations, you create one tc Runtime Instance using the Insight Dashboard template. This instance contains the Spring Insight user interface. You create production tc Runtime instances with the Insight Agent template. The Agent template adds the ability to collect traces from your web applications and forward them to the Dashboard instance. The Standard Edition is distributed as either a ZIP or compressed TAR file with the following names: pivotal-tc-server-standard-version.release.tar.gz pivotal-tc-server-standard-version.release.zip Pivotal tc Server Standard Edition is also available as an RPM for customers installing on Red Hat Enterprise Linux (RHEL). Easy Monitoring with the VMware vcenter Hyperic Agent Plug-In VMware vcenter Hyperic is a comprehensive enterprise application management tool. Two versions of the Hyperic Agent plugin are available: tc Runtime 8 Plugin Pivotal provides a new Hyperic Agent plugin for tc Runtime 8 to monitor your instances of Pivotal tc Server on any computer, all Spring-powered applications, and a variety of other platforms and application servers such as Apache Tomcat using VMware vcenter Hyperic Server. Hyperic provides a single console with powerful dashboards from which you can easily check the health of your applications. The capability to manage tc Server instances is not available. With Hyperic Server you can: Manage the lifecycle of tc Runtime instances by starting, stopping, and restarting local or remote instances. In addition to the preceding tc Runtime-related actions, Hyperic performs these standard tasks: Inventories the resources on your network. Monitors your resources. Alerts you to problems with resources. Controls the resources. tc Runtime 7 (version 2.9.x) Plugin The legacy version 2.9.x Hyperic Agent plugin for tc Runtime 7 is also supported. This plugin provides management and monitoring capability. With Hyperic Server, you can: Manage the lifecycle of tc Runtime instances by starting, stopping, and restarting local or remote instances. Similarly manage the lifecycle of a group of tc Runtime instances that are distributed over a network of computers. Configure a single instance of tc Runtime. Configuration options include the various port numbers to which the tc Runtime instance listens, JVM options such as heap size and enabling debugging, default server values for JSPs and static content, JDBC datasources, various tc Runtime connectors, and so on. Configure a group of tc Runtime instances using the tcsadmin command. Deploy a Web application from an accessible file system, either local or remote. You can deploy to both a single tc Runtime instance or to a predefined group of servers. Manage the lifecycle of applications deployed to a single tc Runtime instance or group of instances. Application lifecycle operations include start, stop, redeploy, undeploy, and reload. In addition to the preceding tc Runtime-related actions, Hyperic performs these standard tasks: Inventories the resources on your network. Monitors your resources. Alerts you to problems with resources. Controls the resources. Copyright Pivotal Software Inc, x

7 For detailed information on using the Hyper Agent plugin to manage your tc Server instances, see the VMware vcenter Hyperic documentation. Agile Application Development with Spring Insight Developer Spring Insight Developer, bundled with tc Server Developer Edition, makes it easy for application developers to observe the runtime behavior of Web applications. It allows you to see what is happening deep in the application, while it is running, with no required instrumentation. The visibility Spring Insight provides enables you to identify and solve problems quickly and to harden and tune the application by using readily available performance observations. Application Cluster Monitoring with Spring Insight Operations Spring Insight Operations enables administrators to monitor the real-time behavior and health of Web applications and the servers on which they are deployed. It gives the same deep visibility into applications as Spring Insight Developer, as well as the capability to view the information across a cluster or to drill down to any single server. Whereas Spring Insight Developer runs within a single tc Server instance alongside the Web applications it analyzes, Spring Insight Operations has a distributed architecture. A single, dedicated tc Server instance runs the Spring Insight Dashboard. Each tc Server instance hosting applications in your cluster runs the Spring Insight Agent application. The Agents collect trace data and submit it to the Dashboard, where the information is compiled and rendered. This design minimizes the overhead Spring Insight adds to your production servers and makes it easier to secure the Dashboard. Migrating Java EE Applications to tc Server If you have Java EE applications you would like to migrate from another runtime to tc Server, you can use the Spring Migration Analyzer command-line tool to generate migration analysis reports that contain information about the APIs the application uses, and any migration tasks that might be necessary to run the application on tc Runtime. You can download the Spring Migration Analyzer. Related Documentation Because tc Runtime is based on Apache Tomcat, much information about the tc Runtime itself is provided by Apache. See the following documentation: Apache Tomcat 8.5 Documentation Apache Tomcat 8.0 Documentation Apache Tomcat 7.0 Documentation Apache Tomcat FAQ The following links provide additional documentation for programmers who develop Web applications using the Spring Framework and standard Java EE technologies such as servlets and JSPs: Spring Framework Reference Manuals and Javadoc Java Servlet Technology JavaServer Pages (JSP) Technology 1 Only included when tc Server is purchased through VMware. Copyright Pivotal Software Inc, x

8 Installing Pivotal tc Server Installation options vary according to 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. Install tc Server Standard Edition From a ZIP or TAR File Prerequisites Verify that your system meets the supported configurations and installation requirements. See Supported Configurations and System Requirements. Review information about tc Server Standard edition and its *.zip or *.tar.gz distribution files. See tc Server Editions. If you are installing from a *.tar.gz on a Solaris, make sure to use GNUtar to unpack the archive. 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. Attention: 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 Pivotal tc Server download page. 2. Download the Standard Edition package distribution in ZIP or compressed TAR format to a directory on your computer, for example /home/downloads. pivotal-tc-server-standard-version.release.zip pivotal-tc-server-standard-version.release.tar.gz 3. Log in 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/pivotal. For example, on Unix: prompt$ mkdir /opt/pivotal 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/pivotal in the preceding step, and downloaded the Standard Edition ZIP file in the /home/downloads directory: prompt$ cd /opt/pivotal prompt$ unzip /home/downloads/pivotal-tc-server-standard release.zip This action creates a directory called pivotal-tc-server-standard-version 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 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 and starting tc Server components, see Creating and Managing tc Runtime Instances. Mac OS X - Install Pivotal tc Server Developer Edition Using Homebrew Copyright Pivotal Software Inc, x

9 You can install Pivotal tc Server Developer Edition on Mac OS X computers using Homebrew. Note: You may not be able to install the tc Server brew from inside a firewall. Install Pivotal tc Server Developer Edition Prerequisites Verify that your system meets the supported configurations described in Supported Configurations and System Requirements. Ensure that you have the latest brews. brew update Procedure 1. Log in to the Mac OS X computer on which you will install Pivotal tc Server. 2. Execute the following brew commands: brew tap pivotal/tap brew install tcserver What to do next 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 and starting tc Server components, see Creating and Managing tc Runtime Instances. Run the following command to create a new tc Server instance in the current directory: tcruntime-instance.sh create <instance_name> Run the following command to create a new tc Server instance with Spring Insight monitoring: tcruntime-instance.sh create -t insight <instance_name> Run the following command to start a tc Server instance in current directory: tcruntime-ctl.sh <instance_name> start RHEL - Install Pivotal tc Server Standard Edition from an RPM Pivotal recommends that you install Pivotal tc Server (Standard Edition) on a Red Hat Linux Enterprise (RHEL) computer by first installing the Pivotal RPM repository and then using yum to perform the actual installation. See Install Pivotal tc Server from the Pivotal RPM Repository. You can also download the RPM from the Pivotal download page and install it on your RHEL computer using the rpm command, as described in Install Pivotal tc Server from a Downloaded RPM. Install Pivotal tc Server from the Pivotal RPM Repository Pivotal recommends that you install tc Server on RHEL computers using the Pivotal RPM repository. Prerequisites Set the JAVA_HOME environment variable in the root user s environment. For example, you could add the following line to /etc/profile and then open a new terminal window: export JAVA_HOME=/usr/java/latest Replace /usr/java/latest with the base directory of your JVM installation. Copyright Pivotal Software Inc, x

10 Verify that your system meets the supported configurations and installation requirements. See Supported Configurations and System Requirements. Install the Pivotal repository RPM, which makes it easier for you to browse the Pivotal RPMs, including the Pivotal tc Server RPM. You install the Pivotal repository RPM on each RHEL computer on which you want to install one or more Pivotal products, such as Pivotal tc Server. 1. On the RHEL computer, start a terminal either as the root user or as an unprivileged user who has sudo privileges. 2. Install the Pivotal repository RPM using the following wget command, passing it the appropriate URL. Important: Run the entire wget command on a single line. Be sure you include the sh at the end, or the RPM installation fails. prompt# wget -q -O - sh Use sudo to run the preceding commands if you are not logged in as the root user. For example: prompt$ wget -q -O - sudo sh The command performs the following tasks: Imports the Pivotal GNU Privacy Guard (GPG) key. Installs the Pivotal repository RPM. Launches the Pivotal End User License Agreement (EULA) acceptance and repository configuration script. Outputs the EULA for you to read; you must answer yes to accept the terms and continue. 3. Use the yum search pivotal command to view the list of Pivotal components that you can install from the Pivotal repository. For example (output truncated for clarity): prompt# yum search pivotal... ======================================== Matched: pivotal ======================================== pivotal-rabbitmq-java-client-bin.noarch : The RabbitMQ Java Client Library pivotal-rabbitmq-server.x86_64 : The RabbitMQ server pivotal-tc-server-standard.noarch : Pivotal tc Server Standard pivotal-web-server.x86_64 : Pivotal Web Server... The Pivotal tc Server RPM is called pivotal-tc-server-standard. Procedure 1. From the RHEL computer on which you will install Pivotal tc Server, log in as the root user (or as an unprivileged user who has sudo privileges) and start a terminal. 2. Execute the following yum command: prompt# yum install pivotal-tc-server-standard The yum command begins the install process, resolves dependencies, and displays the packages it will install. If necessary, use sudo to run the preceding command if you are not logged in as the root user. For example: prompt$ sudo yum install pivotal-tc-server-standard 3. Enter y at the prompt to begin the actual installation. If the installation is successful, you see a Complete! message at the end. What the yum install command does The yum install command: Installs Pivotal tc Server into the /opt/pivotal/pivotal-tc-server-standard directory and sets the owner of the directory, along with all child directories and files, to root:pivotal. If the user does not already exist, adds a tcserver user (in the group pivotal ). Pivotal recommends that you create and run tc Server instances as this user. You cannot log in directly as the tcserver user. Rather, you must log in as the root user or as a privileged user using sudo, and then su - tcserver. Creates an empty directory called /var/opt/pivotal/pivotal-tc-server-standard and sets the owner to tcserver:pivotal. Pivotal recommends that you create new tc Server instances in this directory rather than the installation directory. You do this by specifying the -i Copyright Pivotal Software Inc, x

11 option of the tcruntime-instance command. What to do next 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 and starting tc Server components, see Creating and Managing tc Runtime Instances. Install Pivotal tc Server From a Downloaded RPM You can install Pivotal tc Server on RHEL by downloading the RPM from the Pivotal download center and executing the rpm command. Prerequisites Verify that your system meets the supported configurations and installation requirements. See Supported Configurations and System Requirements. Procedure 1. Log in to the RHEL computer on which you will install Pivotal tc Server as the root user (or as an unprivileged user who has sudo privileges). 2. From the Pivotal tc Server download page. 3. Download the tc Server Standard Edition RPM file to a directory on your computer. The RPM file is called pivotal-tc-server-standard-version-release.noarch.rpm. 4. Start a terminal and change to the directory in which you downloaded the RPM. 5. Execute the following rpm command to install tc Server: prompt# rpm -ivhf pivotal-tc-server-standard-version-release.noarch.rpm If necessary, use sudo to run the preceding command if you are not logged in as the root user. For example: prompt$ sudo rpm -ivhf pivotal-tc-server-standard-version-release.noarch.rpm 6. In the previous section, see What the yum install command does for post-installation information, such as the installation directory and the user that is automatically created by the RPM installation. (The yum install command corresponds to the rpm command in this procedure.) Install Hyperic Agent Plugin Two versions of the Hyperic Agent plugin are available: tc Runtime 8 Plugin 1. Download the Pivotal tc Server plugin from the Pivotal Network. 2. Rename the plugin file pivotal-tcserver-plugin.jar. 3. Install the plugin using the Hyperic Plugin Manager. For instructions, see Deploying and Managing Plug-ins in the VMware vcenter Hyperic documentation. tc Runtime 7 Plugin 1. Download the Pivotal tc Server plug-in 2.9.x for VMware Hyperic from Pivotal Network. Copyright Pivotal Software Inc, x

12 2. Complete the installation using the instructions found in the README file. The README is located inside the plugin zip archive. Install tc Server Developer Edition From a ZIP or TAR File When you install the Developer Edition of tc Server, you also typically 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 supported configurations and installation requirements. See Supported Configurations and System Requirements. Review information about tc Server Developer edition and its *.zip or *.tar.gz distribution files. See tc Server Editions. If you are installing from a *.tar.gz on a Solaris, make sure to use GNU tar to unpack the archive. 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. Attention: 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 Pivotal tc Server download page. 2. Download the Developer Edition distribution in ZIP or compressed TAR file format. pivotal-tc-server-developer-version.release.zip pivotal-tc-server-developer-version.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/pivotal. For example, on Unix: prompt$ mkdir /opt/pivotal 5. Extract the tc Server distribution file into the new directory. This action creates a directory called pivotal-tc-server-developer-version 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. 6. Create a tc Runtime instance that contains Spring Insight by specifying the insight template. Unix: Change to the /opt/pivotal/pivotal-tc-server-developer-version directory and execute the tcruntime-instance.sh script to create an instance. Pivotal 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/pivotal/pivotal-tc-server-developer release prompt$./tcruntime-instance.sh create -t insight -i /var/opt/pivotal/pivotal-tc-server-developer insight-instance Windows: Change to the \opt\pivotal\pivotal-tc-server-developer-version directory and execute the tcruntime-instance.bat script to create an instance: prompt> cd \opt\pivotal\pivotal-tc-server-developer release prompt> tcruntime-instance.bat create -t insight -i \var\opt\pivotal\pivotal-tc-server-developer insight-instance 7. Start the new tc Runtime instance. Unix: Execute the tcruntime-ctl.sh script to start the instance; use the -i option to specify the directory in which the instance is located. For example: Copyright Pivotal Software Inc, x

13 prompt$./tcruntime-ctl.sh insight-instance start -i /var/opt/pivotal/pivotal-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 -i option to specify the directory in which the instance is located: prompt> tcruntime-ctl.bat insight-instance install -i \var\opt\pivotal\pivotal-tc-server-developer prompt> tcruntime-ctl.bat insight-instance start -i \var\opt\pivotal\pivotal-tc-server-developer Note: On Windows, Pivotal 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 Pivotal tc Runtime instance - unique-name, where unique-name is a unique combination of server name and server directory. 8. After the tc Runtime instance starts, invoke Spring Insight in your browser: where host refers to the computer on which Spring Insight is running. If you are on the same computer, you can use localhost : 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. Overview of tc Server Directories, Variables, and Configuration Files When you install the tc Runtime component, you simply unpack the appropriate *.zip or *.tar.gz file into the main installation directory. This action creates a pivotal-tc-server-edition-version subdirectory, where edition-version refers to the edition of tc Server that you are using ( standard or developer ) and the version of tc Server. This subdirectory in turn contains the following tc Server-related files and directories: tomcat-*version* Where version is the version of the core Apache Tomcat on which this version of the tc Runtime is based, such as tomcat a.release or tomcat a.release. These directories are the basic Apache Tomcat CATALINA_HOME directory. Standard Apache Tomcat users recognize its contents. templates Out-of-the-box templates for creating customized tc Runtime instances, such as cluster-node enabled or SSL-ready. You can specify one or more of these templates when you run the tcruntime-instance.sh bat script to create a new tc Runtime instance. This is also the default location for custom template or template retrieved from the template repository. See Templates Provided by tc Runtime for the full list. lib JAR files that implement the templating mechanism and are used by the tcruntime-instance script. tcruntime-instance.sh bat Scripts for creating new tc Runtime instances. When you create a new tc Runtime instance with this script, the script creates the instance directory specified with the -i option or, by default, a subdirectory of the pivotal-tc-server-edition-version directory with the same name as the new tc Runtime instance. This new directory is the CATALINA_BASE of the tc Runtime instance. The new directory contains the instance-specific configuration files, its own Web application deployment directory, log files, and so on. tcruntime-ctl.sh bat Scripts for controlling tc Runtime instances, such as start and stop scripts. The bin directories of individual tc Runtime instances include their own versions of these scripts that in turn call these main scripts. You can also call the top-level scripts if you specify the name of the tc Runtime instance. tcruntime-admin.sh bat Scripts used to handle adminstrative functions like encoding value for properties, retrieving the latest or a specific tc Runtime version, and retrieving templates from the tc Server Template Repository. bash_completion. The bash_completion directory contains scripts to enable the bash completion capabilities for tcruntime-instance.sh, tcruntime-ctl.sh, and tcruntime-admin.sh. If you use a bash shell on a Unix-like system and you have the bash-completion package installed, you can use the Tab key to complete command arguments and suggest alternatives when using these tc Server scripts. See Enabling Bash Completion for tc Server Scripts for instructions on setting up this feature. tc Server Variables tc Server uses the following variables: CATALINA_HOME. Root directory of your tc Runtime installation. Copyright Pivotal Software Inc, x

14 The CATALINA_HOME variable points to the directory INSTALL_DIR/pivotal-tc-server-edition-version/tomcat-version, where INSTALL_DIR is the directory in which you installed tc Server (such as /opt/pivotal ); edition-version refers to the version and edition of tc Server you are using ( developer release or standard release); and version is the version of the underlying Tomcat, such as A.RELEASE. CATALINA_BASE. Root directory of a particular tc Runtime instance. This directory contains the instance-specific files, such as the conf/server.xml file that configures this particular instance. If you created a tc Runtime instance called myserver and you are using the Standard Edition, then the CATALINA_BASE of the instance is INSTALL_DIR/pivotal-tc-server-standardversion/myserver by default. The following variables are exposed by tc Runtime, which means that you can set them or use them in your environment (or in the bin/setenv.sh file of your tc Runtime instance) to achieve the specified results: CATALINA_OUT. Unix only. Use this environment variable to specify a file to which a tc Runtime instance writes stdout and stderr messages. If you do not set this environment variable explicitly, the tc Runtime instance writes stdout and stderr messages to the file CATALINA_BASE/logs/catalina.out. For example, to specify that the tc Runtime instance write its stdout and stderr messages to /opt/pivotal/tcserver/tcruntime-instance-6.log, set the variable in your environment or setenv.sh as follows: CATALINA_OUT=/opt/pivotal/tcserver/tcruntime-instance-6.log INSTANCE_NAME. Name of the tc Runtime instance. You can use this variable to create other unique variables within configuration scripts. For example, on Unix platforms you can update the bin/setenv.sh file to use the name of the tc Runtime instance when defining the CATALINA_OPTS variable as follows: CATALINA_OPTS="-Dinstance.name=$INSTANCE_NAME" On Windows, the equivalent change would be to the conf/wrapper.conf file as follows: set CATALINA_OPTS=-Dinstance.name=%INSTANCE_NAME% INSTANCE_BASE. Specifies the parent directory of the tc Runtime instance. The full pathname of the tc Runtime instance directory would be $INSTANCE_BASE/$INSTANCE_NAME. You can use the INSTANCE_BASE variable in the same way as the INSTANCE_NAME variable, as described in the preceding bullet. tc Runtime Instance Directory Structure After you create a new tc Runtime instance, its CATALINA_BASE directory contains the following subdirectories: bin. Contains the tcruntime-ctl.* scripts to start and stop tc Runtime instances, as well as the setenv.* scripts. The *.sh Unix files are functional duplicates of the *.bat Windows files. conf. Contains the configuration files for the tc Runtime instance, such as server.xml, catalina.properties, web.xml, context.xml, and so on. lib. Contains resources shared by all Web applications deployed to the tc Runtime instance. logs. Location of the logs files. webapps. Deployment directory for the Web applications deployed to the tc Runtime instance. work. Temporary work directory for all deployed Web applications. temp. Directory used by the JVM for temporary files. tc Runtime Instance Configuration Files You configure a particular tc Runtime instance by changing its configuration files. Other topics in this documentation describe how to do this. All the configuration files for a tc Runtime instance are located in its CATALINA_BASE/conf directory. The most important configuration files are as follows: server.xml. Main configuration file for a tc Runtime instance. It configures the behavior of the servlet/jsp container. By default, the server.xml file for a tc Runtime instance uses variable substitution for configuration properties that must be unique across multiple tc Runtime instances on the computer, such as HTTP and JMX port numbers. These variables take the form ${var}. For example, the variable for the HTTP port that the tc Runtime instance listens to is ${http.port}. The specific values for these variables for a particular tc Runtime instance are stored in the catalina.properties file, in the same directory as the server.xml file. catalina.properties. Properties file that contains the tc Runtime instance-specific values for variables in the server.xml file. context.xml. Configures the context that is loaded by all Web applications deployed to the tc Runtime instance. web.xml. Default web.xml file that is loaded by all deployed Web applications, in addition to their individual web.xml files. Copyright Pivotal Software Inc, x

15 wrapper.conf. Windows only. Configures the Java Service Wrapper from Tanuki Software used to install the tc Runtime instance as a Windows service. The Wrapper correctly handles user log outs under Windows, service dependencies, and the ability to run services that interact with the desktop. jmxremote.access and jmxremote.password. Configures the JMX users and passwords. The default JMX user, added at instance creation time unless you specify something different, is called admin with a password made up of a list of random characters. logging.properties. Configures the logging system of the tc Runtime instance. Enabling Bash Completion for tc Server Scripts If you use the bash shell on a Unix-like system and you have the bash-completion package installed, you can enable completion support for the tc Server tcruntime-instance.sh, tcruntime-ctl.sh, tcruntime-admin.sh scripts. When enabled, you can press the Tab key after entering a few letters of a command argument and either the argument is completed for you or possible alternatives are suggested. Bash completion is enabled by linking the bash completion scripts supplied with tc Server into the bash_completion.d directory on your system. See Bash Completion for usage instructions. Prerequisites You must be using the bash shell on a Unix-like system and have the bash-completion package installed and enabled. Know the location of the bash_completion.d directory on your system, usually /etc/bash_completion.d. You need superuser access to install the scripts. Either log in as root, or use su or sudo to temporarily become root. Procedure 1. As the superuser, create symbolic links for the tc Server bash completion scripts in the bash_completion.d directory, using a command like the following: prompt# ln -s /opt/pivotal/tcserver/pivotal-tc-server-standard release/bash_completion/* /etc/bash_completion.d Replace /etc/bash_completion.d with the path to the bash_completion.d directory on your system, if it differs. 2. With your regular user login, start a new bash shell or re-source your environment to allow the bash_completion script to recognize the new tc Server scripts. Setting Up Unix Users for tc Server and VMware vcenter Hyperic On Unix-like systems, the interaction between VMware vcenter Hyperic and tc Server is straightforward as long as tc Runtime instances and the Hyperic Agent run as the same user. You can run Hyperic Agent and tc Runtime instances with different user IDs. You might do this for increased security, or because the Hyperic Agent needs to run as a privileged user to manage some other resource on the computer, or perhaps you want to run different tc Runtime instances as different users to take advantage of process accounting. The Hyperic tc Server plug-in detects the user and group running the tc Server process and records them in parameters in the Hyperic Server resource created for the instance. If the user is different from the user running Hyperic Agent, the plug-in uses su or sudo to set the user whenever you start, restart, or stop a tc Runtime instance or change the tc Runtime instance s configuration through Hyperic. Both Hyperic Agent and tc Runtime instances should run as regular, non-root users. Never run a tc Server instance as root. If you use different non-root users to run tc Server instances and Hyperic Agent, you must create them in the same primary group. This is necessary to allow Hyperic Agent to read files written by the tc Runtime instance. Subtopics Creating Users and Groups for Hyperic and tc Server Copyright Pivotal Software Inc, x

16 Setting the tc Server User in Hyperic Enabling Hyperic Agent Access to su or sudo Creating Users and Groups for Hyperic Agent and tc Server When you run Hyperic Agent and tc Runtime instances with different users, they must be in the same primary group to allow them to share files. For better security, you can create a separate group for them. The following procedure shows how to create a group and add users to it for tc Server and Hyperic Agent on Red Hat Linux. The exact commands may be different on other operating systems. Procedure 1. Log in as root and start a terminal session. 2. Use the groupadd command to create a new group. The following example creates a pivotal group: prompt$ groupadd pivotal Note that if you installed from RPM on RHEL, the pivotal group may already exist. 3. Use the useradd command to create a user for Hyperic Agent in the group you created in the previous step. The following example creates a hyperic user in the pivotal group: prompt$ useradd hyperic -g pivotal You can include the -M option to prevent creating a home directory for the user and the -s /sbin/nologin option to prevent anyone from logging in as the hyperic user. Install and run Hyperic Agent as this user. 4. Use the useradd command to create a user to run tc Server instances. The following example creates a tcserver user in the pivotal group: prompt$ useradd tcserver -g pivotal You can include the -M option to prevent creating a home directory for the user and the -s /sbin/nologin option to prevent anyone from logging in as the tcserver user. Create the tc Server instance and run it as this user. 5. If you want to run multiple tc Runtime instances under separate user accounts on the same computer, repeat the previous step to create additional tc Server users. Setting the tc Server User in Hyperic Hyperic uses auto-discovery to detect tc Runtime instances. The first time it discovers an instance, it records the user and group running the process. Therefore, the usual method to set the tc Server user is to create the instance and run it as the desired user, allowing Hyperic Agent to discover the instance. If you are migrating to a new Hyperic release and you have existing tc Runtime instances detected by an earlier version of Hyperic, the user and group parameters are blank. The first time auto-discovery runs, the instances will show up as modified in the auto-discovery queue. When you accept the modified resources, the user and group are recorded. If you decide to change the tc Server user for an instance previously created with a different user, be sure to chown all the files in the tc Runtime instance directory and ensure they are readable and writable by the new user. Then start the instance as the new user and trigger auto-detect in Hyperic to record the new user in the Hyperic resource record. Enabling Hyperic Agent Access to su or sudo Hyperic Agent uses the su or sudo command to execute tasks as the tc Server user. Specifically, if Hyperic Agent is running as root, it uses /bin/su to change to the desired user to perform the task. If running as a non-root user, Hyperic Agent instead uses /bin/sudo to do the work as the tc Server user. Copyright Pivotal Software Inc, x

17 There are some prerequisites you must verify to ensure that Hyperic can use su or sudo, described below. If Hyperic Agent is running as root If Hyperic Agent is running as root, it will use su to execute tasks as the tc Server user. You must ensure that /bin/su exists. If not, create a link to it. For example, if su is in /sbin, but not /bin, create a link as follows: prompt$ sudo ln -s /sbin/su /bin/su If Hyperic Agent is running as a non-root user If Hyperic Agent is running as a non-root user, it will use sudo to execute tasks as the tc Server user. You must ensure that /usr/bin/sudo exists and also grant required permissions to the tc Server user in the /etc/sudoers file. For example, if sudo is in /usr/sbin/, but not /bin, create a link as follows: prompt$ sudo ln -s /usr/sbin/sudo /bin/sudo The user running Hyperic Agent needs permission to run the tcruntime-ctl.sh script as the tc Server user without having to enter a password. This is accomplished by editing the /etc/sudoers file as root and adding an entry. For example, if Hyperic Agent is running as user hyperic, tc Server runtime instances are running as user tcserver, and the tcruntime-ctl.sh script is in /opt/pivotal/pivotal-tc-server-standard release/tcruntime-ctl.sh, you would add the following entry to /etc/sudoers : hyperic ALL=(tcserver) NOPASSWD: /opt/pivotal/pivotal-tc-server-standard release/tcruntime-ctl.sh Uninstalling tc Server - Typical Steps You can uninstall one or more of the following components: tc Runtime Hyperic Agent Uninstallation of tc Server mostly entails removing the directories that contain the component files, although a few extra steps might be required, as described below. Each section covers both Unix and Windows commands. The documentation uses Unix-like forward slashes (/) for directories; if you are on a Windows platform, change these to back slashes (\). Warning: The procedures in this section describe how to completely remove the components of tc Server from your computer. Uninstalling tc Runtime The following procedure describes how to uninstall the tc Runtime and all its associated instances. 1. If currently running, stop all tc Runtime instances. See Starting and Stopping tc Runtime Instances. 2. Start a terminal window (Unix) or Command Prompt (Windows). 3. Windows only. If you installed any tc Runtime instances as Windows services, change to the CATALINA_BASE\bin directory of each instance (such as \var\opt\pivotal\pivotal-tc-server-standard\myserver\bin ) and uninstall the service using the following command: prompt> \var\opt\pivotal\pivotal-tc-server-standard\myserver\bin prompt> tcruntime-ctl.bat uninstall 4. Remove the main tc Server installation directory. For example, if you installed Standard Edition, the delete command might look something like the following: Copyright Pivotal Software Inc, x

18 prompt$ rm -rf /opt/pivotal/pivotal-tc-server-standard By default, the home directory of all tc Runtime instances is under the main tc Server installation directory; if you used this default location when you created the tc Runtime instances with the tcruntime-instance script, then the preceding delete command also deleted all tc Runtime instances. 5. If you created any tc Runtime instances in locations other than the default tc Server installation directory, remove their corresponding home directories. Uninstalling Hyperic Agent To uninstall the Hyperic Agent component of tc Server: 1. If the agent itself is managed by Hyperic, remove the platform for the agent using the Hyperic user interface. 2. Start a terminal window (Unix) or Command Prompt (Windows). 3. Remove the directory in which you installed the Hyperic Agent. For example: prompt$ cd /opt/vmware/hyperic prompt$ rm -rf <version> Copyright Pivotal Software Inc, x

19 Creating and Managing tc Runtime Instances After you install Pivotal tc Server components on all relevant computers, you perform some or all of the following post-installation tasks, depending on the edition of tc Server. (As a performance-monitoring alternative to VMware vcenter Hyperic, you can install and configure Spring Insight. See the Spring Insight Operations documentation.) Create and Modify a tc Runtime Instance Manually The following sections describe how to create new instances of tc Runtime and provide related information: Create tc Runtime Instances with the tcruntime-instance Command Script tcruntime-instance.sh Reference Create Evaluation Instances with the createinstance Script Pin tc Runtime Instances to a Specific Version Best Practice: Naming tc Runtime Instances Differences Between the Separate and Combined Layouts Using the tc Runtime Templates Templates Provided by tc Runtime Additional Information About Using the SSL Templates The procedural topics cover both Unix and Windows commands. The documentation uses Unix-like forward slashes (/) for directories; if you are on a Windows platform, change these to back slashes (\). Creating tc Runtime Instances with the tcruntime-instance Command Script This section describes the simplest way to use the tcruntime-instance command script to create a new tc Runtime instance. For an explanation of the type of instance that the example creates, see the description following the procedure. 1. On the computer on which you installed tc Server, log in as the user who will run tc Runtime instances, such as tcserver. On Unix, if you have disabled interactive login, log in as the root user and use su - tcserver to become the user. 2. Be sure you have installed a JDK or JRE and have set your JAVA_HOME and PATH environment variables correctly. See Software Requirement: Install JDK or JRE. 3. Open a terminal window (Unix) or Command Prompt (Windows). 4. Change to the INSTALL_DIR/pivotal-tc-server-edition -release directory, where INSTALL_DIR refers to the main tc Server installation directory, such as /opt/pivotal, edition refers to the edition of tc Server you are using ( developer or standard.), and release is the release specifier For example: prompt$ cd /opt/pivotal/pivotal-tc-server-standard release 5. Run the tcruntime-instance.sh (Unix) or tcruntime-instance.bat (Windows) script, passing it the create servername option. Replace servername with the name of your new tc Runtime instance. See Best Practice: Naming tc Runtime Instances for tips on naming an instance. Pivotal 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 appropriate user (such as tcserver ) can write to this directory and that the directory already exists. For example, on Unix: prompt$./tcruntime-instance.sh create -i /var/opt/pivotal/pivotal-tc-server-standard myserver On Windows: prompt> tcruntime-instance.bat create -i \var\opt\pivotal\pivotal-tc-server-standard myserver When the preceding sample command completes, the new tc Runtime instance is located in the /var/opt/pivotal/pivotal-tc-server-standard/myserver directory This directory is also the value of the CATALINA_BASE variable for this tc Runtime instance. By default, the tc Runtime instance uses either the Java binaries pointed to by your JAVA_HOME environment variable or the java binary that it found Copyright Pivotal Software Inc, x

20 in the PATH environment variable when it started. You can hard-code Java binaries that the tc Runtime instance uses by using the --java-home option. The ports of the tc Runtime instance are the default values: HTTP listen port: 8080 JMX port: 6969 AJP port: 8009 Shutdown port: -1 The preceding tcruntime-instance sample did not specify the --version option, so the instance is pinned to the highest version (based on the preferred major version in tc Server) tc Runtime version located in the installation directory, for example A.RELEASE. You can use the modify-version verb to change the version to which the instance is pinned. See Pinning tc Runtime Instances to a Specific Version for more information. When you use the tcruntime-instance.sh bat command script to create an instance, you can specify additional optional parameters, as described in tcruntime-instance.sh Reference. For example, you can use the --property option to specify the Unix runtime user for the tc Runtime instance. tcruntime-instance.sh Reference You can use the tcruntime-instance command script to create, modify, and upgrade a tc Runtime instance; list existing instances; and display help for the command script. Each command has its own set of options, as described in the tables in this section. Depending on the command, you must specify the name of a tc Runtime instance. The general syntax for each of the commands follows; click on the link to see the options for that particular command: tcruntime-instance create [options] instance-name tcruntime-instance create instance-property-file tcruntime-instance apply-template [options] instance-name tcruntime-instance modify-version [options] instance-name tcruntime-instance upgrade [options] instance-name tcruntime-instance list [options] tcruntime-instance help [command-name] create Command Use the create command to create a new tc Runtime instance. The create command accepts a number of options for customizing the instance. You can specify these options at the command line or list the options in a file and specify the name of the file after the create command. When you create a new instance, and you do not specify the --template option to apply one or more specific templates, the tcruntime-instance script creates a basic tc Runtime instance that uses the default template (called nio ); this template adds the Non-blocking IO (NIO) HTTP Connector to the server.xml of the instance. To configure different or additional features using the templates, such as the NIO Connector, clustering, or SSL, use the --template option to specify the appropriate template; you must use the option for each template you want to apply. Pivotal recommends that you use the --instance-directory 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 appropriate user (such as tcserver ) can write to this directory and that the directory already exists. Examples of creating new tc Runtime instances are shown after the options reference table. The following table lists options for the create command of tcruntime-instance.sh bat. When specifying the most common options, you can use either the short form (such as -i ) or the long form (such as --instance-directory ); less common options support only the long form. You can also specify these options in a file and pass the name of the file as a parameter to the create command; see the examples. Table 1. Options of the create Command Forces the script to create a new tc Runtime instance, even if one already exists. By default the script does not force the creation. If you specify this parameter and a tc Runtime instance with the name already exists, the script replaces only the existing bin and conf directories; the script does not replace the other Copyright Pivotal Software Inc, x

21 --force N/A directories, such as lib or temp. It is assumed in this case that you do not want to touch the user-specific files, such as Web applications. To update the tc Runtime version used by an instance, use the modify-version command, not the --force option. --help -h Outputs usage information about the create command usage. --interactive N/A Tells the script to interactively ask for configuration properties. For example, use this parameter if you want to change the default port numbers, as listed in [Creating tc Runtime Instances: Typical Steps](#postinstall-createspringsource-instance). Also use this parameter to change the default SSL configuration values when using the -t option to specify an SSL template, such -t nio-ssl. Warning: Be sure that all tc Runtime instances on the same computer have unique port numbers. --instance-directory instancedir -i instancedir Replace instancedir with the full or relative pathname of the directory in which you want the new tc Runtime instance to be created. If you specify a relative directory pathname, the directory is relative to the directory from which you are running the tcruntime-instance.sh bat script. The default value of this option is the current working directory. --java-home path_to_jre N/A Hard-codes the directory specified by path_to_jre into various files of the instance, such as the bin/setenv.sh bat file. Replace path_to_jre with the full pathname of the JRE or JDK. If you do not specify this option, then the instance hard-codes the value of the JAVA_HOME global environment variable. Specifies the type of layout you want your new tc Runtime instance to use: separate or combined. The default value is separate. --layout layout N/A In the separate layout, CATALINA_HOME and CATALINA_BASE point to different directories; in the combined layout they point to the same directory, which means that the tc Runtime binaries are bundled within your instance. The combined is the standard Apache Tomcat layout. Warning: Pivotal recommends that you always use the separate layout, which is why it is the default value if you do not specify this option. For additional information, see [Differences Between the Separate and Combined Layouts] (#postinstall-create-instance-layout). Specifies the name of a properties file that Copyright Pivotal Software Inc, x

22 contains configuration properties that you want to apply to the new tc Runtime instance. --properties-file file -f file When you create the properties file, it should contain one property per line, in the form template-name.property-name=value. The name of the property depends on the template. For example, the default template (called nio ) has two configuration properties: http.port and https.port. Other templates might specify their own configuration properties. If you want to pass your own values of these properties to the tcruntime-instance script at the command line, rather than the instance taking the default values, create a file such as the following: nio.http.port=9090 nio.https.port=9191 Then point to this configuration property file using this option: --properties-file my-property-file See the configuration-prompt.properties file in the INSTALL_DIR/pivotal-tc-server-editionrelease/templates/template-name directory for the list of configuration properties that apply to a particular template. Specifies a single configuration property that you want to apply to the new tc Runtime instance. -p template-name.property-name=value When you create a tc Runtime instance, the tcruntime-instance script always applies a template, even if it is the default one (called nio ). Templates usually have configuration properties. For example, the nio template has two configuration properties: http.port and https.port. Other templates might specify their own configuration properties. If you want to pass your own values of these properties to the tcruntime-instance script at the command line, rather than the instance taking the default values, use this option to specify the property in the form template-name.property-name=value. For example, to specify that the HTTP port for a new tc Runtime instance that uses the default template is 9090, specify the property as follows: --property nio.http.port=9090 See the configuration-prompt.properties file in the --property template-name.propertyname=value INSTALL_DIR/pivotal-tc-server-editionrelease/templates/template-name directory for the list of configuration properties that apply to a particular template. Applies a template to a newly-created tc Runtime instance. You can specify this option multiple times to apply multiple templates to the instance. Copyright Pivotal Software Inc, x

23 In this context, a tc Runtime template refers to a set of customized tc Runtime files that the tcruntime-instance script copies to or merges with the instance it just created. --template template_name -t template_name Replace the template_name argument with the name of an existing subdirectory of the INSTALL_DIR/pivotal-tc-server-edition/templates directory, where edition refers to the Edition of tc Server you are using ( developer or standard.) An example of an existing template is apr-ssl or cluster-node. If you use this option to specify one or more templates that do not add a <Connector> element to the server.xml configuration file, the tcruntime-instance script automatically adds a Non-blocking IO (NIO) HTTP Connector to the instance. If your templates include a <Connector> element, then the script does not add a NIO Connector. For additional details and examples about using templates, see [Using the tc Runtime Templates] (#postinstall-creating-instance-usingtemplates). Pins the instance to the specified version of tc Runtime, such as A.RELEASE. Valid values depend on the versions of tc Runtime that you have installed. The tcruntime-instance.sh script determines the list of available versions by searching for INSTALL_DIR/tomcat-XXX directories, where XXX follows a pattern such as A.RELEASE. You can check for these directories to determine the versions to which you can pin a tc Runtime instance. --version version -v version If you do not specify this option, the instance is pinned to the highest version of tc Runtime it can find (based on the preferred major version in tc Server). The preferred major version is the recommended version in tc Server and not necessarily the highest (i.e. tc Runtime 7 or tc Runime 8). The preferred major for 3.0.x and 3.1.x is set to tc Runtime 7. So, if version is not specified it will pick the highest 7.0.x version available. For example, if A.RELEASE, B.RELEASE, A.RELEASE, and B.RELEASE are all present, and you don t specify this option, then the script automatically chooses A.RELEASE as the version of the instance. See [Pinning a tc Runtime Instance to a Specific Version](#postinstall-pinned-instances) for more information. The following example shows how to be prompted interactively for configuration properties (such as port numbers) and that you want the new tc Runtime instance to be located in the /var/opt/pivotal/pivotal-tc-server-standard directory: prompt$./tcruntime-instance.sh create -i /var/opt/pivotal/pivotal-tc-server-standard --interactive myserver Copyright Pivotal Software Inc, x

24 The following example shows how to pin a new instance to version A.RELEASE of tc Runtime and to specify a hard-coded value for JAVA_HOME: prompt$./tcruntime-instance.sh create -i /var/opt/pivotal/pivotal-tc-server-standard \ --version A.RELEASE --java-home /var/opt/java/jdk1.7.0_42 myserver The following example shows how to pass the value 9090 to the http.port configuration property of the default template (called nio ), rather than use the default value of 8080 : prompt$./tcruntime-instance.sh create --property nio.http.port=9090 \ -i /var/opt/pivotal/pivotal-tc-server-standard myserver Creating an Instance From a File You can also specify most of the options in the previous table in a file and pass the file to the create command if you prefer not to specify the commands at the command-line. The following shows an example of such a file: instance-name=myserver force=true instance-directory=/var/opt/pivotal/pivotal-tc-server-standard java-home=/var/opt/java/jdk1.7.0_42 version= b.release layout=combined template.1=nio template.2=nio-ssl template.3=async-logger property.1=nio.http.port=9090 property.2=nio.https.port=9191 You can specify multiple templates or properties by using the form template.number or property.number. If you include multiple templates, they are applied in the specified order. Assume that the preceding file is called /var/opt/pivotal/properties/my-instance.txt, then you would create an instance with these properties using the following command: prompt$./tcruntime-instance.sh create /var/opt/pivotal/properties/my-instance.txt The apply-template Command Use the apply-template command to apply a new template to an existing tc Runtime instance. For example, assume you created and are using a tc Runtime instance to which you originally applied only the default template. You now want to start using the Elastic Memory for Java (EM4J) feature to optimize Java memory utilization on the instance while you run it on VMware ESXi. The EM4J feature is enabled through the elastic-memory template, so you use the apply-template command of the tcruntime-instance.sh script to apply the new template, elastic-memory, to the existing instance. Refer to the README.txt file in the instance directory for the list of templates that have already been applied to the instance. For a list and description of all templates, see Templates Provided by tc Runtime. By default, you cannot apply the same template twice to an instance. You can override this default behavior by specifying the --override-duplicate-template option. The next table lists options for the apply-template command of tcruntime-instance.sh bat. Following the table is an example that applies a new template to an existing tc Runtime instance. With most options, you can use either the short form (such as -i ) or the long form (such as --instance-directory ). Table 2. Options of the apply-template Command --help -h Outputs usage information for apply-template. --interactive N/A Tells the script to interactively ask for templatespecific configuration properties. For example, use this parameter if you are applying a nio-ssl template and want to interactively Copyright Pivotal Software Inc, x

25 --instance-directory instancedir -i instancedir change the default SSL configuration values. If the tc Runtime instance to which you are applying a new template is not in the default location (current working directory), use this option to specify the full or relative pathname of the directory of the instance. If you specify a relative directory pathname, the directory is relative to the directory from which you are running the tcruntime-instance.sh bat script. The default value of this option is the current working directory. --override-duplicate-template N/A Allows you to apply the same template to an instance multiple times. Specifies the name of a properties file that contains template-specific configuration properties that you want to apply to the existing tc Runtime instance. --properties-file file -f file When you create the properties file, it should contain one property per line, in the form template-name.property-name=value. The name of the property depends on the template. For example, the default template (called nio ) has two configuration properties: http.port and https.port. Other templates might specify their own configuration properties. If you want to pass your own values of these properties to the tcruntime-instance script at the command line, rather than the instance taking the default values, create a file such as the following: nio.http.port=9090 nio.https.port=9191 Then point to this configuration property file using this option: --properties-file my-property-file For the list of configuration properties that apply to a particular template, see the configuration-prompt.properties file in the INSTALL_DIR/pivotal-tc-server-editionrelease/templates/template-name directory. Specifies a single configuration property that you want to apply to the existing tc Runtime instance. When you create a tc Runtime instance, the tcruntime-instance script always applies a template, even if it is the default one (called nio ). Templates usually have configuration properties. For example, the nio template has two configuration properties: http.port and https.port. Other templates might specify their own configuration properties. If you want to pass your own values of these properties to the tcruntime-instance script at the command line, rather than the instance taking the default Copyright Pivotal Software Inc, x

26 -p template-name.property-name=value values, use this option to specify the property in the form template-name.property-name=value. For example, to specify that the HTTP port for a new tc Runtime instance that uses the default template is 9090, specify the property as follows: --property nio.http.port=9090 For the list of configuration properties that apply to a particular template, see the configuration-prompt.properties file in the --property template-name.propertyname=value INSTALL_DIR/pivotal-tc-server-editionrelease/templates/template-name directory.. Specifies the template you want to apply to the existing tc Runtime instance. In this context, a tc Runtime template refers to a set of customized tc Runtime files that the tcruntime-instance script copies to or merges with the instance it just created. --template template_name -t template_name Replace the template_name argument with the name of an existing subdirectory of the INSTALL_DIR/pivotal-tc-server-edition/templates directory, where edition refers to the Edition of tc Server you are using ( developer or standard.) An example of an existing template is apr-ssl or cluster-node. You can specify this option only once. If you want to apply multiple new templates to an existing tc Runtime instance, you must run the tcruntime-instance script multiple times. For additional details and examples about using templates, see [Using the tc Runtime Templates] (#postinstall-creating-instance-usingtemplates). The following example shows how to apply the diagnostics template to an existing tc Runtime instance call myserver that is located in the /var/opt/pivotal/pivotal-tc-standard directory: prompt$./tcruntime-instance.sh apply-template -i /var/opt/pivotal/pivotal-tc-server-standard -t diagnostics myserver The modify-version Command Use the modify-version command to modify the version of tc Runtime used by an existing instance that is pinned to a particular version of tc Runtime. You cannot use this command to modify an instance so it uses a different major release of tc Runtime, or in other words, from tc Runtime version 7.0.X to 8.0.X. You can use it only to modify the version within a certain major release, such as A to A. Use the --version option to specify the new version of the instance. If you do not specify --version, the resulting instance is pinned to the latest available version of tc Runtime. See Pinning tc Runtime Instances to a Version. Note: It is assumed that you have already installed the tc Runtime version for which you want to modify the existing instance. Examples of modifying existing tc Runtime instances are shown after the options reference table. The following table list options for the modify-version command of tcruntime-instance.sh bat. When specifying the options, you can use either the short form (such as -i ) or the long form (such as --instance-directory ). Copyright Pivotal Software Inc, x

27 Table 3. Options of the modify-version Command Pins the instance to the specified version of tc Runtime, such as A.RELEASE. Valid values depend on the versions of tc Runtime that you have installed. The tcruntime-instance.sh script determines the list of available versions by searching for INSTALL_DIR/tomcat-XXX directories, where XXX follows a pattern such as A.RELEASE. You can check for these directories to determine the versions to which you can pin a tc Runtime instance. --version version -v version If you do not specify this option, the instance is pinned to the highest version of tc Runtime it can find (based on the preferred major version in tc Server). The preferred major version is the recommended version in tc Server and not necessarily the highest (i.e. tc Runtime 7 or tc Runime 8). The preferred major for 3.0.x and 3.1.x is set to tc Runtime 7. So, if version is not specified it will pick the highest 7.0.x version available. For example, if A.RELEASE, B.RELEASE, A.RELEASE, and B.RELEASE are all present, and you don t specify this option, then the start script automatically chooses A.RELEASE as the version of the instance. See [Pinning a tc Runtime Instance to a Specific Version] (#postinstall-pinned-instances) for more information. --instance-directory instancedir -i instancedir Replace instancedir with the full or relative pathname of the directory that contains the tc Runtime instance you want to modify. If you specify a relative directory pathname, the directory is relative to the directory from which you are running the tcruntime-instance.sh bat script. The default value of this option is the current working directory. --help -h Outputs usage information about the modify-version command usage. The following example shows how to modify an existing tc Runtime instance called myotherserver to use version A.RELEASE of tc Runtime; the resulting instance will be pinned to this version: prompt$./tcruntime-instance.sh modify-version --version A.RELEASE \ -i /var/opt/pivotal/pivotal-tc-server-instances myotherserver In the preceding example, the myotherserver is located in the /var/opt/pivotal/pivotal-tc-server-instances directory. The upgrade Command Use the upgrade command to upgrade an instance to a new version of tc Server. The upgrade command copies the existing instance to a new instance directory and updates the files and descriptors in the instance. The difference between the upgrade command and the modify-version command is that the upgrade command upgrades the tc Server scripts and other tc Server files to a newer version, and the modify-version command changes the tc Runtime version to a tc Runtime based on a different Apache Tomcat Copyright Pivotal Software Inc, x

28 release. The usual procedure for using the upgrade command is to: 1. Install the new tc Server release in a directory alongside the existing tc Server installation. 2. Execute the upgrade command from the new tc Server installation directory, specifying the instance to be upgraded in the old tc Server instance directory. This results in a new tc Runtime instance in the new tc Server installation directory. When all instances have been upgraded, restarted, and verified, the old tc Server instance directory can be removed. Before you use the upgrade command: If the instance to be upgraded is running, stop it. For example, execute the following command in the tc Server Installation directory: prompt$ tcruntime-ctl.bat myinstance stop If the instance to be upgraded is installed as a Windows service, uninstall it. For example: prompt$ tcruntime-ctl.bat myinstance uninstall After running the upgrade command, install the new instance as a Windows service (if on Windows) and then start the new instance. If you have linked the CATALINA_HOME/bin/init.d.sh script to /etc/init.d on a UNIX system, unlink the script before upgrading and then re-link the script in the new instance directory after the upgrade is complete. Table 4. Options of the upgrade Command --instance-directory instancedir -i instancedir Replace instancedir with the full or relative pathname of the directory where the upgraded instance is to be created. If you specify a relative pathname, the directory is relative to the directory where you run the tcruntime-instance.sh bat script. The default value of this option is the current working directory. --version version -v version Specifies the tc Runtime version to use for the upgraded instance. This option is required when upgrading an unpinned instance or to prevent the instance from being upgraded to the most recent release. If omitted, the most recent available version of the existing major release is used; if the instance is currently using tc Runtime 7, it is upgraded to use the highest tc Runtime 7 version in the tc Server installation directory. Valid values for version depend on the versions of tc Runtime that you have installed. The tcruntime-instance.sh script determines the list of available versions by searching for INSTALL_DIR/tomcat-XXX directories, where XXX follows a pattern such as A.RELEASE. You can check for these directories to determine which versions to which you can pin a tc Runtime instance. --help -h Displays usage information for the upgrade command. The following example upgrades the instance at /opt/pivotal/pivotal-tc-server-standard/myinstance to a new instance at Copyright Pivotal Software Inc, x

29 /opt/pivotal/pivotal-tc-server-standard-new/myinstance. The upgraded instance will use tc Runtime release A.RELEASE. The command is executed in the /opt/pivotal/pivotal-tc-server-standard-new directory: prompt$ /opt/pivotal-tc-server-standard-new/tcruntime-instance.sh upgrade -v A.RELEASE -i /var/opt/pivotal/new-instances/ /var/opt/pivotal/instances/myinstance The list Command Use the list command to list the known tc Runtime instances. For each instance, the command outputs the runtime version, its base directory, and its status. The following table lists options for the list command of tcruntime-instance.sh bat. When specifying the options, you can use either the short form (such as -i ) or the long form (such as --instance-directory ) Table 5. Options of the list Command --instance-directory instancedir -i instancedir Replace instancedir with the full or relative pathname of the directory that contains the tc Runtime instances for which you want a listing. If you specify a relative directory pathname, the directory is relative to the directory from which you are running the tcruntime-instance.sh bat script. The default value of this option is the current working directory. --help -h Outputs usage information about the list command usage. The following example shows how to list known instances in the tc Server installation directory. There is one instance, myinstance, in this example. prompt$./tcruntime-instance.sh list -i /var/opt/pivotal/pivotal-tc-server-standard Listing instances in '/var/opt/pivotal/pivotal-tc-server-standard' myinstance Info: Instance name: myinstance Runtime version: A.RELEASE tc Runtime Base: /var/opt/pivotal/pivotal-tc-server-standard/myinstance Status: NOT RUNNING Getting Help for tcruntime-instance To view a summary of all available commands of the tcruntime-instance script, use the help command: prompt$./tcruntime-instance.sh help To view the usage information about a particular command, specify the name of the command after the help command: prompt$./tcruntime-instance.sh help create The output includes brief information about the available options. You can also use the --help option of the commands to view the same information: prompt$./tcruntime-instance.sh create -h prompt$./tcruntime-instance.sh create --help Create Evaluation Instances with the createinstance Script Use the quickstart/createinstance.sh bat interactive script to quickly create a simple SSL-enabled tc Runtime instance. The script prompts you for all the Copyright Pivotal Software Inc, x

30 information it needs. Note: The createinstance script is meant for users who want to quickly create a simple tc Runtime instance for evaluation purposes. You should use the tcruntime-instance script to create instances for production use. The createinstance.sh bat script uses the following two tc Server templates when it creates the instance: nio : Configures a Non-blocking IO (NIO) HTTP Connector. nio-ssl : Configures a Non-blocking IO (NIO) HTTPS Connector. If you want to create an instance using different templates, use the tcruntime-instance.sh bat script, as described in Creating tc Runtime Instances with the tcruntime-instance Command Script. Prerequisites The createinstance script automatically discovers a Java installation. If, however, you want to use a specific version of Java, then you must set the JAVA_HOME variable in your environment appropriately and update your PATH to include JAVA_HOME/bin. Procedure 1. On the computer on which you installed tc Server, log in as the user who will run tc Runtime instances, 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 window (Unix) or Command Prompt (Windows). 3. Change to the INSTALL_DIR/quickstart directory, where INSTALL_DIR refers to the main tc Server installation directory, and execute the createinstance.sh script ( createinstance.bat on Window.) For example, on Unix: prompt$ cd /opt/pivotal/pivotal-tc-server-standard release/quickstart prompt$./createinstance.sh The script prompts you for information such as the home directory and name of the tc Runtime instance; whether to immediately start it; and the HTTP, HTTPS, and JMX ports to which the tc Runtime instance will listen. Pivotal recommends that you specify an instance directory different from the tc Server installation directory, such as /var/opt/pivotal/pivotal-tc-server-standard. The script also asks whether you want to generate a new keystore or whether you want to use an existing one. If you specify the former, the script prompts your for additional information about the key and keystore, such as the size of the SSL private key, the passwords of the private key and keystore itself, the location of the keystore, and identification data for the SSL certificate. After the script finishes prompting for information, it starts the instance (if you answered Yes to the prompt to immediately start it) and then exits. 4. If you answered Yes to the prompt to start the tc Runtime instance, confirm that the instance is running by invoking its Welcome page in a browser. Use the URL where host is the name or IP address of the computer on which the tc Runtime instance is running ( localhost if local) and port is the HTTP port you specified (default 8080 ). For example: If you answered No to the prompt to start the instance, execute the tcruntime-ctl.sh bat command, specifying the name and location of the instance. For example, if you named the instance myserver and specified its instance directory /var/opt/pivotal/pivotal-tc-server-standard : prompt$./tcruntime-ctl.sh myserver start -i /var/opt/pivotal/pivotal-tc-server-standard Pinning tc Runtime Instances to a Specific Version You can use the --version parameter of tcruntime-instance.sh bat to specify the version of tc Runtime to which the new instance is pinned. Specifically: If you explicitly specify the --version parameter, the tc Runtime instance is pinned to that version. This means that when you use the tcruntime-ctl.sh bat script to start the instance, the instance always uses this tc Runtime version, even if you have installed a more recent version of the tc Runtime. If you do not specify the --version parameter when you create the instance, it is automatically pinned to the highest version available (based on the preferred major version in tc Server). To determine the list of available versions, search for INSTALL_DIR/tomcat-XXX directories, where XXX follows a pattern such as A.RELEASE. Copyright Pivotal Software Inc, x

31 For example, if you create a new instance using the following command: prompt$./tcruntime-instance.sh create --version A.RELEASE \ -i /var/opt/pivotal/pivotal-tc-server-standard myserver the myserver instance will always use version A.RELEASE of the tc Runtime, even if a more recent version is installed. If, however, you do not specify the --version parameter, for example: prompt$./tcruntime-instance.sh create -i /var/opt/pivotal/pivotal-tc-server-standard myserver the myserver instance is automatically pinned to the highest version available. Not having to explicitly specify a version when you create the instance is useful if you know that you simply want to use the highest available. To determine the tc Runtime version to which existing instance is pinned, check the file INSTANCE-DIR/conf/tomcat.version which lists the version, such as A.RELEASE. When the instance starts, if it cannot find the tc Runtime version specified in its tomcat.version file, the instance outputs a warning and instead uses the highest version of tc Runtime in the same major runtime release (i.e. tc Runtime 7 or 8). For example, if the tomcat.version file specifies A.RELEASE, but the instance finds only the B.RELEASE and B.RELEASE versions, then the instance uses the B.RELEASE tc Runtime version. Note that it does not use any tc Runtime 8 release, if found, because this is a different major release. To change the version of a pinned instance, use the modify-version command together with --version to specify the new version. For example: prompt$./tcruntime-instance.sh modify-version --version A.RELEASE \ -i /var/opt/pivotal/pivotal-tc-server-standard myserver Best Practice - Naming tc Runtime Instances The name of a tc Runtime instance is the name of its CATALINA_BASE directory, minus the leading directory paths. As a reminder, CATALINA_BASE is the base directory of the instance; this directory contains the instance-specific startup scripts in the bin sub-directory, the configuration files in the conf sub-directory, and so on. For example, if you create a tc Runtime instance in the /var/opt/pivotal/pivotal-tc-server-standard/myserver directory, then its name is myserver. It is best practice to use unique names for the main installation directory for each tc Runtime instance on the same computer. Differences Between the Separate and Combined Layouts You can create two flavors of tc Runtime instances, depending on the layout of their files: Separate layout: In this layout, the instance s CATALINA_HOME and CATALINA_BASE point to two different directories. Typically, CATALINA_HOME points to a tomcat-8.0.x.release directory, which in turn contains the set of tc Runtime binaries that are shared by other instances that use the separate layout. Pivotal highly recommends you use this layout, which is the default. Combined layout: This layout closely resembles the standard Apache Tomcat layout where the instance s CATALINA_HOME and CATALINA_BASE point to the same directory. This means that each instance that uses the combined layout has its own copy of the tc Runtime binaries. For this reason, it is very difficult to upgrade to a new version of tc Runtime. Pivotal does not recommend you use this layout, because it is so difficult to upgrade instances. The main reason for using it is if you are familiar with the Apache Tomcat layout and want to continue to use it in your environment. Using the tc Runtime Templates A template is simply a directory under the INSTALL-DIR/templates directory that contains additional or customized tc Runtime instance files. For example, the directory might contain a conf/server-fragment.xml file, which the tcruntime-instance script uses to update the base server.xml file with the relevant feature. The directory might also contain additional JAR files. Templates make it easier to automatically configure certain tc Runtime features when you create a new tc Runtime instance or after you have already created it. These features include SSL, clustering, and so on. Copyright Pivotal Software Inc, x

32 Creating a Runtime Instance with the tc Runtime Templates When you create a new tc Runtime instance, you use the --template option to specify a template to the tcruntime-instance create command, or to the tcruntime-instance apply-template command if you want to apply a template to an existing tc Runtime instance. When creating a new instance, you can specify the --template option multiple times if you want to apply multiple templates, such as clustering and SSL. When applying a template to an existing instance, you can specify the --template only once per script execution. To use this feature, the specified template must already exist. You can use one of the out-of-the-box templates or one that you create yourself. The argument to the --template option of the tcruntime-instance script must be the tc Runtime template directory. The tcruntime-instance script looks for the template directory in the INSTALL_DIR/pivotal-tc-server-edition-version/templates directory, where edition-version refers to the edition of tc Server you are using ( developer or standard ) and the version of tc Server. The following example shows how to create a new tc Runtime instance called myserver using the nio out-of-the-box template which adds a NIO Connector to the server.xml file: prompt$./tcruntime-instance.sh create --template nio -i /var/opt/pivotal/pivotal-tc-server-standard myserver In the preceding example, because it does not specify the --version or --java-home options, the instance is uses the latest installed version of tc Runtime, and the instance uses the value of JAVA_HOME in the environment. The instance is created in the /var/opt/pivotal/pivotal-tc-server-standard/myserver directory. The following example shows how to create an instance that uses two templates: prompt$./tcruntime-instance.sh create --template insight --template jmx-ssl \ -i /var/opt/pivotal/pivotal-tc-server-standard myserver Note that the insight template is available only in the Developer Edition of tc Server. What the tcruntime-instance Script Does to Create a Runtime Instance When you create a tc Runtime instance using tcruntime-instance, the script performs the following high-level steps: Creates the instance directory and applies the base template to it. This template provides configuration common to all tc Runtime instances, such as ensuring that the instance can be monitored with VMware Hyperic. If you specified one or more templates with the --template option, the script applies each template in order. First the script copies over any nonconfiguration files (such as JAR files) to the appropriate instance directory, and then the script merges the configuration file fragments with the instance configuration files. You receive a warning if the creation of the instance copies over files with the same name and directory location from two or more different templates. Applies any needed configuration properties. The script gets the value of these properties either interactively from you, from the --property or --properties-file options you might have specified at the command-line, or from the default property values if no value is provided. If there are no <Connector> elements in the server.xml file after the templates have been applied, the tcruntime-instance script adds a Nonblocking IO (NIO) HTTP Connector to the instance. Creates a README.txt file in the instance directory that lists the templates that have been applied to the instance. When you apply a template to an existing instance, the script applies the configuration properties and updates the README.txt appropriately. Template Directory Structure The files that make up a template reside in a single directory; the name of the template directory is the name of the template. The template files are organized in the standard Tomcat subdirectory hierarchy. For example, configuration files live in the conf subdirectory and JAR files live in the lib subdirectory. The configuration files in the conf template directory are actually just fragments of XML, called server-fragment.xml or context-fragment.xml, that contain just the additions, deletions, or changes that the script applies to the base instance. When the tcruntime-instance script applies the template after it has created a new base tc Runtime instance, it merges the XML fragment files with the corresponding base conf/server.xml or conf/context.xml file, and copies over any other files, such as JAR files. Depending on the contents of the template directory, the new tc Runtime instance might be quite different from the standard one. For example, the template might modify the standard server.xml file with additional server configuration, or copy one or more applications to the webapps directory so that they are automatically deployed on startup. Templates Provided by tc Server Copyright Pivotal Software Inc, x

33 tc Server provides several out-of-the-box templates. Most are server configuration related; for example, one template sets up a basic cluster node configuration and another sets up SSL. Some templates are provided only in certain editions of tc Server, such as the insight template in the Developer Edition. The following example shows how to use the nio out-of-the-box template to create a tc Runtime instance that is automatically configured with the NIO Connector in its server.xml file: prompt$./tcruntime-instance.sh create --template nio -i /var/opt/pivotal/pivotal-tc-server-standard myserver-nio Because the nio template is in the templates directory, you simply specify its name at the --template option. The following table lists the templates that are provided by tc Runtime out-of-the-box and how each template differs from the generic tc Runtime instance (created without a specific template.) All templates are located in the INSTALL_DIR/pivotal-tc-server-edition/templates, where edition refers to the edition of tc Server you installed ( developer or standard ). Table 6. Out-of-the-Box Templates Provided by tc Runtime base Base from which all new tc Runtime instances are created. It provides the configuration that is common to all tc Runtime instances, such as ensuring that the instance can be monitored with VMware vcenter Hyperic. When this template is applied, either the base-tomcat-7 or base-tomcat-8 is applied as well, depending on the tc Runtime version to be used by the instance. ajp Adds an Apache JServer Protocol (AJP) connector, which enables Apache web server to communicate with the tc Runtime instance. For details about the connector, see[the AJP Connector] ( in the Apache Tomcat Configuration Reference. Adds a APRLifecycleListener to detect the APR-based native library required to use the APR/native connector. Adds the APR HTTPS connector. apr NOTE: You must install the APR/native library in order to use the APR connector. For more information, see [Apache Portable Runtime (APR) based Native library for Tomcat]( on the Apache Tomcat Web site. Adds an APRLifecycleListener to detect the APR-based native library required to use the APR/native connector. Adds an APR HTTPS connector. Generates a self-signed certificate and public key file, located by default in the conf directory. Disables SSLv2 support. The available ciphers are limited to those allowed by Pivotal. apr-ssl NOTE: You must install the APR/native library in order to use the APR connector. For more information, see [Additional Information About Using the SSL Templates](#postinstall-create-instance-templates-ssl). For general information about APR and SSL, see [Apache Portable Runtime (APR) based Native library for Tomcat] ( and [SSL Configuration HOW-TO]( on the Apache Tomcat Web site. Configures asynchronous logging for the instance, which means that two Copyright Pivotal Software Inc, x

34 separate tc Runtime threads handle incoming requests and write to the log file; by default, the same tc Runtime thread performs both actions. When you specify this template, the conf/logging.properties file contains async-logger references to the AsyncFileHandler class rather than the default FileHandler class. After you specify asynchronous logging for an instance, you can configure its behavior by setting certain system properties in the CATALINA_BASE/bin/setenv.sh (Unix) or CATALINA_BASE/bin/setenv.bat (Windows) file. See the Configuring Asynchronous Logging section of the tc Server Administration Guide for details. bio Adds a Blocking IO (BIO) HTTP Connector to the new instance s server.xml file. Note: BIO connector was removed in tc Runtime 8.5 Adds a Blocking IO (BIO) HTTPS connector. Generates a keystore that contains a self-signed certificate and a public key, and stores it in the conf directory by default. Disables SSLv2 support. bio-ssl The available ciphers are limited to those allowed by Pivotal. For general information, see The HTTP Connector and SSL Configuration HOW-TO on the Apache Tomcat Web site. Note: BIO connector was removed in tc Runtime 8.5 Adds the default Cluster configuration at the Engine level. By default, multicast discovery is used to identify other nodes in the cluster. If multicast is not enabled on the subnet or if multiple tc Runtime clusters may be present on the same subnet, reconfigure this cluster node to use static membership. cluster-node Adds the jvmroute attribute to the Engine element to uniquely identify the node. This is parameterized using ${tcserver.node}, which is defined in the CATALINA_BASE/conf/catalina.properties file. tc Server provides a default value for the jvmroute attribute. You can specify a value other than the default when you create the tc Runtime instance by specifying the cluster-node.node.name property using the -- property option as follows: --property cluster-node.node.name=my-node. Because this template does not specifically add a Connector to the instance s server.xml file, the tcruntime-instance script will automatically add a Blocking IO (BIO) HTTP Connector in tc Server 3.1.x and will add a Non-blocking IO (NIO) HTTP connector in tc Server 3.2.x. For more information, see [Clustering/Session Replication HOW-TO] ( on the Apache Tomcat Web site. Adds a sample JDBC resource configuration that integrates with the request diagnostics to report slow queries. Adds a ThreadDiagnosticsValve at the Engine level to report on slow running requests. diagnostics Because this template does not specifically add a Connector to the instance s server.xml file, the tcruntime-instance script automatically adds a Blocking IO (BIO) HTTP Connector in tc Server 3.1.x and will add a Nonblocking IO (NIO) HTTP connector in tc Server 3.2.x. Provides fast, scalable, and reliable HTTP session replication for your tc Runtime instances, including support for the latest tc Runtime 8. This Copyright Pivotal Software Inc, x

35 gemfire-cs template applies to the client/server configuration of Pivotal GemFire. Note: As of 3.2.0, this is now available from the Template Repository gemfire-p2p Provides fast, scalable, and reliable HTTP session replication for your tc Runtime instances, including support for the latest tc Runtime 8. This template applies to the point-to-point configuration of Pivotal GemFire. Note: As of 3.2.0, this is now available from the Template Repository Developer Edition Only. Adds the Spring Insight Developer Web application to your instance. Spring Insight Developer gives you real-time visibility into the behavior and performance of your applications during the development and testing phase. See Spring Insight Developer. insight Because this template does not specifically add a Connector to the instance s server.xml file, the tcruntime-instance script automatically adds a Blocking IO (BIO) HTTP Connector in tc Server 3.1.x and will add a Nonblocking IO (NIO) HTTP connector in tc Server 3.2.x. Templates for Spring Insight Operations can be downloaded separately. Spring Insight Operations does for in-production applications what Spring Insight Developer does for application development. It gives you real-time visibility into behavior of deployed applications on one or more production tc Runtime instances. See Spring Insight Operations. Note: As of 3.2.0, this is now available from the Template Repository Updates the JmxSocketListener to use SSL for all JMX communication Generates a keystore that contains a self-signed certificate and a public key, and stores it in the conf directory by default. Disables SSLv2 support. The available ciphers are limited to those allowed by Pivotal. jmx-ssl Because this template does not specifically add a Connector to the instance s server.xml file, the tcruntime-instance script will automatically add a Blocking IO (BIO) HTTP Connector in tc Server 3.1.x and will add a Non-blocking IO (NIO) HTTP connector in tc Server 3.2.x. For more information, see [Additional Information About Using the SSL Templates](#postinstall-create-instance-templates-ssl). For general information, see SSL Configuration HOW-TO on the Apache Tomcat Web site. Adds a Non-Blocking IO (NIO) connector for HTTP. nio For more information, see [The HTTP Connector] ( on the Apache Tomcat Web site. Adds an NIO HTTPS connector. Generates a keystore that contains a self-signed certificate and a public key, and stores it in the conf directory by default. Disables SSLv2 support. The available ciphers are limited to those allowed by Pivotal. nio-ssl For more information, see [Additional Information About Using the SSL Templates](#postinstall-create-instance-templates-ssl). For general information, see [The HTTP Connector] ( and [SSL Configuration HOW-TO]( Copyright Pivotal Software Inc, x

36 howto.html) on the Apache Tomcat Web site. redis-session-manager Enables you to configure tc Runtime instances to use a Redis server for session management and replication. Does not require a user to specify a password to connect to Redis. Note: As of 3.2.0, this is now available from the Template Repository redis-session-manager-auth Enables you to configure tc Runtime instances to use a Redis server for session management and replication. Requires a user to specify a password to connect to Redis. Note: As of 3.2.0, this is now available from the Template Repository Additional Information About Using the SSL Templates If you specify one of the SSL templates ( bio-ssl, nio-ssl, apr-ssl, or jmx-ssl ) when you create a tc Runtime instance, the tcruntime-instance script automatically configures SSL or OpenSSL for the instance; generates a new keystore; and provides default values for various properties if you do not specify them interactively. For example, assume that you used the following command to create an instance: prompt$./tcruntime-instance.sh create myserver-secure -t nio-ssl -i /var/opt/pivotal/pivotal-tc-server-standard The myserver-secure instance has the following default SSL properties and configuration: A generated keystore, located in the conf directory, with the name tc-server-nio-ssl.keystore. This keystore contains a self-signed certificate with default values (such as Unknown ) for the organization information. Key alias named tc-server-nio-ssl. Key password consisting of a random string of characters. Keystore password that is the same as the key password HTTPS port of This default configuration is adequate for testing. Typically, when you move to a production environment, you want to generate keystores with real information about your organization and customize the passwords. In this case, use the --interactive option of tcruntime-instance.sh bat so that the script prompts you for the information about your particular environment. The --interactive option still generates a self-signed certificate. If you require an authentic, verified certificate, purchase one from a well-known Certificate Authority such as VeriSign, and use the keytool JDK tool to import the certificate into your keystore. See the Creating a Simple Keystore File For Both SSL and OpenSSL section in the Pivotal tc Server Administration Guide in this Documentation Center for more information. Windows - Create and Modify tc Runtime Instances The MSI installer for Microsoft Windows installs the Pivotal tc Server Configurator with the application. Creating a tc Runtime Instance 1. Click the Start button > All Programs > Pivotal > Pivotal tc Server Configurator. The application opens and displays the list of existing tc Runtime instances. 2. Click the Add button. The Create Instance window opens. 3. Complete the following fields: Enter a logical name for the instance. Select the Apache Tomcat version to install. Select the Use Instance configuration file checkbox if you want to configure your new tc Runtime instance using a properties file. Copyright Pivotal Software Inc, x

37 Browse to and select the location of the file containing properties that you want to apply to the new tc Runtime instance. When you create a properties file, it should contain one property per line, in the form template-name.property-name=value. The name of the property depends on the template. For example, the default template (called nio ) has two configuration properties: http.port and https.port. Other templates might specify their own configuration properties. If you want to pass your own values of these properties to the tcruntime-instance script at the command line, rather than the instance taking the default values, create a file such as the following: nio.http.port=9090 nio.https.port=9191 See the configuration-prompt.properties file in the INSTALL_DIR/pivotal-tc-server-edition-release/templates/template-name directory for the list of configuration properties that apply to a particular template. Accept the default instance location, or browse to and select a new location. 4. Click the Next button. The list of available templates page opens. Select from among the available templates to apply to your tc Runtime instance. You can apply multiple templates to the instance. In this context, a tc Runtime template refers to a set of customized tc Runtime files copied to the instance. For additional details and examples about using templates, see Templates Provided by tc Server. 5. Click the Next button. The Ready to Create Instance page opens. 6. Review the list of instance setup options. 7. Click the Finish button when you are ready to proceed. Note: The configurator does not display a progress bar as it creates the new instance. The configurator displays the new tc Runtime instance in the list. 8. Click the Install button to create a Windows service for the instance. Starting and Stopping a tc Runtime Instance 1. Click the Start button > All Programs > Pivotal > Pivotal tc Server Configurator. The application opens and displays the list of existing tc Runtime instances. 2. Select the instance that you want to start or stop. 3. Start or stop the instance. Click the Start button to start the Windows service for the instance. Click the Stop button to stop the Windows service for the instance. Adding Templates to a tc Runtime Instance 1. Click the Start button > All Programs > Pivotal > Pivotal tc Server Configurator. The application opens and displays the list of existing tc Runtime instances. 2. Click the Add Templates button. The Add Templates to Instance window opens. 3. Select the instance that you want to modify. 4. Select the Use Instance configuration file checkbox if you want to configure your new tc Runtime instance using a properties file. Browse to and select the location of the file containing properties that you want to apply to the new tc Runtime instance. When you create a properties file, it should contain one property per line, in the form template-name.property-name=value. The name of the property depends on the template. For example, the default template (called nio ) has two configuration properties: http.port and https.port. Other templates might specify their own configuration properties. If you want to pass your own values of these properties to the tcruntime-instance script at the command line, rather than the instance taking the default values, create a file such as the following: nio.http.port=9090 nio.https.port=9191 See the configuration-prompt.properties file in the INSTALL_DIR/pivotal-tc-server-edition-release/templates/template-name directory for the list of configuration properties that apply to a particular template. 5. Click the Next button. The list of available templates page opens. Select from among the available templates to apply to your tc Runtime instance. You can apply multiple templates to the instance. In this context, a tc Runtime template refers to a set of customized tc Runtime files copied to the instance. Copyright Pivotal Software Inc, x

38 For additional details and examples about using templates, see Templates Provided by tc Server. 6. Review the list of instance setup options. 7. Click the Finish button when you are ready to proceed. Note: The configurator does not display a progress bar as it creates the new instance. The configurator displays the new tc Runtime instance in the list. Removing a tc Runtime Instance 1. Click the Start button > All Programs > Pivotal > Pivotal tc Server Configurator. The application opens and displays the list of existing tc Runtime instances. 2. Select the instance that you want to remove. 3. Click the Remove button. The configurator stops the instance Windows service, if started, and removes the instance from your hard drive. Starting and Stopping tc Runtime Instances Manually The following sections describe how to start and stop tc Runtime instances on both Unix and Windows platforms. On Unix platforms, you typically use shell scripts to start and stop tc Runtime instances; alternatively, you can configure your Unix boot process to start the instance automatically. On Windows, you first install the tc Runtime instance as a Windows Service. You can use the tcruntime-ctl script or the Windows Services console to start and stop it. Unix: Starting and Stopping tc Runtime Instances Interactively Using tcruntime-ctl.sh Unix: Starting tc Runtime Instances Automatically at System Boot Time Windows: Starting and Stopping tc Runtime Instances as Windows Services The Windows Java Service Wrapper tcruntime-ctl Command Reference Windows: Setting the Logon-as-Service Right for a Windows User Unix - Starting and Stopping tc Runtime Instances Using tcruntime-ctl.sh By default, the tcruntime-instance.sh script creates all tc Runtime instances under the INSTALL_DIR/pivotal-tc-server-edition directory, where INSTALL_DIR refers to the directory in which you installed tc Server, such as /opt/pivotal, and edition refers to the edition or package of tc Server you are using ( developer or standard ). Each tc Runtime instance lives in its own directory; this directory translates into the server s CATALINA_BASE variable. This is the default behavior of the command script; you might have specified a different location of your tc Runtime instance. In the following procedure, it is assumed that you installed a tc Server Standard Edition. To start and stop a tc Runtime instance: 1. Login to the computer on which installed tc Server as the user who will run the tc Runtime instance, 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. Start a terminal window and change to the CATALINA_BASE/bin directory of the tc Runtime instance you want to start or stop. For example, if you installed tc Server in /opt/pivotal and created a new tc Runtime instance called myserver in the /var/opt/pivotal/pivotal-tc-serverstandard directory: prompt$ cd /var/opt/pivotal/pivotal-tc-server-standard/myserver/bin 3. Start the tc Runtime instance by executing the tcruntime-ctl.sh start command. For example: prompt$./tcruntime-ctl.sh start This command starts the tc Runtime instance as a daemon under the current user account. 4. Stop a currently running tc Runtime instance by executing the tcruntime-ctl.sh stop command: Copyright Pivotal Software Inc, x

39 prompt$./tcruntime-ctl.sh stop See tcruntime-ctl Command Reference for the full list of commands of the tcruntime-ctl script. Unix - Starting tc Runtime Instances Automatically at System Boot Time When you create a tc Runtime instance on a Unix platform, the tcruntime-instance.sh script creates a boot script, instance-name/bin/init.d.sh, which you can install to start the tc Runtime instance automatically at boot time. Once you install the script, whenever the computer reboots, the tc Runtime instance is automatically started. You can also use the script to control the tc Runtime instance the same way you use other scripts in the /etc/init.d directory. About Users and Permissions The scripts in /etc/init.d are owned by root and must be executed by root. When the tc Runtime init.d script executes, it uses /bin/su to execute the tc Runtime instance as another user, tc-server by default. This user account must exist and have permission to read and write all files in the CATALINA_HOME directory. To ensure that file permissions are correct, you should either create the tc Runtime instance while logged in as the user you want to run the instance, or create the instance and then chown the CATALINA_HOME directory and all of its files and subdirectories to the user you want to run the instance. Specify the runtime user on the tcruntime-instance.sh create command line when you create the instance by including --property base.runtime.user=run-time-user in the command, as shown in this example: prompt$./tcruntime-instance.sh create --property base.runtime.user=tcserver \ -i /var/opt/pivotal/pivotal-tc-server-standard myinstance Or use the --interactive option, and the tcruntime-instance.sh create command will prompt you to enter the runtime user account. After you create an instance, you can edit the CATALINA_HOME/bin/init.d.sh file and change the value of the TC_RUNTIME_USER variable: TC_RUNTIME_USER="tc-server" Again, ensure that the user exists and owns (or is able to read and write) all files and directories in the CATALINA_HOME directory. Installing the init.d.sh Script To enable the init.d.sh script, you create a link to it in the /etc/init.d directory. Since the scripts in /etc/init.d belong to root, this procedure requires root permission. Procedure 1. In a Unix terminal window, use the su command to become root, if necessary: prompt$ su Password: Enter the root password at the prompt. 2. Install the init.d.sh script in the /etc/init.d directory using a command like the following: prompt# ln -s CATALINA_HOME/bin/init.d.sh /etc/init.d/instance-name For example, if you created an instance named MyInstance in the /var/opt/pivotal/pivotal-tc-server-standard directory, enter this command: prompt# ln -s /var/opt/pivotal/pivotal-tc-server-standard/myinstance/bin/init.d.sh \ /etc/init.d/myinstance 3. To test the script, restart the computer, or start the tc Runtime instance using the /etc/init.d/instance-name command. For example: Copyright Pivotal Software Inc, x

40 prompt# /etc/init.d/myinstance start 4. Check the status of the tc Runtime instance using the /etc/init.d/instance-name status command. For example: prompt# /etc/init.d/myinstance status Using the /etc/init.d Script If you are accustomed to using commands in /etc/init.d to start, stop, and restart services, you can do the same with tc Runtime instances. Internally, the /etc/init.d/instance-name script calls the tcruntime-ctl.sh script in the tc Runtime instance s bin directory, so the options are equivalent. The /etc/init.d/instance-name script supports the commands in the following table: Table 7. init.d Commands for tc Runtime Instances Command start stop restart status Description Starts the Instance Shuts down the instance Stops and starts the instance Displays information about the tc Runtime instance and whether it is running or not running. You must be root when you execute the command. For example, to restart a tc Runtime instance named MyInstance : prompt$ sudo /etc/init.d/myinstance restart Windows - Starting and Stopping tc Runtime Instances as Windows Services By default, the tcruntime-instance.bat script creates all tc Runtime instances under the INSTALL_DIR\pivotal-tc-server-edition directory, where INSTALL_DIR refers to the directory in which you installed tc Server, such as \opt\pivotal and edition is developer or standard. Each particular tc Runtime instance lives in its own directory; this directory translates into the server s CATALINA_BASE variable. This is the default behavior of the command script; you might have specified a different location of your tc Runtime instance. If so, adjust the following procedure accordingly. In the following procedure, it is assumed that you installed a tc Server Standard Edition. To start and stop tc Runtime instances as Windows Services: 1. Login to the computer on which you installed tc Server as the user who will run the tc Runtime instance, such as tcserver. 2. If this is the first time that you will install and start the tc Runtime instance after creating it, start a Command Prompt window and continue with this procedure. If you have already installed the tc Runtime instance as a Windows Service, use the Windows Services control panel to start and stop it. 3. Change to the CATALINA_BASE\bin directory of the tc Runtime instance you want to start or stop. For example, if you installed tc Server in \opt\pivotal and created a new tc Runtime instance called myserver in the \var\opt\pivotal\pivotal-tc-serverstandard directory: prompt> cd \var\opt\pivotal\pivotal-tc-server-standard\myserver\bin 4. Install the tc Runtime instance as a Windows service: prompt> tcruntime-ctl.bat install The command installs the tc Runtime instance as an automatic Windows Service, which means that the tc Runtime instance starts automatically when you start the Windows computer. You can change this behavior using the Windows Service control panel. You should see a message indicating a successful installation: wrapper Pivotal tc Runtime instance - tcserver-c-var-opt-pivotal-pivotal-tc-server-standard-myserver installed. 5. Start and stop the tc Runtime instance using the tcruntime-ctl.bat script or the Windows Services console. The tc Runtime instance is displayed in the console with the name Pivotal tc Runtime instance - unique-name, where unique-name is a unique combination of server name and server directory. Copyright Pivotal Software Inc, x

41 To start an instance using tcruntime-ctl.bat : prompt> tcruntime-ctl.bat start To stop an instance using tc-runtime-ctl.bat : prompt> tcruntime-ctl.bat stop To uninstall the tc Runtime service, execute the following command: prompt> tcruntime-ctl.bat uninstall Although Pivotal recommends that you always install the tc Runtime instance as a Windows service and stop and start it using the Services console, you can also stop and start the tc Runtime instance manually. See tcruntime-ctl Command Reference for the full list of commands of the tcruntime-ctl script. Windows Java Service Wrapper On Windows, tc Runtime uses a Java Service Wrapper from Tanuki Software to install the tc Runtime instance as a Windows service. The Wrapper correctly handles user logouts under Windows, service dependencies, and the ability to run services which interact with the desktop. The wrapper is configured using the CATALINA_BASE\conf\wrapper.conf file, where CATALINA_BASE is the top-level directory of the tc Runtime instance, such as \var\opt\pivotal\pivotal-tc-server-standard\myserver. In most circumstances, you do not need to update this file because the default one created when you created the tc Runtime instance handles most use cases. However, you might sometimes want to further customize the Windows service to fit particular circumstances of your environment; in which case you can edit the wrapper.conf file. For details about the configuration properties, see Configuration Property Overview. tcruntime-ctl Command Reference You use the tcruntime-ctl.sh (Unix) and tcruntime-ctl.bat (Windows) command scripts to manage tc Runtime instances. The syntax of the script is as follows: tcruntime-ctl.sh bat command [option] Typically, you run the command from the bin directory of the tc Runtime instance itself. However, you can also run it from the INSTALL_DIR/pivotal-tc-server-edition directory if you specify the name of the instance, where INSTALL_DIR refers to the directory in which you installed tc Server and edition refers the edition of tc Server ( developer or standard.) For example, to start a tc Runtime instance called myserver from the bin directory of the instance itself on Unix: prompt$ cd /var/opt/pivotal/pivotal-tc-server-standard/myserver/bin prompt$./tcruntime-ctl.sh start You can accomplish the same thing by running the command from the main installation directory by specifying the name of the instance and its location with the -i option: prompt$ cd /opt/pivotal/pivotal-tc-server-standard prompt$./tcruntime-ctl.sh myserver start -i /var/opt/pivotal/pivotal-tc-server-standard It is assumed in the remainder of this section that you are running the command script from the bin directory of the tc Runtime instance. The following table describes the tcruntime-ctl script commands and supported platforms. Table 8. Commands of the tcruntime-ctl Script Installs the tc Runtime instance as a Windows service. You then start and stop the service using the Windows Service console. Copyright Pivotal Software Inc, x

42 install run-as-user The optional run-as-user parameter specifies the user account that you want the tc Runtime service to actually run as when you start the service using the Windows Service console; if you do not specify this parameter, then the user account that initially installed it is used. You can specify only user accounts that have their Logon as Service right set to run a Windows service. See [Setting the Logon-As- Service Right for a Windows User](#postinstall-windowsservice-logon). Windows only When you run this command and explicitly specify a run-as-user user, the script asks you for the password of the specified user. tc Runtime still installs the instance as a service, even if you enter an incorrect password. However, when you try to start the service, it fails with a logon error. You must uninstall the service and reinstall it with the correct password. uninstall Uninstalls the tc Runtime instance from the Windows Service. Starts the tc Runtime instance as a daemon process. Windows only start On Windows, you must have previously installed the tc Runtime instance as a Windows service to be able to start it using the tcruntime-ctl.bat start command; see the documentation on the tcruntime-ctl.bat install command in this table for more information. Unix and Windows Stops, and then immediately starts, a running tc Runtime instance. As with the start command, restart starts the instance as a daemon process. On Windows, you must have previously installed the tc Runtime instance as a Windows service to be able to restart it using the tcruntime-ctl.bat restart command; see the documentation on the tcruntime-ctl.bat install command in this table for more information. restart timeout By default, the tcruntime-ctl script (when stopping the tc Runtime instance) waits for up to 60 seconds for the process to exit gracefully. If the server process exits earlier, the script proceeds to restart the server. If the process has not exited by the end of the timeout period, the script forces a termination of the process before restarting the server. Using the optional timeout parameter, you can set your own timeout value by specifying an integer option for the number of seconds. For example, to specify that you want the instance to stop after 10 seconds: Unix and Windows prompt$./tcruntime-ctl.sh restart 10 run Starts the tc Runtime instance as a foreground process. Unix and Windows Copyright Pivotal Software Inc, x

43 batch stop timeout Runs the tc Runtime instance using the catalina.bat script as a batch job. Specifically, the script starts the tc Runtime instance by running the following command: %CATALINA_HOME%\bin\catalina.bat run. Stops a running tc Runtime instance. By default, the tcruntime-ctl script waits for up to 60 seconds for the process to exit gracefully; if it has not, then the script forces a termination of the process. Using the optional timeout parameter, you can set your own timeout value by specifying an integer option for the number of seconds. For example, to specify that you want the instance to stop after 10 seconds: Windows only Unix and Windows prompt$./tcruntime-ctl.sh stop 10 status verbose-status Reports the status of a tc Runtime instance, such as whether it is running or stopped, as well as useful information such as the tc Runtime version, the instance name, and the instance directory. Reports the same status information as the status command as well as additional information, such as the directory from which the tc Runtime instance gets its binary files, the version of the tcruntime scripts, and so on. Unix and Windows Unix and Windows The following table describes the options you can use with the tcruntime-ctl script. All the options are optional; you can use them with any of the tcruntime-ctl commands. Table 9. Options of the tcruntime-ctl Script -d tcruntimedir Replace tcruntimedir with the full pathname of the tc Server installation directory. Use this option if you are running the tcruntime-ctl.sh bat script from a location other than its default location. The default value of this option is the location of the tcruntime-ctl.sh bat script. Replace instancedir with the full pathname of the parent of the tc Runtime instance directory. Use this option if the tc Runtime instance directory is not in the default location (i.e., the main tc Server installation directory). -i tcruntimedir or -n tcruntimedir For example, if the full instance directory of a tc Runtime instance is /var/opt/pivotal/pivotal-tc-server-standard/myserver, then you would specify /var/opt/pivotal/pivotal-tc-server-standard for this option. The default value of this option is the current working directory. This option was added in tc Server 2.9.1, to be consistent with the -i option used with the tcruntime-instance.sh/bat script to specify an instance directory. The behavior of the -i option is identical to that of the -i option, which, for backward compatibility, is still supported. The following example shows how to stop the tc Runtime instance called myserver, located in the /var/opt/pivotal/pivotal-tc-server-standard directory, after waiting for up to 60 seconds: Copyright Pivotal Software Inc, x

44 prompt$ cd /var/opt/pivotal/pivotal-tc-server-standard/myserver/bin prompt$./tcruntime-ctl.sh stop 60 In the following example, use of the -i option indicates that the tc Runtime instance called myotherinstance has an instance directory of /var/opt/pivotal/pivotal-tc-server-standard/myotherinstance. The example shows how to use the tcruntime-ctl script located in the main tc Server installation directory. prompt$ cd /opt/pivotal/pivotal-tc-server-standard prompt$./tcruntime-ctl.sh myotherinstance stop 60 -i /var/opt/pivotal/pivotal-tc-server-standard Windows - Setting the Logon-as-Service Right for a Windows User The tcruntime-ctl.bat install command has an optional run-as-user parameter by which you specify the user account that you want the tc Runtime service to run as when you start the service from the Windows Service console. Windows requires that the specified user account must have their Logon as Service right set for this feature to work properly. To set this right: 1. From the Windows Start menu, open the Control Panel. 2. Open Administrative Tools. 3. Open the Local Security Policy tool. 4. Expand the Local Policies settings. 5. Click the User Rights Assignment. 6. On the right side, double-click on the Log on as a service policy. 7. Click on the Add User Or Group button and enter the user account name using the wizard. The Local Security Policy tool does not appear to be available on Home versions of Windows 2000 and XP. It is thus not possible to run the tc Runtime service as a specific account under those versions of Windows. Deploy Applications to tc Runtime Instances Deploying Applications Using Tomcat Manager The tc Server Standard Edition include a template used to install and configure Tomcat Manager and tc Server Developer Edition includes the Tomcat Manager web application. Tomcat Manager is an Apache Web application that you can use to deploy your own Web applications and manage their lifecycle, such as starting, stopping, and undeploying them. The default tc Server Developer Edition configuration does not automatically authorize any user to access Tomcat Manager, so you must configure a role and a user before you can use Tomcat Manager. The Tomcat Manager web application is updated in Tomcat 7.0 with separate roles to secure access to the application from different paths. To use a Web browser to deploy Web applications, you need the manager-gui role for tc Runtime 7. Refer to the Apache Web site for complete documentation for Tomcat Manager. The following procedure describes how to authorize a user to access Tomcat Manager, and then how to invoke the Web application in your browser. Procedure 1. Update the CATALINA_BASE/conf/tomcat-users.xml file in the tc Runtime instance by adding a manager-gui role (tc Runtime 7.0 or tc Runtime 8.0). An entry for the manager-gui role for tc Runtime 7 or tc Runtime 8 looks like this: <tomcat-users> <role rolename="manager-gui" />... </tomcat-users> 2. In the same file, add a user with the manager or manager-gui role, depending on your tc Runtime version. Copyright Pivotal Software Inc, x

45 The user element for tc Runtime 7 or tc Runtime 8 looks like the following: <tomcat-users> <role rolename="manager-gui" /> <user username="tomcat" password="tomcat" roles="manager-gui" /> </tomcat-users> 3. Restart the tc Runtime instance for the changes to take effect. 4. Invoke Tomcat Manager in your browser using the following URL: where host refers to the computer running the tc Runtime instance. 5. Enter the user and password you configured in the tomcat-users.xml file. The Applications table lists the currently deployed applications. Click the links in the Path column to actually invoke each application. The Commands column includes buttons for starting, stopping, reloading, and undeploying the applications. From the Deploy section, you can deploy Web applications (either exploded or in a WAR format) from either the host where running the tc Runtime instance or from the local computer running your browser. When deploying from the host, you must specify the context path that users use to invoke the application. For detailed information about Tomcat Manager, see the Manager App How-To on the Apache Tomcat Web site. Deploying Multiple Versions of the Same Application You can deploy multiple instances of the same web application to a tc Server instance. New sessions are served by the most recently deployed revision of the application. This allows you to upgrade an application without interruption of service. If you deploy an application statically or with Tomcat Manager, you must include a revision indicator string in the.war file name prefix in the /webapps directory. The revision indicator distinguishes amont multiple instances. You must conform to the following naming convention. Starting with the second instance, indicate the version as a 6 character numeric value, prepended by two hash marks, increasing the value for each revision. For instance: test## war test## war test## war Users continue to use the same URL to access the application. They do not include the revision number. New sessions use the highest revision deployed. Existing sessions continue to use the revision that is already managing their session. If tc Runtime cannot locate the session in the SessionManager of an earlier revision, the newest revision is used. When all sessions using an earlier revision of an application have ended, you can undeploy it. Embedding tc Server You can create an embedded server application with tc Server. In an embedded server application, the application is deployed and run as a JAR; the JAR file launches a main() method which in turn starts the server and deploys itself on it. This section contains general instructions for embedding tc Server. For a working example, see Pivotal tc Server Embedded Example. Prerequisites Maven The instructions below assume the existence of a Maven project into which you wish to embed tc Server. Copyright Pivotal Software Inc, x

46 Procedure 1. Register an account at 2. Configure the repository in your project s pom.xml (in the root of your project directory). 3. Configure dependencies in your project s pom.xml file. See Example pom.xml. 4. Configure credentials for accessing the tcruntime-release package at build-time, as a server stanza in the Maven settings file (.m2/settings.xml ). 5. Run the build command to assemble the application with embedded tc Server and install it in your local Maven repository (.m2), located in your home directory. 6. Start the application by invoking the executable jar created from the build. Embedded Jars Table 10. tc Server Embedded Jars Group Id Artifact Id Description tcruntime.embed io.pivotal.tcserver.org.apache.tomcat.embed.core Contains all of the core jars for tc Server embedded: catalina.jar, tomcat-coyote.jar,annotations-api.jar, tomcat-api.jar, tomcat-util.jar, servlet-api.jar tcruntime.embed io.pivotal.tcserver.org.apache.tomcat.embed.jasper Contains all of the JSP classes: jsp-api.jar, jasper-el.jar, jasper.jar, el-api.jar tcruntime.embed io.pivotal.tcserver.org.apache.tomcat.embed.logging.juli Contains the Juli logging classes: tomcat-juli.jar tcruntime.embed io.pivotal.tcserver.org.apache.tomcat.embed.logging.log4j Contains the log4j logging classes: log4j.jar tcruntime.embed io.pivotal.tcserver.org.apache.tomcat.embed.cluster Contains classes for clustering: catalina-ha.jar, catalinatribes.jar tcruntime.embed io.pivotal.tcserver.org.apache.tomcat.dbcp Contains classes for DBCP: tomcat-dbcp.jar tcruntime.embed io.pivotal.tcserver.org.apache.tomcat.jdbc Contains classes for Tomcat JDBC: tomcat-jdbc.jar tcruntime.embed io.pivotal.tcserver.org.eclipse.jdt.compiler Contains classes for Eclipse compiler: ecj-<version>.jar tcruntime.embed io.pivotal.tcserver Contains the tc Server classes: tcserver.jar Copyright Pivotal Software Inc, x

47 Security Information Pivotal is committed to providing products and solutions that allow you to assess the security of your information, secure your information infrastructure, protect your sensitive information, and manage security information and events to assure effectiveness and regulatory compliance. As part of this commitment, the following Pivotal tc Server-specific security information is provided to help you secure your environment: External Interfaces, Ports, and Services A tc Runtime instance uses TCP/IP ports to receive incoming requests and send outgoing responses. Different protocols (such as HTTP/S, JMX, and AJP) listen on different ports. If you create a tc Runtime instance using all default values, then the default TCP/IP ports for the various protocols are as follows: HTTP: 8080 HTTPS: 8443 JMX: 6969 AJP: 8009 You can change the TCP/IP listen ports for a particular tc Runtime instance by updating the INSTANCE-DIR/conf/catalina.properties file, where INSTANCE-DIR refers to the directory in which the tc Runtime instance is located, such as /var/opt/pivotal/pivotal-tc-server-standard/myserver. The following snippet of catalina.properties shows how to change the HTTP, HTTPS, and JMX ports to 8181, 8553, and 7979, respectively:... bio.http.port=8181 bio.https.port=8553 base.jmx.port=7979 Pivotal tc Server does not have any external interfaces or services that need to be enabled or opened. Resources That Must Be Protected The following tc Server configuration files should be readable only by the dedicated tc Server user who runs the tc Runtime instance: server.xml context.xml web.xml catalina.properties jmxremote.password keystore-name.keystore (Instances configured with the BIO or NIO Connector) cert-name.cer (Instances configured with the APR Connector) key-name.key (Instances configured with the APR Connector) These configuration files are specific to a tc Runtime instance and are stored in the INSTANCE-DIR/conf directory, where INSTANCE-DIR refers to the directory in which the tc Runtime instance is located, such as /var/opt/pivotal/pivotal-tc-server-standard/myserver. Log File Locations The default log files for a tc Runtime instance are as follows: catalina.out : Contains System.out and System.err messages. catalina.date.log: Contains log messages from the Catalina service. localhost.date.log : Contains log messages from the localhost engine of the Catalina service. localhost_access_log.date.txt : Contains information about access requests. These log files are specific to a tc Runtime instance and are stored by default in the INSTANCE-DIR/logs directory, where INSTANCE-DIR refers to the directory in which the tc Runtime instance is located, such as /var/opt/pivotal/pivotal-tc-server-standard/myserver. Copyright Pivotal Software Inc, x

48 These log files should be readable and writable only by the dedicated tc Server user who runs the tc Runtime instance. User Accounts Created at Installation If you install Pivotal tc Server on Red Hat Enterprise Linux (RHEL) using the RPM, then a user with the following characteristics is automatically created: ID: tcserver Group: pivotal You must log in as root or user with appropriate sudo privileges and su - tcserver. When installing from RPM on RHEL, the tc Server installation directory will be owned by the root user, with group pivotal. The tcserver user will have permission to execute appropriate scripts, such as tcruntime-instance.sh and tcruntime-ctl.sh. You should create tc Runtime instances as the tcserver user, and stop and start them as this user. When installing tc Server on Windows or from a *.zip or *.tar file, a user account is not automatically created for you. Rather, you must create a dedicated tc Server user account whose only purpose is to run tc Runtime instances. Additionally: This user should be the only user who has the permission to start and stop the tc Runtime instance, and should have no other permissions. It should not be possible to logon to the computer directly as this dedicated tc Server user. tc Server configuration files should be readable only by this dedicated tc Server user. tc Server log files should be readable and writable only by this dedicated tc Server user. Obtaining and Installing Security Updates Pivotal tc Server is a Web application server based on open-source Apache Tomcat. A particular version of tc Server includes particular versions of Apache Tomcat, such as tomcat a.release or tomcat a.release. New versions of tc Servers typically include updated versions of Apache Tomcat, some of which might fix important security vulnerabilities. To install these security updates, you install the new version of tc Server and then upgrade your existing instances. To download the latest *.zip or *.tar distributions of the Pivotal tc Server, go to the Pivotal tc Server download page. When using RPMs on RHEL, use the yum upgrade command to upgrade to the latest Pivotal tc Server version. See Upgrade and Migration Guide for details. Copyright Pivotal Software Inc, x

49 Upgrade and Migration Guide Several upgrade procedures are supported for this release of Pivotal tc Server. Upgrade an Instance to a Newer tc Runtime Binary This section has instructions for upgrading tc Server instances to a new version of the tc Runtime. Note: If you want to upgrade to the latest tc Server package, see one of these two sections: Upgrade an Instance in a New tc Server Directory Upgrade an Instance in the Existing tc Server Directory For example, suppose that your tc Server release came bundled with tomcat a.release. Later, you could decide to upgrade to the tomcat a.release (or another version) when it is released. The instructions in this section enable you to stay current with new tc Runtime releases without fully installing the full tc Server installation. This lets you take advantage of getting the latest features, security vulnerability fixes, and bug fixes. Before You Start Be sure to stop a tc Server instance before you upgrade the tc runtime version. For instructions, see Starting and Stopping tc Runtime Instances. Procedure 1. Change directory to the tc Server installation directory. For example: prompt$ cd /opt/pivotal/pivotal-tc-server-standard release 2. Use the --list option to view a list of available runtimes to install. The command generally requires a few seconds to return the list. For example: prompt$./tcruntime-admin.sh get-runtime --list Retrieving Available Runtimes (this may take a moment) Available Runtimes for tc Server 3.1.x: A.RELEASE B.RELEASE B.RELEASE A.RELEASE A.RELEASE - installed A.RELEASE B.RELEASE C.RELEASE A.RELEASE A.RELEASE - installed ``` Runtimes are specified by version, such as <span class="ph">8.0.15</span>.a.release. If 'installed' trails the version number, that indicates the runtime version is currently installed. 1. Use the --version option to download and install a specific runtime version. For example: prompt$./tcruntime-admin.sh get-runtime --version A.RELEASE Downloading A.RELEASE Expanded A.RELEASE If the specified version is already installed, then the command returns a message similar to the following: prompt$./tcruntime-admin.sh get-runtime --version A.RELEASE Runtime version A.RELEASE has been detected as already being installed. Copyright Pivotal Software Inc, x

50 Upgrade an Instance in a New tc Server Directory This section has instructions for upgrading tc Server instances to a new version of tc Server. Run the tcruntime-instance.sh upgrade or ( tcruntime-instance.bat upgrade ) command to upgrade an existing tc Server instance to a new version of tc Server. The upgrade command migrates configuration information and applications from an existing instance to the new one. The command takes this form: tcruntime-instance.sh -v <tcruntimeversion> -i PathToNewInstanceDirectory PathToOldInstance where: tcruntimeversion is the Tomcat binary that you want the new instance to use, for example, B.RELEASE. Note: The tc Runtime version must exist in the new tc Server installation directory. If you want to use a tc Runtime that exists in your previous tc Server installation, but not the new one, you must copy it into the new tc Server installation directory. If you do not use the -v option to specify a binary, the upgrade assumes you do not want to upgrade the binary and tries to create the new instance with the same binary. If the older instance uses a version of Tomcat that does not exist in the new version of tc Server, you must copy it from the older tc Server installation to the new one, or the upgrade will fail. PathToNewInstanceDirectory specifies the directory in which you want the upgraded instance to be created. Note: If you do not use the -i option to specify a directory, the instance will be created in the current working directory. If you specify the directory where the old instance exists, that instance will be upgraded in place. PathToOldInstance points to the instance that you wish to upgrade. Before You Start Be sure to stop a tc Server instance before you upgrade. For instructions, see Starting and Stopping tc Runtime Instances. Procedure The example commands in the instructions below assume you are upgrading a tc Server instance to Install the new version of tc Server in a new installation directory, as described in Installing Pivotal tc Server. For example, install tc Server in /opt/pivotal/pivotal-tc-server-standard release. 2. If the directory where you want the upgraded server instance to be installed does not exist, create it. 3. Change directory to new TCS installation directory. For example: prompt$ cd /opt/pivotal/pivotal-tc-server-standard release 4. Run the upgrade command. For example: prompt$ tcruntime-instance.sh upgrade -i../tcs instances -v A.RELEASE../tcs instances/myserver1 The command above creates an upgraded version of the myserver1 instance in the /tcs instances directory. Upgrade an Instance in the Existing tc Server Directory RHEL - Upgrade Using the Pivotal RPM Repository Copyright Pivotal Software Inc, x

51 Pivotal tc Server provides RPMs in Pivotal repositories from which you can install on an RHEL computer or virtual machine. If you originally installed tc Server on the RHEL computer using yum install, then you use yum upgrade to upgrade the installation to the latest version. The yum upgrade process: Installs the latest tc Runtime versions in the /opt/pivotal/pivotal-tc-server-standard directory. The old tc Runtime versions associated with the previous version of tc Server are preserved. Copies the new versions of the tc Server commands and templates to the /opt/pivotal/pivotal-tc-server-standard directory. Prerequisites Stop all running tc Runtime instances in the installation that you are upgrading. See Unix: Starting and Stopping tc Runtime Instances Interactively. If necessary, install the Pivotal repository RPM that contains the version of Pivotal tc Server to which you are upgrading. Procedure 1. From the RHEL computer on which you will upgrade Pivotal tc Server, log in as the root user. 2. Execute the following yum command: prompt# yum upgrade pivotal-tc-server-standard The yum command begins the upgrade process, resolves dependencies, and displays the packages it plans to upgrade. 3. Enter y at the prompt to begin the actual upgrade. When the upgrade process finishes, you will see a Complete! message at the end. Check the output of the command to ensure that the upgrade was successful. 4. For each tc Runtime instance that you created in the previous tc Server installation that you want to upgrade, follow these steps: a. If necessary, become the user that created the instances you want to upgrade, such as tcserver : prompt# su - tcserver b. Change to the directory in which the instance is located. For example: prompt$ cd /var/opt/pivotal/pivotal-tc-server-standard c. Execute the tcruntime-instance upgrade command. Specify the name of the tc Runtime instance you are upgrading and use the -v option to specify the new tc Runtime version that the upgraded instance will start to use. For example, if your tc Runtime instance is called myserver : prompt$ /opt/pivotal/pivotal-tc-server-standard/tcruntime-instance.sh upgrade -v A.RELEASE myserver When you start the upgraded tc Runtime instance, it will use the A.RELEASE tc Runtime. Copyright Pivotal Software Inc, x

52 Tutorial - Using Hyperic to Configure and Manage tc Runtime Instances This tutorial describes the basic steps for configuring and monitoring a tc Runtime instance with the Hyperic user interface and for managing applications deployed to the instance. Before You Begin Install and start the components of Pivotal tc Server (Hyperic Server, Hyperic Agent, and at least one tc Runtime instance); invoke the Hyperic user interface in your browser; and log in with the administration username/password or with Hyperic user permissions to configure a tc Runtime instance. To accomplish these tasks, see: Installing tc Server Creating a New tc Runtime Instance Starting and Stopping tc Runtime Instances Most Hyperic user interface pages have a Help link at the top-right corner. On the tc Runtime configuration pages, click the icon field to get information about the field. to the right of each For simplicity, it is assumed in this tutorial that you are going to log in to the Hyperic user interface as the superuser ( hqadmin ). If, however, you are going to log in as a non-superuser, see User Permissions Required to Use the tc Server Hyperic Plugin Features in Pivotal tc Server Administration for information about the required Hyperic user permissions to be able to use all the tc Server Hyperic plug-in features described in this tutorial. Restart a tc Runtime Instance In this procedure, you restart a currently running tc Runtime instance. 1. Click the Resources > Browse link at the top of the Hyperic user interface 2. Click the Servers (X) link to see the list of servers known by Hyperic. To limit the number of displayed servers to only tc Runtime instances, select SpringSource tc Runtime 7.0 or Pivotal tc Runtime 8.0 from the Search drop-down list, then click the green arrow to the far right. 3. In the table, click the tc Runtime instance you want to restart. The server is listed as platform-resource tc Runtime catalina-base-dir, where platform-resource is the computer hosting the tc Runtime instance. catalina-base-dir is the CATALINA_BASE directory of the tc Runtime instance without the leading directory pathnames, such as myserver. 4. Click the Control tab. You use this Hyperic user interface page to stop, start, and restart the current tc Runtime instance, as described in the next step. 5. In the Quick Control section of the page, select Restart from the Control Action drop-down list, then click the arrow to the right, as shown in the following graphic. After you click the restart button, the Command State field in the Current Status section says In progress until the tc Runtime instance is successfully restarted. The Current Status section always displays information about the last control action; in this case the restart of the tc Runtime instance. Copyright Pivotal Software Inc, x

53 Add tc Runtime Instances to the Favorite Resources Portlet The main Hyperic dashboard includes a Favorite Resources portlet that lists the resources you most often manage. When you first install Hyperic, the portlet is empty. However, as you manage a particular resource, you might decide that you want to add it to your favorites portlet because you return to it frequently. In this procedure you add a tc Runtime instance to the Favorite Resources portlet. 1. Navigate to the tc Runtime instance, as described in the first three steps of Restart a tc Runtime Instance. 2. Click the Tools Menu in the top-left corner and choose Add to Dashboard Favorites. 3. In the box, click the name of the user for whose dashboard the tc Runtime instance will show up as a favorite. Following our tutorial, click hqadmin, although if you logged in as another user you can enter that one. 4. Click Add. 5. The tc Runtime instance is displayed in the Favorite Resources portlet on the main dashboard: Create an Hyperic Group of Multiple tc Runtime Instances In this procedure you create an Hyperic group of multiple tc Runtime instances. You can then deploy a Web application to the group, and Hyperic does the work of deploying the Web application to each member of the group. Similarly, you can stop, start, and restart all the servers in the group with a procedure similar to Restart a tc Runtime Instance. Using Hyperic groups saves a lot of time if you need to control multiple tc Runtime instances running on many different computers, as well as deploy and manage their applications. It is assumed in this procedure that you have at least two tc Runtime instances running and that you have added them to the Hyperic inventory. Tip: It might take a while for the Hyperic user interface to auto-detect a new tc Runtime instance after you start it. You can force a new auto-discovery to speed the process. To force an auto-discovery, browse to the platform resource where you started the new tc Runtime instance. For example, in this tutorial the platform resource is called juliet-desktop. Then click New Auto-Discovery in the Tools Menu. In the Quick Auto-Discovery Scan section, click OK. The new tc Runtime instance should show up in the Auto-Discovery portlet of the main Dashboard very shortly. You can then add it using the Add to Inventory button as usual. 1. Click the Resources > Browse link at the top of the Hyperic user interface. 2. Click the Servers (X) link to list all the servers in your resource inventory. The tc Runtime instances are listed as Server Type SpringSource tc Runtime 7.0 or Pivotal tc Runtime 8.0. If there are many server resources listed in the table, you can narrow down the list by selecting a server type in the Search drop-down list, then clicking the green arrow all the way to the right of the Search line. 3. For each tc Runtime instance you want to include in the new group, check the box to the left of the instance s entry in the table. 4. Click Group. The following graphic shows how to group together two tc Runtime instances called tc Runtime myotherserver and tc Runtime myserver. Copyright Pivotal Software Inc, x

54 5. In the Group Manager window, click Add to New Group. 6. In the General Properties section, enter a name for the group, such as tcservergroup and an optional description and location, such as San Francisco. 7. Click OK. Depending on the members of the group, Hyperic creates a Compatible Group/Cluster or Mixed Group. The first type of group consists of a single type of server, such as only tc Runtime instances. The second mixed group consists of different types of servers, such as both tc Runtime instances and Apache Tomcat servers. To stop or restart the group of servers, and deploy an application to the group: 1. Click Resources > Browse at the top of the Hyperic user interface. 2. Click Compatible Groups/Clusters if your group consists of the same servers, or Mixed Groups if your group consists of different types of servers. 3. In the table, click on the name of the group. 4. To stop or start all the servers in the group, click the Control tab, then follow the steps for controlling a single server, as described in Restart a tc Runtime Instance. The breadcrumbs at the top of the console page list the group name ( tcservergroup in this case) rather than the tc Runtime instance name. 5. To deploy and manage applications on all servers in the group, click the Views > Application Management tab, then follow the steps for deploying or managing the applications of a single server. Monitoring tc Runtime Instances As soon as you add a resource (such as a tc Runtime instance) to the Hyperic inventory, Hyperic begins collecting a variety of metrics about the resource that you can use to monitor its state and health. Hyperic displays the values of the metrics over a specified period of time using indicator charts or tables. Examples of the types of metrics that Hyperic collects about tc Runtime include: Number of thread deadlocks detected. Size of the free heap memory. JSP count per minute. Number of servlet requests per minute. The following procedure describes how to view the monitoring metrics for a tc Runtime instance. 1. Navigate to the tc Runtime instance, as described in the first three steps of Restarting the tc Runtime Instance. 2. Click the Monitor tab. The charts under the Indicator tab show data about the entire tc Runtime instance, such as thread deadlocks detected and size of the free heap memory and the tc Runtime instance up time. Click the Metric Data tab to see the same information in tabular form. The Services table to the left lists the services associated with the tc Runtime instance, such as the JSP and servlet monitors. 3. In the Services table, click SpringSource tc Runtime Servlet Monitor. The chart on the right shows usage metrics about the servlets deployed to the tc Runtime instance. 4. Click on other services within the Monitoring tab to view more monitoring information for the tc Runtime instance. Copyright Pivotal Software Inc, x

55 You can create an alert for a resource that fires when a specified condition is met, and optionally specify a control action that occurs when the alert is fired. Hyperic is preconfigured for a deadlock detection alert; see Manage the Preconfigured Deadlock Detected Alert to modify it. Manage the Preconfigured Deadlock Detected Alert Hyperic includes a preconfigured alert that triggers once if the Deadlocks Detected metric exceeds 0. Hyperic applies this alert to all auto-discovered tc Runtime instances, enables it by default, and then checks the metric every two minutes to see if the condition has been met. After triggering, Hyperic disables the alert until an administrator marks it as Fixed. The following procedure describes how to view this preconfigured alert, modify it so that Hyperic automatically restarts the tc Runtime instance in which the alert is triggered, and then disable it. 1. Navigate to the tc Runtime instance, as described in the first three steps of Restart a tc Runtime Instance. 2. Click the Alert tab at the top of the page. 3. Click the Configure button. A page is displayed with a table of alerts that have been defined for this tc Runtime instance. You should see the preconfigured Deadlocks Detected alert; by default it is active (enabled.) 4. In the table, click Deadlocks Detected to display the Alert Definition page. 5. Click the Control Action tab at the bottom of the page, and then click the EDIT button. 6. Select restart from the Control Type drop-down list. 7. Click OK. You have modified the alert so that Hyperic automatically restarts the affected tc Runtime instance when Hyperic detects a thread deadlock. 8. To disable the alert: a. Return to the page that contains the Alert Definitions table by clicking the Return to Alert Definitions link at the top left corner of the page. b. In the table, select the Deadlocks Detected alert by checking the box to the left of its name. c. At the bottom of the table, choose No in the Set Active drop-down list. Copyright Pivotal Software Inc, x

56 d. Click the arrow to the right of the drop-down list. The Active column for the Deadlocks Detected alert changes to No. Copyright Pivotal Software Inc, x

57 Tutorial - Very Simple HelloWorld Web Application This tutorial is for beginning programmers who want to know the minimal basic information on how to create servlets and JSPs, package them into a deployable WAR file, deploy the application to a tc Runtime instance, and run the application in a browser. The tutorial uses Ant as its build framework. You can also use an IDE, such as Spring Tool Suite, to create the application. The tutorial shows you how to create each artifact, from the servlet source to the Ant build.xml file, from scratch. Before You Begin Install Pivotal tc Server and Ant. See Installing tc Server and Apache Ant Project. Creating and Deploying the HelloWorld Web Application To create a Web application and deploy it to a tc Runtime instance: 1. When you install Ant, add or update the following environment variables: ANT_HOME : Set this variable to the location where you installed Ant, such as /usr/local/ant/apache-ant PATH : Update your PATH variable to include ANT_HOME/bin. 2. Set the JAVA_HOME environment variable to the directory where the JDK is installed. 3. Create a project directory structure to contain the HelloWorld Web application source files. Create the top-level directory called helloworld. You can create the helloworld directory in any location on your computer that you have permission to update. The helloworld directory will contain the Ant build file ( build.xml ). Create two sub-directories of the helloworld directory: src to contain the Java source file for the HelloWorld servlet and web that will contain the JSP file, static HTML file, images, and deployment descriptor. In the src directory, create an examples sub-directory. This directory corresponds to the package that contains the HelloWorld servlet. In the web directory, create two subdirectories: images, which will contain any images used by the Web application, and WEB-INF, which is a standard directory that contains the Web application deployment descriptor files. The following graphic describes the project directory hierarchy: medirectory Hierarchy of the HelloWorld Application 4. Create the Hello.java servlet Java source file and put it in the helloworld/src/examples directory. For sample Java code that you can copy and paste into your own Java file and a brief explanation of how to program a simple servlet, see Hello.java. 5. Create the hello.jsp JSP file and put it in the helloworld/web directory. For sample JSP code that you can copy and paste into your own JSP file and a brief explanation of how to program a simple JSP, see hello.jsp. 6. Create the web.xml Web application deployment descriptor and put it in the helloworld/web/web-inf directory. For sample XML that you can copy and paste into your own web.xml file and a brief explanation of the elements, see web.xml. 7. Create a default index.html page and put it in the helloworld/web directory. 8. Create the Ant build file ( build.xml ) that includes targets for compiling and packaging the Web application and put it in the helloworld directory. For a sample Ant build file that you can copy and paste into your own file, see Ant Build File to Compile and Package the Example. 9. In your own build file, update the tcserver.home property to fit your environment; it should point to the CATALINA_HOME of your tc Runtime installation. For example, if you installed tc Server Standard Edition in the /opt/pivotal directory, set the tcserver.home property in the build.xml file to something like the following: Copyright Pivotal Software Inc, x

58 <property name="tcserver.home" value="/opt/pivotal/pivotal-tc-server-standard release/tomcat a.release" /> 10. Right-click the following image and save it with name Pivotal_Logo.png to the helloworld/web/images directory. When you finish creating all the artifacts that make up the HelloWorld Web application, your directory structure and contents should look like the following: helloworld helloworld/build.xml helloworld/src helloworld/src/examples helloworld/src/examples/hello.java helloworld/web helloworld/web/hello.jsp helloworld/web/images helloworld/web/images/pivotal_logo.png helloworld/web/index.html helloworld/web/web-inf helloworld/web/web-inf/web.xml 11. Compile and package the HelloWorld Web application by opening a command window, changing to the helloworld directory, and executing the following command: prompt> ant all This ant command creates a deployable WAR file of the HelloWorld application called hello.war in the helloworld/dist directory. You will see the following output from the ant command if it completes successfully: Buildfile: build.xml clean: prepare: [mkdir] Created dir: /home/samples/helloworld/dist [mkdir] Created dir: /home/samples/helloworld/work/web-inf/classes [copy] Copying 4 files to /home/samples/helloworld/work compile: [javac] Compiling 1 source file to /home/samples/helloworld/work/web-inf/classes dist: [jar] Building jar: /home/samples/helloworld/dist/hello.war all: BUILD SUCCESSFUL Total time: 2 seconds 12. Start a tc Runtime instance. See Starting and Stopping tc Runtime Instances. 13. Deploy the Web application JAR file to the tc Runtime instance. See Deploying Applications to tc Runtime Instances. 14. Invoke the HelloWorld Web application in your browser: where: host is the name of the computer that is hosting the tc Runtime instance. If it is the same as the computer hosting your browser, you can use localhost. port is the port to which the tc Runtime instance listens. The default value is In the example, /hello is the default URL context of the Web application, which in this example is the name of the WAR package without the trailing.war file extension. For example: Copyright Pivotal Software Inc, x