Chapter 2, Installing CST -

Chapter 2 -

Installing CST

This chapter provides information on the following topics:

Introduction

CST Server Installation

CST Agent Installation

Installing the CST Software in the Sun Management Center Environment

Uninstalling CST Software

Decommissioning CST

Introduction

CST3.0 software has the following packages:

SUNWcstu

SUNWcstu is the CST3.0 core package which contains both server component and agent component. Server component should be installed on the CST server (middleware) machine and agent component should be installed on each monitored host. Based on the user's choice during the install, the corresponding component will be installed on the machine automatically.

SUNWcstu supports both standalone or Sun Management Center environment.

SUNWecsts

SUNWecsts is the CST service module to be installed on the Sun Management Center server to communicate between CST and Sun Management Center. SUNWecsts is bundled within CST3.0_Sun Management Center compressed files.

SUNWecst

SUNWecst is the CST agent module to be installed on Sun Management Center agent to communicate between CST and Sun Management Center. SUNWecst is bundled within CST3.0 Sun Management Center compressed files.

Note - In a stand-alone environment, you only need SUNWcstu.

Supported Install Options

Fresh install
To install CST on Sun machine for the first time. Once any version of CST has been installed, installing another version is an upgrade and is not considered a fresh install.

Upgrade install
A version of CST has been installed, and can be upgraded to CST 3.0. All versions of CST can be upgraded to version 3.0 except versions 1.0.1 and 1.1.3.

Reinstall after the Operating System upgrade
CST has been installed on the machine before, and after the operating system upgrade, all the data was removed from disk. You can reinstall CST in such a way that detect the OS upgrade and restore all the original CST data back to the system.

Server install
Install the server component on the machine, which will serve as the CST middleware (server).

Agent install
Install the agent component on each host to be tracked for any configuration changes.

Sun Management Center Install within Sun Management Center framework
CST3.0 supports Sun Management Center 3.0. CST server component should be installed on Sun Management Center server and agent component should be installed on Sun Management Center agent.

Install within Sun Remote Services Net Connect framework
CST 3.0 can be installed and co-exist on machines running Sun Remote Services (SRS) Net Connect version 3.0. Net Connect 3.0 is a no cost, Web-based, self-monitoring system. To download SRS Net Connect 3.0, visit the Website: https://www.srsnetconnect3.sun.com.

During OS Upgrades

Ensure that a copy of CST is running on the systems at all times. Note that CST is not automatically installed as part of an OS upgrade. It must be added later.

Supported CST Upgrades

CST3.0 supports upgrading from the following CST versions:

CST 1.5.1

CST 1.5.1_AMS

CST 2.1U1

CST2.1U1_AMS

CST1.5

CST1.5_AMS

CST2.1

CST2.1_AMS

CST3.0 does not support an upgrade from CST 1.0.1 or CST 1.1.3_AMS.

CST Server Installation

CST Server Requirements

The requirements for the CST server are listed below:

The middleware machine needs a central repository, which is a ufs (UNIX) file system, reserved to hold configuration and change history data for all other CST monitored nodes. For example:

/export/cst_database

The space required to hold data for one node for one year is approximately two megabyte (2.0 MByte). Thus, for CST to track 100 nodes, the ufs file system allocated needs to be around 200 MBytes per year.

The machine needs to have a Web server installed and running so the CST applet can be downloaded to a client browser, such as Netscape. Some popular Web servers are available for downloading from their respective sites.

[non-binding requirement] To remotely track the FRU hardware information for SunFire system controllers, the CST middleware machine requires that either the package, SUNWfrusg, or the set of (optional) FRU ID packages is installed. Please, contact your Sun representative for more details.

Since the FRU related libraries have a dependency on Solaris 8, there is a constraint that a CST middleware machine should have Solaris 8 installed. However, note that there is NO install dependency between CST packages and the FRU related packages. The FRU packages can be installed at any time, and CST will start using the libraries when they are available.

Caution - Do not install or upgrade the middleware and the agent software concurrently.

To Prepare for CST Server Installation

Have the following information available before you start to install SUNWcstu on the CST server machine.

