Detailed Overview¶
This document outlines the overall installation process for an OSG site and provides many links into detailed installation, configuration, troubleshooting, and similar pages. If you do not see software-related technical documentation listed here, try the search bar at the top or contacting us at [email protected].
Plan the Site¶
If you have not done so already, plan the overall architecture of your OSG site. It is recommended that your plan be sufficiently detailed to include the OSG hosts that are needed and the main software components for each host. Be sure to consider the operating systems that OSG supports. For example, a basic site might include:
Purpose | Host | Major Software |
---|---|---|
Compute Entrypoint (CE) | osg-ce.example.edu |
OSG CE, HTCondor Central Manager, etc. (osg-ce-condor ) |
Worker Nodes | wNNN.cluster.example.edu |
OSG worker node client (osg-wn-client ) |
Prepare the Batch System¶
The assumption is that you have an existing batch system at your site. Currently, we support HTCondor, LSF, PBS and Torque, SGE, and Slurm batch systems.
For smaller sites (less than 50 worker nodes), the most common way to add a site to OSG is to install the OSG Compute Element (CE) on the central host of your batch system. At such a site - especially if you have minimal time to maintain a CE - you may want to contact help@opensciencegrid.org to ask about using an OSG-hosted CE instead of running your own. Before proceeding with an install, be sure that you can submit and successfully run a job from your OSG CE host into your batch system.
Add OSG Software¶
If necessary, provision all OSG hosts that are in your site plan that do not exist yet. The general steps to installing an OSG site are:
- Install OSG Yum Repos and the Compute Entrypoint software on your CE host
- Install the Worker Node client on your worker nodes.
- Install optional software to increase the capabilities of your site.
Note
For sites with more than a handful of worker nodes, it is recommended to use some sort of configuration management tool to install, configure, and maintain your site. While beyond the scope of OSG’s documentation to explain how to select and use such a system, some popular configuration management tools are Puppet, Chef, Ansible, and CFEngine.
General Installation Instructions¶
- Security information for OSG signed RPMs
- Using Yum and RPM
- Install the OSG Yum repositories
- OSG Software release series - look here to upgrade to OSG 3.5
Installing and Managing Certificates for Site Security¶
- Installing the grid certificate authorities (CAs)
- How do I get X.509 host certificates?
- Automatically updating the grid certificate authorities (CAs)
- OSG PKI command line client reference
Installing and Configuring the Compute Entrypoint¶
- Install the compute entrypoint (HTCondor-CE and other software):
osg-configure
Reference
Adding OSG Software to Worker Nodes¶
- Worker Node (WN) Client Overview
- Install the WN client software on every worker node – pick a method:
- Using RPMs – useful when managing your worker nodes with a tool (e.g., Puppet, Chef)
- Using a tarball – useful for installation onto a shared filesystem (does not require root access)
- Using OASIS – useful when CVMFS is already mounted on your worker nodes
- (optional) Install the CernVM-FS client to make it easy for user jobs to use needed software from OSG's OASIS repositories
- (optional) Install singularity on the OSG worker node, to allow pilot jobs to isolate user jobs.
Installing and Configuring Other Services¶
All of these node types and their services are optional, although OSG requires an HTTP caching service if you have installed CVMFS on your worker nodes.
- Install Frontier Squid, an HTTP caching proxy service.
- Storage element:
- Existing POSIX-based systems (such as NFS, Lustre, or GPFS):
- Install standalone OSG GridFTP: GridFTP server
- (optional) Install load-balanced OSG GridFTP: when a single GridFTP server isn't enough
- Hadoop Distributed File System (HDFS):
- Hadoop Overview: HDFS information, planning, and guides
- XRootD:
- XRootd Overview: XRootD information, planning, and guides
- Install XRootD Server: XRootD redirector installation
- Existing POSIX-based systems (such as NFS, Lustre, or GPFS):
- RSV monitoring to monitor and report to OSG on the health of your site
- Install the GlideinWMS VO Frontend if your want your users' jobs to run on the OSG
- Install the RSV GlideinWMS Tester if you want to test your front-end's ability to submit jobs to sites in the OSG
Get Help¶
If you need help with your site, or need to report a security incident, follow the contact instructions.