Open.ControlTier > Documentation
 

Package Installation

Scope

This document describes how to install the ControlTier client for the first time.

The ControlTier client is based on the AntDepo framework and an AntDepo extension, called "commander". The ControlTier client package includes both the AntDepo framework distribution and the commander extension. Separate instructions exist for extension installation.

The core steps of the ControlTier client installation are the same for all platforms:

  1. Download the software
  2. Extract it into your chosen destination.
  3. Set up some environment variables to point to the client
  4. Configure the installation via the ad-setup command. This can be done later.

Step 1: Download

The first step is to download the software. Refer to the ControlTier download page for information about getting the software.

Note
The following steps are to be executed on each client machine.

Step 2: Install

The second step is to unpack and install the software. The installation directory must be constant across all machines where the client will be installed and should be writable by the client users. This directory is generally relative to the home directory of the user account above, but not required to be.

Zip Installation

The zip installation method is nearly identical to the AntDepo installation method described in the AntDepo installation doc.

To install the client from a Zip, extract the commander-<version>.zip as shown below:

unzip commander-<version>.zip

Move or rename the top level extracted directory to the location of choice.

RPM Installation

To install the client from an RPM, use rpm command as shown below:

rpm -i /path/2/commander-<version>.rpm [ --relocate /opt/ctier=/your/path ]
Note
Default install is into /opt/ctier directory with the commander-<version> as subDir to that.

Step 3: Environment Variables

The third step is to add the environment variables needed to use the client. To set the environment for Bash or Bourne shell, add the following to the profile file, usually .bash_profile or .profile. The settings for the profile file should look similar to the following:

	ANTDEPO_HOME=/opt/commander; #or wherever the client was installed
	export ANTDEPO_HOME
	PATH=$PATH:$ANTDEPO_HOME/bin

	ANTDEPO_BASE=~ctier/commander; #or your location the client configuration 
	export ANTDEPO_BASE
      

The environment settings for csh or tcsh have a different syntax but the same information, and go into the equivalent file, either .cshrc or .tcshrc.

	setenv ANTDEPO_HOME=/opt/commander; #or wherever the client was installed 
	setenv ANTDEPO_BASE=~ctier/commander

	setenv PATH=$PATH:$ANTDEPO_HOME/bin
      

For win32, use the Control Panel and locate the Environment Vairables tab. Create new variables for ANTDEPO_HOME and ANTDEPO_BASE.

Note
If you are not logged on as administrator to the local computer, the only environment variables you can change are user variables. Windows saves changes in the registry so they are available automatically the next time you start your computer. You might have to close and reopen running programs for the new settings to take effect.

Step 4: Framework Setup

The fourth step sets up the framework. The framework setup is done via the ad-setup command. It is also possible to pass command line arguments to customize the framework configuration.

Here is the ad-setup command usage:

ad-setup [-fv] -n hostname [ --<framework|modules>.<propertyName>=<value> ]

Some examples, are shown below:

# simple usage, using defaults
$ANTDEPO_HOME/bin/ad-setup -n hoho

# overriding defaults using key=value arguments
ad-setup -n hoho --framework.email.relayhost=mail.acme.com \
                 --framework.admin.email=admin@acme.com

Extension Configuration

After setup, the commander extension configuration file can be found here: $ANTDEPO_BASE/etc/extensions/commander/extension.properties. This file should be edited to change settings pertaining to the ControlTier server configuration.

Installation Troubleshooting

This section describes possible errors that might prevent the software from correctly working.

The cmdr command returns "ANT_HOME not configured error"

The likely cause of the error shown below is the failure to run the setup command. The client software includes its own distribution of Ant so you should not need to obtain or configure toanother copy. Run the setup command as shown in step four.

	$ cmdr
	ERROR: $ANT_HOME not configured or non-existent. 
      

Remote command execution is not functioning.

Login or su to the Commander userid on Commander node and execute the following to the suspected remote node:

	ssh <commanderClient> cmdr
      

No standard input should be required and the cmdr command syntaxs hould be displayed.