The root path for the ufs file system served as CST database. It is usually something like /export/cst_db. See CST Server Requirements.

The path to the docs (or htdocs for Apache) directory of the http (Web) server. It is generally where the index.html resides. If you are not sure about this, do the following:

a. Type ps -ef |grep httpd to verify that httpd daemon is running.

b. Find the root path to the docs based on httpd path.

If you are installing SUNWcstu on a middleware server for the first time, go to To Install CST Server for the First Time.

If you are upgrading SUNWcstu on a middleware server where the CST server is already installed, go to To Upgrade CST Server.

To Install CST Server for the First Time

Note - While installing CST, remember that the CST software is only `freshly installed' the first time. A "fresh installation" of CST software means that no CST files or data exist on the agent system, nor its server. If CST was running prior to an OS upgrade, the CST installation following the OS upgrade is treated as an upgrade not a fresh installation. Therefore, answer "No" when the installation script asks, "Is this the first time you have installed CST on this system?" This way, CST can extract the previous data from the server and detect the OS upgrade.

1. Log in as superuser into the system that will be the middleware server.

2. Go to the directory on the server where the SUNWcstu package is available. Type:

# cd <path to SUNWcstu>

3. Install the package. Type:

# pkgadd -d . SUNWcstu

4. During the install, closely monitor the comments from the install process and answer questions as they occur.

The installation script asks for several bits of information, including the CST central file system root directory path and the root path where the HTTP documents are located.

Note - If HTTP ROOT is null, none of the applet files are installed.

5. One of the questions asked is, "Do you want to install a server or agent?" Select server.

6. If the installation of SUNWcstu is successful, the following message displays:

Installation of <SUNWcstu> was successful.

7. To verify the CST server component has been installed properly, type:

ps -ef|grep cst

The CST daemon, cstd.svr, and csthb.svr should be up and running.

This indicates that the server package is installed, has initiated configuration tracking on this system, and has the directory structure set up to hold data for other hosts that will use this server as the middleware.

To Upgrade CST Server

CST 3.0 supports upgrades from all previously installed CST server versions. The upgrade is a pkgadd, so much of the procedure is automated.

1. Log in as superuser.

2. Remove the existing CST server packages. Type:

# pkgrm SUNWcstve or # pkgrm SUNWcstv

3. Change directories to the directory on the server where the SUNWcstu package is available. Type:

# cd <path to SUNWcstu>

4. Install the package. Type:

# pkgadd -d. SUNWcstu

5. As CST already saved data in /var/opt/SUNWcst, the install script does not ask you any directory or path questions. The script automatically installs the server component.

CST Agent Installation

The CST application that resides on each Sun machine to be monitored by CST is the CST agent.

CST 3.0 is supported on Solaris operating environment versions 2.6, 7, 8, and 9. CST does not support Solaris 2.5.1.

Caution - Ensure that the SUNWcstu server component on the middleware machine has been installed or upgraded before installing SUNWcstu on the agent machine.

To Prepare for CST Agent Installation

Have the following information available before you start to attach a SUNWcstu agent component to a server:

Name and domain of the middleware to which the CST agent will be reporting.

The hierarchy on the middleware where you want the CST data to be saved. During a fresh install, pay attention to the hierarchy view. A good hierarchy design enables quick identification of systems when a large number of systems are tracked. The hierarchy could be designed using one or more of the following:

1. System locations--lab, offices, remote, etc.

`lab1/...`	`servers/...`	`data_center/...`
`lab2/...`	`offices/...`	`remote_centers/...`

2. System owners/maintainers

lab/Catherine/...

lab/John/...

3. Functions performed by systems

data_center/billing/...

data_center/inventory/...

data_center/Sales/...

4. Similar systems

lab1/E10Ks/...

To Install CST Agent for the First Time

The CST agent, SUNWcstu, must be installed on each host (node) to be tracked by CST.

1. Log in as superuser.

2. Change directory to the release directory where CST packages are located. Type:

# cd <path to SUNWcstu>

3. Add SUNWcstu package by typing this command:

# pkgadd -d . SUNWcstu

4. Answer any questions as they are presented.

Note - When you install the CST agent component for the first time, the CST agent is run in the unattached mode. You need to attach the agent to the server.

To Attach an Agent to the CST Server

When an agent is installed and it has not been previously attached to a middleware, you must bind the CST agent to the CST middleware system by running either the cstattach utility or the cstattagt utility.

The cstattach utility must be executed from the CST server.

After successful CST agent install, the cstattagt utility is executed from the host where the agent is running.

By attaching an agent to CST middleware system, you can:

View the data of the attached agents collected in the repository of the CST server.

View the CST agent data through CST Graphical User Interface (GUI). The data includes system events, system configuration, and system availability data.

Annotate an outage event cause code using GUI or command line interface.

The usage format is:

cstattach [-h hierarchy] <agentname> <agentkey> [middleware]

Note - For details on this utility, Chapter .

To Upgrade CST Agent

CST 3.0 supports upgrading the CST agent from all the previous CST versions except CST 1.0.1 and CST 1.1.3_AMS and for situations where the CST 3.0 agent is uninstalled and reinstalled.

Steps

1. Log in as superuser.

2. Remove the existing CST agent packages. Type:

# pkgrm SUNWcst

3. Change directories to where SUNWcstu is installed. Type:

# cd <path to SUNWcstu>

4. Install the package. Type:

# pkgadd -d .SUNWcstu

To Reinstall CST Agent After OS Upgrade

Caution - If you upgrade your operating system on the CST server machine after you have installed and operated CST, the CST data stored on the server in the CST repository is lost unless you back up the data prior to the OS upgrade.

If CST is installed on the machine and attached to CST middleware, before the operating system (OS) upgrade, after the OS upgrade, all the previously collected data stored on the machine disk is unavailable. You can reinstall CST following the below procedure so CST tracking can be reinstated.

Steps

1. Log in as superuser.

2. Change directories to where SUNWcstu is installed. Type:

# cd <path to SUNWcstu>

3. Install the package. Type:

# pkgadd -d .SUNWcstu

4. From the displayed choices, select Install Agent.

5. When the install script asks if you want to restore the date, Answer Yes.

6. To restore the data to the machine, follow the procedure displayed on your screen.

To Install CST Agent Component on a Multi-domain Server

Sun multi-domain servers include either a system service processor (SSP) or a system controller (SC). The installation of CST on a multi-domain server works the same in both of these types of platforms.

CST on the SSP or SC and CST on the domains collectively give the complete information regarding the multi-domain platform. It is required that you install CST first on the SSP or SC and then on the domains. Be aware that, by default, the CST agent installs in unattached mode, and the agent is required to be attached to a running CST middleware.

The CST attach functionality is designed to ensure a consistent hierarchical structure within the hierarchical view for the multi-domain server supported by its SSP or SC.

1. Install SUNWcstu on the SSP or SC.

It may take SUNWcstu up to 30 minutes to probe the SSP or SC configuration. During this time, the CST SC software automatically detects the platform, and SSP names and creates the appropriate hierarchy.

2. Install SUNWcstu on all the existing domains.

3. Whenever a new domain is added, install SUNWcstu on that domain.

Installing CST on a Sun Cluster

Installing CST on a Sun trademark Cluster is essentially installing CST on its individual nodes. The installation on various nodes can be done in any sequence. No specific setup is required. CST 3.0 can track events from Sun Cluster 3.0 and Sun Cluster 3.1.

Note - For easy manageability, ensure that, during install, the various nodes of a cluster are grouped closely within a well defined hierarchy.

To Attach a Multi-domain Agent to CST Server

These guidelines apply to the following Sun system platforms.

Sun Fire 15K domains and system controller

Sun Enterprise 10000 (E10k) domains and SSP

Other multi-domain systems, including Sun Fire 3800, 4800, 4810, and 6800 domains and system controllers

cstattach on the Domains

It is recommended that the domains be grouped together using the following hierarchy guideline. The hierarchy can be specified using the
-h option when using the cstattach command.

[USER_DEFINED_HIERARCHY]/[PLATFORM_NAME]

USER_DEFINED_HIERARCHY is optional. When you use the hierarchy option, the Sun Fire system or E10K platform name should be added at the end of the hierarchy value.

Example 1

This command includes an F15K with the platform name "clyde." Type:

# cstattach -h department1/group2/clyde sunfiredomain1.eng.sun.com 123456

Example 2

Same node with no user defined hierarchy

# cstattach -h clyde sunfiredomain1.eng.sun.com 123456

cstattach on Sun Fire 15K System Controller

CST provides support for the following tracking on a SSC:

SSC host tracking data (similar to domain systems). The attach process can be accomplished using cstattach.

Global platform tracking data. The attach process is a manual procedure and is optional.

To attach an SSC system, the hierarchy should be in the following format:

[USER_DEFINED_HIERARCHY]/[PLATFORM_NAME]/SSC

The difference from the domain is that the fixed word, SSC, is added at the end of the platform hierarchy command.

Example

# cstattach -h clyde/SSC sunfiressc1.eng.sun.com 123456

To attach global platform data, use the following procedure:

1. Log into the main SSC system.

2. Change to the directory where platform data is stored. Type:

cd /var/opt/SUNWcstu/ssc

3. Create a compressed (tar) file of the data stored in that directory. Type:

tar cvf /tmp/ssc.tar *

This creates a file named ssc.tar.

4. Transfer the tar file to the CST middleware system and extract the content to the path:

[repository_path]/[USER_DEFINED_HIERARCHY]/[PLATFORM_NAME]

5. Unlock the platform tracking functionality. This can be accomplished by writing a 0 to the file, /var/opt/SUNWcstu/ssc/comm_lock, on the system controller.

cstattach on an E10K System Service Processor (SSP)

CST provides support for the following tracking on an E10K SSP:

SSP host tracking data (similar to domain systems) The attach process can be accomplished using the cstattach utility.

Global platform tracking data. the attach process is a manual procedure and is optional.

To attach an SSP system, the hierarchy should be in the following format:

[USER_DEFINED_HIERARCHY]/[PLATFORM_NAME]/SSP

The difference in the command from usage on a domain is that the fixed word, SSP, is added at the end of the platform hierarchy command.

Example

The E10K platform in this example has the name, clyde.

# cstattach -h clyde/SSP e10kssp1.eng.sun.com 123456

To attach the global platform data, use the following procedure:

1. Log into the main SSP system.

2. Change to the directory where platform data is stored. Type:

cd /var/opt/SUNWcstu/ssp

3. Create a compressed (tar) file of the data stored in that directory. Type:

tar cvf ssp.tar *

This creates a file named ssp.tar.

4. Transfer the tar file to the CST middleware system and extract the content to the path:

[repository_path]/[USER_DEFINED_HIERARCHY]/[PLATFORM_NAME]

5. Unlock the platform tracking functionality. This can be accomplished by writing a 0 to the file, /var/opt/SUNWcstu/ssp/comm_lock, on the E10K service system processor.

To Verify Installation

There are two scenarios when you verify installation:

To verify an unattached agent
Perform step 1 below.

To verify an attached agent
Perform steps 1, 2 and 3 below.

Steps to Verify Installation

1. Once you finish installing the SUNWcstu agent component, there should be two processes running;

cstd.agt

csthb.agt

Verify this by typing:

% ps -ef | grep cst

2. From any system, bring up a browser and go to the CST applet. Type this URL in your browser address field:

http://<middlewarename>/cstj2.htmlor
http://<middlewarename>/cst.html

Where <middlewarename> is the host name where you installed the CST middleware. cstj2.html, using java plug-in technology, has a much improved performance for the applet.

3. Look for the host where the new CST agent was installed. Browse the information presented in the applet.

Installing the CST Software in the Sun Management Center Environment

The CST software consists of three packages:

SUNWcstu--installed on the Sun Management Center server for CST functionality

SUNWecsts--installed on the Sun Management Center server to communicate between CST and Sun Management Center

SUNWecst--installed on each Sun Management Center agent to communicate between CST and Sun Management Center

Note - Install CST on the server first, then on the agent machines. The installation script will ask you each time whether you are installing the server or agent component. The server script installs the server component of SUNWcstu first, then SUNWecsts. The agent script installs the agent component of SUNWcstu first, then the server component of SUNWcstu, then SUNWecst.

Before you begin this procedure, Sun Management Center must already be installed, configured, and running. See the Sun Management Center 3.0 Software User's Guide for further instructions.

CST server and agent processes are started automatically as soon as the software is installed.

Installation Package Disk Space Requirement

Install the CST 3.0 server packages on the Sun Management Center server, and install the agent packages on each agent machine. The space requirements are described in TABLE 2-1:


Package Name	Installation Location	Disk Space Needed
SUNWcstu	Server	8.1Mbytes
SUNWecsts	Server	444 Kbytes
SUNWecst	Agent	73 Kbytes

To Prepare for CST Installation in Sun Management Center Environment

1. Become superuser.

2. Download CST 3.0 from the Sun Management Center Website:

http://www.sun.com/software/sunmanagementcenter

Note - You are asked to specify the directory in which to save the CST tar file. For the purpose of these instructions, this directory is referred to as <tmp_dir>.

3. Change directories to the location of the downloaded tar file. Type:

# cd <tmp_dir>

4. Uncompress and untar the CST tar file. Type:

# uncompress CST3.0_SunMC.tar.Z

# tar xvf CST3.0_SunMC.tar

This command creates a directory in tmp_dir called image, and places the CST source packages in it.

5. Listed below are the questions within the installation script. Be prepared with the answers to these questions before you run the installation script.

Do you want to install the product: Configuration & Service Tracker (CST)? (y)

Do you want to install CST Server Component? (y)

Do you want to install CST Agent Component? (Answer y if installing the agent. Answer n if installing the server.)

Enter the source directory: (such as <tmp_dir>/image)

The following questions are the same as those asked when installing the Stand-alone version.

Note - The Sun Management Center agent is automatically stopped and restarted by the CST installation script.

The set of questions you receive depends on the installation procedure you perform. Not all of the above questions are asked during your installation.

To Install CST in Sun Management Center Environment

1. Become superuser.

2. On the system using the Sun Management Center server software, change directories to the root path where Sun Management Center is installed. The default path is /opt/SUNWsymon, but the exact path can be different and is determined by the user.

3. Run the installation script from the directory where the Sun Management Center software resides. Type:

# /opt/SUNWsymon/sbin/es-inst

The script installs both server packages. Answer the resulting installation questions based on your installation requirements. The script informs you when the installation is complete.

Note - The installation script displays the prompt: "This script will help you to install the Sun Management Center software." This does not reinstall Sun Management Center basic software. The message refers to CST only, which is a Sun Management Center add-on application.

Note - After the CST installation is completed, answer n to running the setup procedure.

The CST 3.0 software is installed in /opt/<SUNWcstu> by default. However, the installation script will allow you to enter another path if you prefer.

4. Verify the installation of both CST server packages by checking for the CST daemon processes. Type:

# ps -ef | grep cst

The output could look similar to this if both processes are running:

root 13855     1 0 11:44:17 ?        0:00 csthb.svr

root 13846     1 0 11:44:16 ?        0:00 /opt/SUNWcstu/bin/cstd.svr option

5. On the server system, verify that the CST service agent process within Sun Management Center has started. Type:

# ps -ef | grep esd

The output could look similar to this if the process is running:

root 19666 1 0   Oct 10 ?   1:36 esd - init cstservice -dir /var/opt/SUNWsymon -q

This step is only necessary for server installation. You can skip this step for agent software installations.

6. Now that the CST server software is installed, follow steps 1 through 4 to install the CST 3.0 agent software on each Sun Management Center agent.

When installing the agent software, the script uses the words "agent component" wherever you saw "server component." Both agent packages are installed in this process.

The installation script prompts you for the name of the CST server to which the agent reports.

Note - The CST agent is already a part of the CST server. You do not need to separately install the agent on the server system.

Note - Only the CST agent package can be installed on an E10K SSP, and on a Sun Fire 15K and Sun Fire 12K system controller.

To view an agent under the Sun Management Center console, follow the steps outlined in the Chapter 3, Getting Started. That chapter provides information on how to start Sun Management Center and view each machine through the CST console.

To Upgrade CST in Sun Management Center Environment

1. Log in as superuser.

2. Remove any previously installed versions of the CST software.

To check for previously installed versions, type:

# pkginfo | grep cst

Each detected CST package will be listed.

Each listed package must be removed before you install the new version of CST.

3. To remove the packages, type the following:

# pkgrm package_name

On systems where CST server software was installed, the package names are SUNWcstve or SUNWcstv and SUNWecsts. For agent software, the package names are SUNWcst and SUNWecst.

During package removal, answer the script questions as they display. The messages notify you when the package removal is complete and successful.

Note - If a previous CST package is not removed before the new software is installed, any new package of the same name will not be installed by the script. For instance, if the 2.1 SUNWcstve package remains on your system, the 3.0 SUNWcstu package will not be installed. Use the command, pkginfo | grep cs, to check for old packages.

4. On the system using the Sun Management Center server software, change directories to the root path where Sun Management Center is installed. The default path is /opt/SUNWsymon, but the exact path can be different and is determined by the user.

5. Run the installation script from the directory where the Sun Management Center software resides. Type:

# /opt/SUNWsymon/sbin/es-inst

The script installs the CST add-on packages. Answer the resulting installation questions based on your installation requirements. The script informs you when the installation is complete.

Note - After the CST installation is completed, answer No to running the setup procedure.

The CST software is installed in /opt/<SUNWcstu> by default. However, the installation script will allow you to enter another path if you prefer.

6. Verify the installation of the CST server packages by checking for the cstd.svr and csthb processes. Type:

# ps -ef | grep cst

The output could look similar to this if both processes are running:

root 13855     1 0 11:44:17 ?        0:00 csthb.svr 1

root 13846     1 0 11:44:16 ?        0:00 /opt/SUNWcstu/bin/cstd.svr

7. On the server system, verify that the CST service agent process within Sun Management Center has started. Type:

# ps -ef | grep esd

The output could look similar to this if the process is running:

root 19666 1 0   Oct 10 ?   1:36 esd - init cstservice -dir /var/opt/SUNWsymon -q

This step is only necessary for server installation. You can skip this step for agent software installations.

8. Now that the CST server software is installed, follow steps 1 through 4 to install the CST 3.0 agent software on each Sun Management Center agent.

When installing the agent software, the script uses the words "agent component" wherever you saw "server component." Both agent packages are installed in this process.

9. The CST agent is installed and run in unattached mode. Please, refer to the cstattach section to attach the agent to the CST server.

Note - Only the CST agent package can be installed on an E10K SSP, and on a Sun Fire 15K and Sun Fire 12K system controller.

Uninstalling CST Software

To uninstall previous versions of CST, see Step 1 of To Prepare for CST Installation in Sun Management Center Environment. There is currently no support for uninstalling Sun Management Center add-on packages using the es-uninst script.

Caution - Do not remove the repository directory from the CST server that was created when CST was first installed. CST collected data will be lost if the repository directory is removed.

To Uninstall CST 3.0 Software

1. Become superuser.

2. Check for existing packages. Type:

# pkginfo | grep cst

3. Remove the CST packages installed on your machine, one package at a time. Type:

# pkgrm package_name

4. Repeat until all packages are removed.

5. If you want to also remove the CST software footprint left on the machine (required if you want to perform a fresh install of CST), type:

# rm -rf /var/opt/SUNWcst

Caution - On your server system, you must remove SUNWecsts first, then SUNWcstu. On an agent, remove SUNWecst first, then SUNWcstu.

Note - If you want to totally remove CST and want to perform a fresh install, you must remove the directory, /var/opt/cst, on the agent machine.

Decommissioning CST

When the tracking of events is to be stopped on a host, such that availability tracking and reporting for this host can be terminated on the Sun side, cstdecomm utility needs to be executed.

Execution of this utility accomplishes the following:

1. Appends a marker event called "Tracking Ended," to the history file

2. Moves the data for this host to a separate "Decommissioned Agents" directory

3. Detaches the host from the middleware

See Chapter 6, Utilities, cstdecomm, for details on this utility.