cdlogo
Departments | Computing Division | Fermilab at Work | Fermilab Home
_____________________________________________________________________________________________________
UPS, UPD and UPP v4
Complete Guide and Reference Manual

Back to Welcome page - About this manual - Contents - Index - Quick Reference Card
Acknowledgments - Updates to Manual - UPS/UPD Product page

Part I: Overview and End Users Guide

Chapter 1: Overview of UPS, UPD and UPP v4

Go to contents

UPS, UPD and UPP are the utilities provided by Fermilab’s Computing Division for managing and standardizing software product development, distribution, support and access. This overview chapter describes these utilities briefly, and discusses the reasons for which this particular product methodology was chosen and developed. The chapter also describes:

Chapter 2: UPS Operations for the End User

Go to contents

This chapter describes how to get information about UPS products that are installed on a user system and declared to a UPS database, and how to access them.

Part II: Product Installer’s Guide

Chapter 3: General Product Installation Information

Go to contents

This chapter provides general information you need to know before you start installing products. It discusses:

Chapter 4: Finding Information about Products on a Distribution Node

Go to contents

This chapter discusses finding information about products on a distribution node, in particular:

Chapter 5: Installing Products Using UPD

Go to contents

This chapter guides you through installing products from a UPS/UPD product distribution node using the UPD command upd install.

Chapter 6: Installing Products Using UPP

Go to contents

UPP can be used for several functions as described briefly in section 1.1 Introduction to UPS, UPD and UPP, and in detail in Chapter 32: The UPP Subscription File. This chapter describes how to use UPP to install products.

Chapter 7: Installing Products using FTP

Go to contents

This chapter describes how to download a product using FTP, install it, and declare it to a local UPS database.

Chapter 8: Product Installation: Special Cases

Go to contents

This chapter provides product installation information about specific cases. It discusses:

Chapter 9: Troubleshooting UPS Product Installations

Go to contents

This chapter provides a few hints if things don’t seem to work after installing a product.

Part III: System Administrator’s Guide

Chapter 10: Maintaining a UPS Database

Go to contents

In this chapter we assume that you have UPS/UPD installed and that you have a working database and products area. We provide instructions and examples for performing the following functions:

Chapter 11: UPS and UPD Pre-install Issues and General Administration

Go to contents

In this chapter we take a step back with regard to Chapter 10: Maintaining a UPS Database, and assume that you have not yet installed UPS/UPD, or created a UPS database and products area. We guide you through the administrative decisions and tasks that are involved in preparing to implement UPS/UPD. Towards the end of the chapter there is also some information regarding general administrative tasks. For machines running AFS or NFS, also see Chapter 12: Providing Access to AFS Products.

Chapter 12: Providing Access to AFS Products

Go to contents

This chapter describes how to provide access on your local machine to UPS products installed in AFS space.

Chapter 13: Bootstrapping CoreFUE

Go to contents

CoreFUE is a bundled product which includes UPS/UPD and perl. It refers to the core components of the Fermi UNIX Environment (FUE). When we discuss installing UPS/UPD, we’re generally talking about coreFUE since perl is a required component. Here we describe how to use automated scripts to bootstrap coreFUE, that is, to install coreFUE on a machine on which no prior versions of these products are installed. Several project-specific configurations of UPS/UPD are available.

Chapter 14: Automatic UPS Product Startup and Shutdown

Go to contents

This chapter covers configuring your system to support automatic startup and shutdown of UPS products, and installing individual UPS product instances to start and stop automatically.

Part IV: Product Developer’s Guide

Chapter 15: UPS Product Development: General Considerations

Go to contents

This chapter discusses the UPS product development methodology and tools that can be used in product development. It also provides recommendations for organizing your local product development area and the individual product root directories you will need to create.

Chapter 16: Building UPS Products

Go to contents

In this chapter we describe the steps you need to take in order to prepare a product for inclusion into the UPS framework and then to prepare it for distribution. We go through the steps for a simple case, then discuss the additional steps that may be required in more complex situations. Some sample auxiliary files are provided at the end.

Chapter 17: Making Products Available For Distribution

Go to contents

This chapter describes the processes of adding, updating, deleting and “cloning” product instances or components on a product distribution system. Information on creating tar files, using Fermilab CVS repositories and announcing products is also provided.

Chapter 18: Using template_product to Build and Distribute UPS Products

Go to contents

In this chapter we describe the template_product product, and show how to use it to build and distribute a product.

Chapter 19: Checklist for Building and Distributing Products

Go to contents

In this chapter we summarize the steps for preparing to build a product, building it and distributing it. We include information about making the appropriate announcements when a new or upgraded product is available.

Part V: Distribution Node Maintainer’s Guide

