Pivotal Mac OS
Pivotal gemfire® is a realtime distributed data store that solves the hard problems of distributed systems for you. It provides a familiar java interface for interacting with data of arbitrary complexity and shape, and accommodates evergrowing data sets and users with linear scalability, continuous uptime and predictable performance. With gemfire, you can have data consistency in an elastic. Homebrew is the “missing package manager” for Mac OS X. Pivotal provides Homebrew formulas for developers who want to install and play with our commercial software on their development machines, and is not intended for commercial use. The tc Runtime RPM will is called pivotal-tc-runtime-9.0.6.B.RELEASE.noarch.rpm Start a terminal and change to the directory in which you downloaded the RPM. Execute the following rpm command to install tc Server and tc Runtime: rpm -Uvhf pivotal-tc-server-4.1.8.RELEASE.noarch.rpm rpm -Uvhf pivotal-tc-runtime-9.0.6.B.RELEASE.noarch.rpm.
Page last updated:
Warning: VMware Enterprise PKSv1.7 is no longer supportedbecause it has reached the End of General Support (EOGS) phase as defined by theSupport Lifecycle Policy.To stay up to date with the latest software and security updates,upgrade to a supported version.
This topic describes how to install the VMware Enterprise PKS Command Line Interface (PKS CLI).
To install the PKS CLI, follow the procedures for your operating system to download the PKS CLI from VMware Tanzu Network. Binaries are only provided for 64-bit architectures.
Mac OS X
- Navigate to VMware Tanzu Network and log in.
- Click Enterprise PKS.
- Select your desired release version from the Releases dropdown.
- Click PKS CLI.
- Click PKS CLI - Mac to download the Mac OS X binary.
- Rename the downloaded binary file to
pks
. - On the command line, run the following command to make the PKS CLI binary executable:
- Move the binary file into your
PATH
. - Run
pks --version
to verify the version of your PKS CLI installed locally.
Linux
- Navigate to VMware Tanzu Network and log in.
- Click Enterprise PKS.
- Select your desired release version from the Releases dropdown.
- Click PKS CLI.
- Click PKS CLI - Linux to download the Linux binary.
- Rename the downloaded binary file to
pks
. - On the command line, run the following command to make the PKS CLI binary executable:
- Move the binary file into your
PATH
. - Run
pks --version
to verify the version of your PKS CLI installed locally.
Windows
- Navigate to VMware Tanzu Network and log in.
- Click Enterprise PKS.
- Select your desired release version from the Releases dropdown.
- Click PKS CLI.
- Click PKS CLI - Windows to download the Windows executable file.
- Rename the downloaded binary file to
pks.exe
. - Move the binary file into your
PATH
. - Run
pks --version
to verify the version of your PKS CLI installed locally.
Please send any feedback you have to pks-feedback@pivotal.io.
- RHEL - Install Pivotal tc Server Standard Edition from an RPM
- Setting Up Unix Users for tc Server and VMware vCenter Hyperic
- Uninstalling tc Server - Typical Steps
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
- From the Pivotal tc Server download page.
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
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 theroot
user and usesu - tcserver
to become the user.Open a terminal (Unix) or command window (Windows) and create the main tc Server installation directory, such as
/opt/pivotal
.For example, on Unix:
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: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, thetomcat-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
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. Casino game studios.
Procedure
- Log in to the Mac OS X computer on which you will install Pivotal tc Server.
Execute the following
brew
commands:
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.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.
- On the RHEL computer, start a terminal either as the
root
user or as an unprivileged user who hassudo
privileges. 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 thesh
at the end, or the RPM installation fails.Use
sudo
to run the preceding commands if you are not logged in as theroot
user. For example: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.
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):The Pivotal tc Server RPM is called
pivotal-tc-server-standard
.
- On the RHEL computer, start a terminal either as the
Procedure
- From the RHEL computer on which you will install Pivotal tc Server, log in as the
root
user (or as an unprivileged user who hassudo
privileges) and start a terminal. Execute the following
yum
command: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 theroot
user. For example:Enter
y
at the prompt to begin the actual installation.If the installation is successful, you will 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, toroot:pivotal
. If the user does not already exist, adds a
tcserver
user (in the grouppivotal
). 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 theroot
user or as a privileged user usingsudo
, and thensu - tcserver
.Disney games whisks and wizards. Creates an empty directory called
/var/opt/pivotal/pivotal-tc-server-standard
and sets the owner totcserver: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
option of thetcruntime-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
- Log in to the RHEL computer on which you will install Pivotal tc Server as the
root
user (or as an unprivileged user who hassudo
privileges). - From the Pivotal tc Server download page.
- 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
. - Start a terminal and change to the directory in which you downloaded the RPM.
Execute the following
rpm
command to install tc Server:If necessary, use
sudo
to run the preceding command if you are not logged in as theroot
user. For example: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 therpm
command in this procedure.)
Install Hyperic Agent Plugin
Two versions of the Hyperic Agent plugin are available:
tc Runtime 8 Plugin
- Download the Pivotal tc Server plugin from the VMware Tanzu Network.
- Rename the plugin file
pivotal-tcserver-plugin.jar
. 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
- Download the Pivotal tc Server plug-in 2.9.x for VMware Hyperic from VMware Tanzu Network.
- 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
Pivotal Mac Os Download
- 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
- From the Pivotal tc Server download page.
Play hog games online free. 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
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 theroot
user and usesu - tcserver
to become the user.Open a terminal (Unix) or command window (Windows) and create the main tc Server installation directory, such as
/opt/pivotal
.For example, on Unix:
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, thetemplates
directory, thetomcat-version
directory, and so on.The
templates
directory contains a template calledinsight
that contains the Spring Insight application.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 thetcruntime-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 thetcserver
user can write to this directory and that the directory already exists.For example:
Windows: Change to the
optpivotalpivotal-tc-server-developer-version
directory and execute thetcruntime-instance.bat
script to create an instance: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: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: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
, whereunique-name
is a unique combination of server name and server directory.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*
Whereversion
is the version of the core Apache Tomcat on which this version of the tc Runtime is based, such astomcat-7.0.42.A.RELEASE
ortomcat-8.0.33.A.RELEASE
. These directories are the basic Apache TomcatCATALINA_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 thetcruntime-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 thetcruntime-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 thepivotal-tc-server-edition-version
directory with the same name as the new tc Runtime instance. This new directory is theCATALINA_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. Thebin
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
. Thebash_completion
directory contains scripts to enable the bash completion capabilities fortcruntime-instance.sh
,tcruntime-ctl.sh
, andtcruntime-admin.sh
. If you use abash
shell on a Unix-like system and you have thebash-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.The
CATALINA_HOME
variable points to the directoryINSTALL_DIR/pivotal-tc-server-edition-version/tomcat-version
, whereINSTALL_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-3.0.2
.RELEASE orstandard-3.0.2
.RELEASE); andversion
is the version of the underlying Tomcat, such as7.0.47.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 calledmyserver
and you are using the Standard Edition, then theCATALINA_BASE
of the instance isINSTALL_DIR/pivotal-tc-server-standard-version/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 fileCATALINA_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 orsetenv.sh
as follows: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 theCATALINA_OPTS
variable as follows:On Windows, the equivalent change would be to the
conf/wrapper.conf
file as follows: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 theINSTANCE_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 thetcruntime-ctl.*
scripts to start and stop tc Runtime instances, as well as thesetenv.*
scripts. The*.sh
Unix files are functional duplicates of the*.bat
Windows files.conf
. Contains the configuration files for the tc Runtime instance, such asserver.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 thecatalina.properties
file, in the same directory as theserver.xml
file.catalina.properties
. Properties file that contains the tc Runtime instance-specific values for variables in theserver.xml
file.context.xml
. Configures the context that is loaded by all Web applications deployed to the tc Runtime instance.web.xml
. Defaultweb.xml
file that is loaded by all deployed Web applications, in addition to their individualweb.xml
files.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
andjmxremote.password
. Configures the JMX users and passwords. The default JMX user, added at instance creation time unless you specify something different, is calledadmin
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 thebash-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 usesu
orsudo
to temporarily becomeroot
.
Procedure
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:Replace
/etc/bash_completion.d
with the path to thebash_completion.d
directory on your system, if it differs.With your regular user login, start a new
bash
shell or re-source your environment to allow thebash_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.
Pivotal Microsoft
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 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
- Log in as root and start a terminal session.
Use the
groupadd
command to create a new group. The following example creates apivotal
group:Note that if you installed from RPM on RHEL, the
pivotal
group may already exist.Use the
useradd
command to create a user for Hyperic Agent in the group you created in the previous step. The following example creates ahyperic
user in thepivotal
group: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 thehyperic
user.Install and run Hyperic Agent as this user.
Use the
useradd
command to create a user to run tc Server instances. The following example creates atcserver
user in thepivotal
group: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 thetcserver
user.Create the tc Server instance and run it as this user.
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. 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:
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:
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-3.0.2
.RELEASE/tcruntime-ctl.sh, you would add the following entry to /etc/sudoers
:
Uninstalling tc Server - Typical Steps
You can uninstall one or more of the following components:
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.
- If currently running, stop all tc Runtime instances. See Starting and Stopping tc Runtime Instances.
- Start a terminal window (Unix) or Command Prompt (Windows).
Windows only. If you installed any tc Runtime instances as Windows services, change to the
CATALINA_BASEbin
directory of each instance (such asvaroptpivotalpivotal-tc-server-standardmyserverbin
) and uninstall the service using the following command:Remove the main tc Server installation directory. For example, if you installed Standard Edition, the delete command might look something like the following:
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.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:
- If the agent itself is managed by Hyperic, remove the platform for the agent using the Hyperic user interface.
- Start a terminal window (Unix) or Command Prompt (Windows).
Remove the directory in which you installed the Hyperic Agent. For example: