HOWTOs: SBGrid Installation Notes
Site Configuration
The SBGrid Software Suite is designed to be installed on a single computer at your site, which will then share that installation with all the workstations on your network via NFS. We refer to this computer as the site “master” server.
The master server will require at least 250 GB of free disk space on a case-sensitive file system and must run some variety of UNIX. The installation script will download the software branches you select, and then install a cron job that will run regularly to check for updates.
Click on the following image for a graphic detailing the common configuration of an SBGrid member laboratory:
Pre-Installation
| Installation Requirements | |
|---|---|
| Hard Drive Space | 250 GB required |
| Operating System | Linux, OS X and other UNIX |
| Privileges | Root account (Linux) or Administrator account (Mac) |
- Create a user account with the name “sbgrid” on the local SBGrid Master. Please set a difficult to guess password that is at least 8 alphanumeric characters long and store it in a safe place.
- Email accounts@sbgrid.org to request the installation script for the software. Be sure to include the following information in your email:
- Lab Name
- Types of computers on site: Linux, OS X Intel, OS X PowerPC
- The names and email addresses of lab members that will use the software. One user may be designated to receive the majority of our correspondence if you would prefer not to hear from us too often.
Once the email has been received and your information has been entered into our system, we will email you a script you will run that will begin the remote installation process. Instructions for running the script will be included in that email, and are reproduced below for reference.
Installation
- Create an 'sbgrid' user on the machine that will host your software installation.
- Log in as this 'sbgrid' user.
- Download the installation script from the URL provided in the account creation email.
- Make it executable:
chmod +x sbgrid-admin
- Run the script:
./sbgrid-admin -i
- The script will walk you through configuring your installation, downloading the software and installing a cron job that will keep the software updated at your site. You will need the site name and install key provided in the account creation email. The installation may take anywhere from several hours to a day, depending on your network and the number of applications available to your site.
Post-Installation Steps
- Add a symlink in the root directory of each machine that wants to use the software.
ln -s /path/to/sbgrid/installation /programs
- Any user that wishes to use the software needs to configure their shell to initialize the SBGrid shell environment. For bash and other sh-compliant shells, add the following line to your ~/.bash_profile or ~/.bashrc:
. /programs/sbgrid.shrc
For csh and tcsh, add the following line to your ~/.cshrc:
source /programs/sbgrid.cshrc
Advanced Configurations
The sbgrid-admin script has some additional configuration options to accommodate the installation requirements at different sites.
The ~/.sbgridrc configuration file for the sbgrid-admin script must contain a sitename and site key. All other configurations are optional.
| Option | Example | Description |
| SB_SITENAME | sbgrid-bene | The site name for your installation provided by SBGrid |
| SB_SITEKEY | xyxyxyxyxyxyxy | The installation key for your site provided by SBGrid |
| INSTALL_TARGET | /nfs/programs | The installation directory for the software |
| RSYNC_ARGS | ”–log-file=$HOME/sbgrid-admin.log” | Advanced arguments to rsync for the software download |
| HTTP_PROXY | host.name:port | Proxy hostname and port for use by rsync and curl |
| POST_UPDATE_SCRIPT | /absolute/path/to/script | Optional script to be run after a successful software update |
SGI IRIX Software Branch
Since the IRIX software branch is frozen and no longer receiving updates, it is not installed and updated in the same manner as the active software branches. In order to install the IRIX software branch, please run:
./sbgrid-admin -s
Note that the IRIX branch is only compatible with tcsh; there is no sh-compatible configuration for this branch.