Chapter 20: Product Distribution Server Configuration

Go to contents

This chapter describes how to configure and manage a UPS product distribution node. It was written with the assumption that the reader who is setting up a distribution server has appropriate system privileges and sufficient administrative experience to create accounts, change network services configurations, and so on.

Chapter 21: Configuration of the fnkits Product Distribution Node

Go to contents

This chapter describes the UPS/UPD configuration on the Computing Division’s central product distribution node, fnkits.fnal.gov. Information is provided for both the KITS distribution database and the server’s local database.

Part VI: UPS and UPD Command Reference

Chapter 22: UPS Command Reference

Go to contents

This chapter contains full usage information on all the UPS commands. In particular, for each command you will find:

Chapter 23: UPD/UPP Command Reference

Go to contents

This chapter contains full usage information on all the UPD commands and the UPP command. In particular, for each command you will find:

For commands that have a corresponding UPS command, you will find:

Chapter 24: Generic Command Option Descriptions

Go to contents

This chapter provides an alphabetical listing of UPS/UPD options with generic descriptions. More detailed information on a few selected options can be found at the end of the chapter. In the command reference chapters, 22 and 23, the options supported by each command are listed with command-specific descriptions.

Chapter 25: UPS/UPD Command Usage

Go to contents

This chapter describes the syntax for UPS and UPD commands.

Chapter 26: Product Instance Matching in UPS/UPD Commands

Go to contents

When a UPS or UPD command is issued, the system must determine which product instance(s) to act upon. This determination is called instance matching. This chapter describes the algorithms used for instance matching.

Part VII: Administrator’s Reference

Chapter 27: Information Storage Format in Database and Configuration Files

Go to contents

This chapter introduces the files UPS uses for product management. It also describes the format of the information storage in these files, which is in the format of KEYWORD=VALUE pairs. The supported keywords are listed and described.

Chapter 28: Version Files

Go to contents

Version files are UPS database files that contain information specific to the local installation and declaration of the declared product instances. The contents of version files are described in this chapter.

Chapter 29: Chain Files

Go to contents

UPS/UPD supports chains to product versions, and chain information is maintained in chain files. In this chapter we describe chain files and how they interact with version files.

Chapter 30: The UPS Configuration File

Go to contents

A UPS database can be configured and customized using the file dbconfig, described in this chapter. It is used to define keywords which control quantities such as:

Chapter 31: The UPD Configuration File

Go to contents

UPD can be configured and customized on your system using the file updconfig, described in this chapter. By providing default values for several variables (mostly product file and directory locations), the updconfig file controls where UPD installs products and miscellaneous product-related files. It can also be used to define supplementary actions for UPD to perform when installing or updating products.

Chapter 32: The UPP Subscription File

Go to contents

UPP is a layer on top of UPD that can be used to facilitate the update of products on a local UPS node as new versions become available on a product distribution node. UPP is configured on the local node by subscription files, which we describe in this chapter. The functions UPP can be configured to perform on a local node include:

Part VIII: Developer’s Reference

Chapter 33: Actions and ACTION Keyword Values

Go to contents

Table files and UPD configuration files often include stanzas which we call actions. We describe actions in this chapter.

Chapter 34: Functions used in Actions

Go to contents

There is a set of supported functions that can be used in action stanzas. In this chapter we give a general overview of functions, list and describe all the supported functions, provide a couple of examples of functions within actions, and list all the read-only variables available to the supported functions.

Chapter 35: Table Files

Go to contents

This chapter describes table files. Table files contain product-specific, installation-independent information. Most, but not all, products require a table file. UPS product developers are responsible for providing the table files associated with their products.

Chapter 36: Scripts You May Need to Provide with a Product

Go to contents

In UPS v4, the functions supported for use in table file actions will not always suffice for completing certain tasks, for instance configuration and tailoring. You may still need to provide executable scripts, and include appropriate functions in your table file to execute them. In this chapter we discuss some scripts you may need to provide with your product.

Chapter 37: Use of Compile Scripts in Table Files

Go to contents

Compile scripts can be used in table files to preprocess actions, thus speeding up considerably the time it takes users to execute the actions. We describe the use of compile scripts in this chapter.

Chapter 38: Creating and Formatting Man Pages

Go to contents

In this chapter we show you how to create man pages, format them, and even create html documents from them. This is not a comprehensive man page reference, but it contains sufficient information for most purposes.


Announcements - Services - Systems & Networking - Documentation & Software
Getting Started - About the Computing Division - Computing Division
CD Index - Search

For assistance contact helpdesk@fnal.gov
Information compiled and maintained by Anne Heavey (aheavey@fnal.gov)
This page last Modified by AH on July 18, 2000.