HSI Configuration and Installation
This distribution has default configuration settings which will work for most environments. If you want to use the default values (recommended) you can skip to the section labeled Installation Instructions below. In certain environments (e.g., if your installation is on a machine which has more than one network interface or has a high bandwidth network connection to NERSC) you may want to change some of these default settings. To help with this an interactive Configure script is provided. To use it simply do
prior to installing. Configure will provide a description of the options you can change and allow you to set them as needed for your environment. After collecting input Configure will write any changes to ./config_opts. During the installation step config_opts is used to set basic configuration values.
Firewall Mode: [default: ON]. Firewall mode controls how network connections are built between HSI and the HPSS movers and whether multiple data connections are used during a transfer. Setting firewall mode to 'on' allows HSI to work on a machine that restricts incoming network connections. However, it also causes HSI to use a single network connection for transferring data rather than transferring data in parallel. Unless installing on a machine which has a high bandwidth network connection to NERSC it's unlikely having Firewall Mode set to 'on' will cause a significant decrease in performance. If you wish to use parallel data transfers set Firewall Mode to 'off' and be sure to read the rest of this section including the subsection labeled Firewall Considerations.
HPSS Host Name: [defaults to the installation machine's hostname]. If Firewall Mode is set to 'on' this option has no effect. If firewall mode is set to 'off' this option specifies the network interface that will be used for data transfers. This value can be assigned using either an IP address or a DNS name.
If HPSS Host Name is not set then the network interface bound to the name returned by the 'hostname' command will be used for data transfers. The interface specified by HPSS Host Name (or the one returned by the hostname command) must have a routable IP address over which the NERSC networks are reachable.
Use Port Range: [ default: OFF ] If Firewall Mode is set to 'on' this option has no effect. Otherwise this option controls whether a port range is used for mover connections. The default is to allow the operating system to assign the ports to use. If setting this option to 'on' a specific port range can be set with the "Mover Port Range" option.
Mover Port Range [default: 7500-7599]. If Firewall Mode is set to 'on' or if Use Port Range is set to 'off' this option has no effect. Otherwise this option sets the range of network ports that are used for mover connections. This allows a site to limit the number of ports over which they must allow incoming connections from NERSC networks. To allow for parallel transfers and for multiple HSI clients to execute on the host at once we recommend that a range of at least 100 ports be used.
Base Installation Directory [default: /usr/local] The installation root for the HSI software. This value can be overridden during the installation step by setting the INSTALL_PREFIX variable.
This distribution uses the 'make' program to install - usage is:
Usage: make [INSTALL_PREFIX=installation_directory] install
1. To generation files for installation:
2. To install HSI into its default location (/usr/local), or the location set when running the Configure command:
$ make install
This will fail unless you have write permission for the installation directory.
3. To override the installation directory to be /opt/nersc:
$ make INSTALL_PREFIX=/opt/nersc install
Note that you can also use INSTALL_PREFIX with the uninstall and clobber targets.
4. To clean up build area:
$ make clean
This is especially useful if you run Configure multiple times to change options.
5. To remove HSI:
$ make uninstall
6. To clean up build area, remove current installation, and attempt to remove old installations as well:
$ make clobber