RCS-INFO @(#) $Id: README,v 1.9 2000/11/15 15:45:12 ivm Exp $ ------------------------------------------------------------------------ R E A D M E Product Name: FBSNG - Farm Batch System (new generation) Product Versions: v1_2 Date (mm/dd/yyyy): 11/15/2000 ------------------------------------------------------------------------ ORIGIN ====== Authors Jim Fromm, Krzysztof Genser, Tanya Levshina, Igor Mandrichenko Farms & Clustered Systems Group Fermi National Accelerator Laboratory - Mail Station 369 P.O Box 500 Batavia, IL 60510 Internet: fbs-support@fnal.gov Fermilab Standard Government Sponsorship Notice This work was performed at Fermi National Accelerator Laboratory, which is operated by Universities Research Association, Inc., under contract DE-AC02-76CHO3000 with the U.S. Department of Energy. Acknowledgements Since FBSNG inherits major design ideas, overall structure and substantial portion of the source code from its predecessor FBS, authors of FBSNG would like to acknowledge valuable contribution to the project made by former members of FCS group Mark Breitung and Marilyn Schweitzer, who participated in development of FBS. The authors wish to acknowledge the following people who have added much to this software through comments, suggestions, and testing: Antonio Wong Chan (Academia Sinica (Taiwan), CDF collaboration) Yen-Chu Chen (Academia Sinica (Taiwan), CDF collaboration) Thomas Las (Minooka, IL Junior High School) Miroslav Siket (Academia Sinica (Taiwan), CDF collaboration) Heidi Schellmann (Northwestern University, D0 collaboration) Steve Wolbers (Fermilab, CDF collaboration) Ping Yeh (Academia Sinica (Taiwan), CDF collaboration) ------------------------------------------------------------------------ TERMS AND CONDITIONS ==================== This software has been made freely available with a request for collaborative input subject to standard Fermitools Terms and Conditions given in full below. ------------------------------------------------------------------------ PRODUCT DESCRIPTION =================== FBSNG is a batch system designed for a farm architecture. Traditional batch system features such as job submission, job queueing, and load balancing are built into the system. Major features of FBSNG are: + Parallel Batch Jobs: FBSNG job is a collection of sections. Each section is an array of identical, potentially co-operating, processes running on one or more farm nodes (worker nodes). User may specify conditional dependencies of sections of the same job on one another. + Flexible Farm Configuration: FBSNG Administrator defines the farm configuration in terms of computational resources such as CPU power, disk storage, magnetic tape drives available on each farm node (worker node). FBSNG allows unlimited number of resources of several types to be defined for the farm. + Dynamic Farm Configuration: FBSNG Administrator can modify farm configuration using interactive configuration utility or GUI without re-starting FBSNG. Dynamic farm configuration functionality is also provided through FBSNG API. + Load Balancing: FBSNG requires users to specify amount of resources required for each batch process and each section as a whole. Based on such resource requirements, current availability of the resources on the farm, and other farm configuration parameters, FBSNG Scheduler makes the decision when and where to start the batch process. + FBSNG Scheduler: FBSNG has fully customizable Scheduler. It allows to be set up to achieve a variety of different configurations based on particular installation requirements. + FBSNG API: FBSNG provides Application Programming Interface (API). API allows users and administators to develop custom job monitoring, control and farm configuration tools. Currently, only Python binding of API is available. + Kerberos authentication support: FBSNG has an option to use Kerberos for user authentication. Also, FBSNG can create Kerberos credentials for batch processes. Documentation ------------- The following documentation is packaged with each version: FILE FORMAT DESCRIPTION ================= ====== ========================= README ASCII General, Very Basic Overview, License information doc/users_guide.ps Postscript Users Guide doc/admin.ps Postscript Installation and Administration Guide doc/API_Ref.ps Postscript API Reference Manual doc/Release_Notes_v1.2.txt ASCII Release Notes doc/resources.ps Postscript Resources Concepts doc/scheduler.ps Postscript FBSNG Scheduler In addition, please see the online information at: http://www-hppc.fnal.gov/fbsng Required Hardware and Software ------------------------------ FBSNG is written primarily in Python, but has some C-language and C++ sources as well. FBSNG requires library named FCSLIB to be installed. The library is freely available from Fermi Tools under the same license. FBSNG requires Python 1.5 or later version. FBSNG GUI requires Python to be built with Tcl/Tk support. Although not required for FBSNG operation, node resource utilization monitoring tool "xsysmon" included in FBSNG distribution requires rstatd to run on nodes to be monitored. Rstatd is standard UNIX program and is not included in FBSNG package. FBSNG is currently supported under UNIX (IRIX and OSF1 platforms) and Linux operating systems. Product Installation and Maintenance ------------------------------------ FBSNG, excluding source code, is packaged as follows: README - general, very basic overview doc - directory containing documentation man - directory containing manpages ups - directory of scripts to setup the correct user environment at Fermilab lib - directory containing FBSNG libraries bin - directory containing FBSNG non-customizable executables templates - directory containing templates of scripts and configuration files that should be customized for each FBSNG installation. Installation, maintenance and support procedures are documented in FBSNG Installation/Administration Guide that is packaged with the FBSNG product. ------------------------------------------------------------------------ SUPPORT ======= Help with the installation or use of FBSNG is available by sending mail to fbs-support@fnal.gov which is auto-forwarded to the group in charge of FBSNG support at Fermilab. This software is furnished by Fermilab on an "as is" basis as a service to the wider community with the goal of stimulating collaborative use and further development. Provision of the software implies no commitment of support by Fermilab. The Fermilab Computing Division is open to discussing other levels of support for use of the software with responsible and committed users and collaborators. Use of the software in experiments at Fermilab will be assured of a level of support as agreed to through the standard Memorandum Of Understanding process. Users may send mail to the mail address given above, with the expectation that it will be read and noted. ------------------------------------------------------------------------ TERMS AND CONDITIONS IN FULL ============================ ------------------------------------------------------------------------ Fermitools Software Legal Information - June 16, 1999 ------------------------------------------------------------------------ COPYRIGHT STATUS: Fermi National Accelerator Laboratory (FNAL) documents are sponsored by the U.S. Department of Energy under Contract No. DE-AC02-76CH03000. Therefore, the U.S. Government retains a non-exclusive, royalty-free license to publish or reproduce these documents or software for U.S. Government purposes. All documents and software available from this server are protected under the U.S. and Foreign Copyright Laws, and FNAL reserves all rights. EXPORT CONTROL: All documents and software available from this server are subject to U.S. export control laws. Anyone downloading information from this server is obligated to secure any necessary Government licenses before exporting documents or software obtained from this server. Failure to obtain export licenses may result in penalties, including fines and/or imprisonment, under U.S. laws. Terms and Conditions -------------------- o Distribution of the software available from this server is free of charge. When a User obtains a software package included in the Fermilab Software Tools Program, the user agrees to abide by the Terms and Conditions of the Program below: o Any redistribution and/or modification of the software shall be accompanied by this README file. o The User shall acknowledge the origin of the software as set forth below: "This work was performed at Fermi National Accelerator Laboratory, operated by Universities Research Association, Inc., under contract DE-AC02-76CH03000 with the U.S. Department of Energy." o The user is asked to feed back problems, benefits, and/or suggestions about the software to the Fermilab Software Providers and/or Fermitools management. Indemnification by User of Third Party Claims and Disclaimer of Liability ----------------------------------------------------------------------- The User, his/her directors, officers, employees, and agents hereby release and waive all claims against Universities Research Association, Inc. (URA) operator of Fermi National Accelerator Laboratory, its trustees, overseers, directors, officers, employees, agents, subcontractors, successors and assigns, for any and all liability and damages arising from the reproduction, use or other disposition of the software. The User agrees that URA, its trustees, overseers, directors, officers, employees, agents, subcontractors, successors and assigns shall not be liable under any claim, charge, or demand, whether in contract, tort, criminal law, or otherwise, for any and all loss, cost, charge, claim, demand, fee, expense,or damage of every nature and kind arising out of, connected with, resulting from or sustained as a result of the use of the software programs available from this server. In no event shall URA be liable for special, direct, indirect or consequential damages, losses, costs, charges, claims, demands, fees or expenses of any nature or kind. The User shall indemnify URA and the U.S. Government for all damages, costs or expenses, including attorney's fees, arising from the utilization of the software, including, but not limited to, the making, using, selling or exporting of products, processes or services derived from the Software. The User agrees to indemnify, hold harmless and defend URA, its trustees, overseers, directors, officers, employees, agents, subcontractors, successors and assigns, against any and all liability, damage, loss, cost, charge, claim, demand, fee or expense of every nature and kind which may at any time hereafter be sustained by URA by reason of claims of third parties arising out of alleged acts or omissions of the User in the reproduction, use or other disposition of the Software. Disclaimer of Warranties ------------------------ The software is provided on an "as is" basis only. URA makes no representations, express or implied. URA MAKES NO REPRESENTATIONS OR WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, apparatus, product or process disclosed, or represents that the Software will not infringe any privately held patent, copyright, or trademark. The entire risk as to the results and the performance of this software is assumed by the User. Disclaimer of Endorsement ------------------------- Reference herein to any specific commercial products, process, or service by tradename, trademark, manufacturer or otherwise, does not constitute or imply its endorsement, recommendation, or favoring by the United States Government, U.S. Department of Energy or URA. The views and opinions of individuals expressed herein do not necessarily state or reflect those of the United States Government, U.S. Department of Energy or URA and shall not be used for advertising or product endorsement purposes. Liabilities of the Government ----------------------------- This software is provided by URA, independent from its Prime Contract with the U.S. Department of Energy. URA is acting independently from the Government and in its own private capacity and is not acting on behalf of the U.S. Government, nor as its contractor nor its agent. Correspondingly, it is understood and agreed that the U.S. Government has no connection to this software and in no manner whatsoever shall be liable for nor assume any responsibility or obligation for any claim, cost, or damages arising out of or resulting from the use of the software available from this server. ------------------------------------------------------------------------