Departments | Computing Division | Fermilab at Work | Fermilab Home
_____________________________________________________________________________________________________
| UPS, UPD and UPP v4 Complete Guide and Reference Manual |
| |
Departments | Computing Division | Fermilab at Work | Fermilab Home _____________________________________________________________________________________________________
|
Back to Welcome page -
About this manual -
Contents -
Index -
Quick Reference Card
Acknowledgments -
Updates to
Manual - UPS/UPD
Product page
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:
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.
This chapter provides general information you need to know before you start installing products. It discusses:
This chapter discusses finding information about products on a distribution node, in particular:
This chapter guides you through installing products from a UPS/UPD product distribution node using the UPD command upd install.
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.
This chapter describes how to download a product using FTP, install it, and declare it to a local UPS database.
This chapter provides product installation information about specific cases. It discusses:
This chapter provides a few hints if things don’t seem to work after installing a product.
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:
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.
This chapter describes how to provide access on your local machine to UPS products installed in AFS space.
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.
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.
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.
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.
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.
In this chapter we describe the template_product product, and show how to use it to build and distribute a product.
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.
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.
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.
This chapter contains full usage information on all the UPS commands. In particular, for each command you will find:
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:
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.
This chapter describes the syntax for UPS and UPD commands.
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.
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.
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.
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.
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:
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.
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:
Table files and UPD configuration files often include stanzas which we call actions. We describe actions in this chapter.
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.
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.
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.
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.
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.