ClearCase Reference Manual, Release 4.0, Windows

registry_ccase

ClearCase storage registry for VOBs and views

APPLICABILITY

ClearCase (data structure)

SYNOPSIS

Registry directory:

ccase-home-dir\var\rgy

Registry backup directory (on backup registry hosts only)

ccase-home-dir\var\rgy\backup

VOB registry files:

vob_object
vob_tag

View registry files:

view_object
view_tag

Region registry file:

regions

Storage path registry file:

storage_path

Request base registry files (ClearTrack sites only):

bbase_object
bbase_tag

Site configuration registry file:

site_config

ClearCase registry configuration values stored in the Windows Registry:

HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\AtriaRegy
HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\InteropRegion
HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\RegBackup
HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\Region
HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\ServerType
HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\Security\RegPasswd

DESCRIPTION

The network's registry server host includes a registry directory, ccase-home-dir\var\rgy.The registry directory contains information on all the VOBs and views in the local area network, organized into the following files:

vob_object	Registry of VOB storage directories
vob_tag	Registry of VOB-tags
view_object	Registry of view storage directories
view_tag	Registry of view-tags
regions	Registry of network region names
storage_path	Registry of default VOB and view storage locations
site_config	Registry of local configuration parameters
bbase_object	(optional) Registry of ClearTrack request base storage directories
bbase_tag	(optional) Registry of ClearTrack request base tags

Never edit the registry files on the registry server host manually. Use the following cleartool subcommands to add, delete, or modify registry file entries:

Command Name	Registry Files Affected	Change
mktag -view	view_tag	Add or replace entry
mktag -vob	vob_tag	Add or replace entry
rmtag -view	view_tag	Delete entry
rmtag -vob	vob_tag	Delete entry
mkregion	regions	Add entry
mkreplica	vob_tag	Add entry
mkreplica	vob_object	Add entry
mkview	view_tag	Add entry
mkview	view_object	Add entry
rmview	view_object	Delete entry
rmview	view_tag	Delete entry
mkvob	vob_tag	Add entry
mkvob	vob_object	Add entry
rmregion	regions	Delete entry
rmreplica	vob_tag	Delete entry
rmreplica	vob_object	Delete entry
rmvob	vob_tag	Delete entry
rmvob	vob_object	Delete entry
register -view	view_object	Add or replace entry
register -vob	vob_object	Add or replace entry
setcache -view	site_config	Add or replace entry
setsite	site_config	Add or replace entry
unregister -view	view_object	Delete entry
unregister -vob	vob_object	Delete entry

The lsview, lsvob, lsregion, lssite, getcache, and hostinfo -long commands read and report information from the registry files. The rgy_check utility performs various registry file consistency checks.

REGISTRY SERVER

You designate one host in the local area network to be the registry server host. (In fact, there can be more than one, but VOBs and views cannot be shared between clients whose VOBs and views are registered on different registry server hosts.) On each host in the network, the name of the registry server host must appear in HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\AtriaRegy. You set this value in the ClearCase Control Panel on the Registry tab.

The registry server host can be either a Windows host or UNIX host.

The ClearCase albd_server program running on the registry server host acts as the registry server process: it fields remote procedure call (RPC) requests for registry information from ClearCase client programs (and other server programs) around the network.

BACKUP REGISTRY SERVERS

You can designate one or more ClearCase hosts as backup registry server hosts. If the primary registry server fails, you can run rgy_switchover to activate a backup registry server and reset all client hosts accordingly.

A backup registry server host takes periodic snapshots of the primary registry host's registry files (see rgy_backup) and client list, and it stores these snapshot files in the directory ccase-home-dir\var\rgy\backup.

The Windows Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\RegBackup contains the backup registry host name (or the string Unknown, if no backup host has been designated). You can set this value on the Registry tab in the ClearCase Control Panel.

The backup registry server host can be either a Windows host or a UNIX host.

See also rgy_backup and rgy_switchover.

NETWORK REGIONS

You can conceptually partition a local area network into multiple ClearCase network regions. Each region is a consistent naming domain: all hosts in the same region must be able to access all VOB storage directories and view storage directories using the same full pathnames. For example, all hosts in one network region might access a view storage directory on host mars using this pathname:

\\mars\shared_views\mainline.vws

Hosts in another network region may use a different name to access the same view storage directory:

/net/mars/usr1/shared_views/mainline.vws

Each host exists in exactly one network region and specifies that region on the Registry tab in the ClearCase Control Panel. (This value is stored in the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\Region. )The hostinfo -long command lists a host's network region.

Conceptually, each network region has its own view-tag registry and VOB-tag registry. However, the registry server host stores the only copies of the view-tag and VOB-tag files; each view-tag and VOB-tag entry includes a -region field, which assigns the tag to a particular region. It is common for a single VOB or view object to have multiple entries in the tag registry-one for each region in which it is registered.

NOTE: All VOBs and views that reside on a host must have tags in the host's network region.

Network regions are registered in the regions file in the rgy subdirectory on the registry host. Use the mkregion, lsregion, and rmregion commands to create, list, and remove regions.

FORMAT OF CLEARCASE REGISTRY FILES

The following sections describe the fields in the various registry files.

vob_object

Each VOB storage directory in the network has one entry in the vob_object file. The entry is a single text line with these fields:

`-entry`	`vob_object`
`-hostname`	Host on which the VOB storage directory resides.
`-local_path`	Standard full pathname to the VOB storage directory on that host.
`-vob_replica`	Unique identifier (UUID) of the VOB. (For a replicated VOB, maintained by ClearCase MultiSite, this VOB replica UUID identifies the particular VOB replica at your site.)
`-vob_family`	VOB family UUID, which is shared by all replicas of the same VOB. Replicas are created and maintained by ClearCase MultiSite. Even if the VOB is not replicated, this UUID is different from the VOB replica UUID.

vob_tag

Each VOB storage directory in the network can have one VOB-tag per network region, and each VOB-tag has an entry in the vob_tag file. The entry is a single text line with these fields:

`-entry`	`vob_tag`
`-tag`	VOB-tag, which is a full pathname. A VOB's tag is the same as its mount point.
`-global_path`	Standard full pathname to the VOB storage directory that is valid on all hosts within the network region.
`-hostname`	Host on which the VOB storage directory resides.
`-mount_access`	Keyword: private or public.
`-mount_options`	System-dependent character string that records options to be invoked when you mount the VOB.
`-region`	Network region.
`-vob_replica`	Same as the like-named field in the vob_object file.
`-title`	(optional) Tag comment supplied with a -tcomment option on mkvob or mktag

view_object

Each view storage directory in the network can have one entry per network region in the view_object file. The entry is a single text line with these fields:

`-entry`	`view_object`
`-hostname`	Host on which the view storage directory resides.
`-local_path`	Standard full pathname to the view storage directory on that host.
`-view_uuid`	View's unique identifier (UUID).
`-owner`	User name of the view's creator

view_tag

Each view storage directory in the network can have one or more entries per network region (one per region is recommended) in the view_tag file. The entry is a single text line with these fields:

`-entry`	`view_tag`
`-tag`	View-tag, which takes the form of a simple file name. When a dynamic view is active on a host, its view-tag appears as an entry in the host's view.root directory (by default, M:\)
`-hostname`	Host on which the view storage directory resides.
`-global_path`	For all machines in this network region, the full pathname of the view storage directory.
`-region`	Network region.
`-view_uuid`	View's unique identifier (UUID).
`-title`	(optional) Tag comment supplied with a -tcomment option on mkview or mktag.

regions

Each network region has exactly one entry in the regions file. The entry is a single text line with these fields:

`-entry`	`regions`
`-tag`	Region name (character string <= 32 characters)
`-title`	(optional) Region comment; see lsregion for details.

storage_path

Each default location for a VOB or view storage directory has exactly one entry in the storage_path file. The entry is a single text line with these fields:

`-entry`	`storage_path`
`-type`	Type of storage location (`vob` or `view`).
`-hostname`	Host on which the storage location resides.
`-region`	Network region.
`-global_path`	The full pathname of the storage location, valid on all hosts within the network region.

bbase_object

(ClearTrack sites only) Each ClearTrack request base in the network can have one entry per network region in the bbase_object file. The entry is a single text line with these fields:

`-entry`	`bbase_object`
`-hostname`	Host on which the request base resides.
`-local_path`	Standard full pathname to the request base on the local host.

bbase_tag

(ClearTrack sites only) Each ClearTrack request base in the network can have one tag per network region, and each request base tag has an entry in the bbase_tag file. The entry is a single text line with these fields:

`-entry`	`bbase_tag`
`-tag`	Request base tag.
`-hostname`	Host on which the request base resides.
`-global_path`	For all machines in this network region, the full pathname of the request base.
`-region`	Network region.

site_config

Stores local configuration parameters. See setsite for these parameters. The entry for each parameter is a single text line with these fields:

`-entry`	`site_config`
`-name`	Name of the parameter (such as `view_cache_size`).
`-value`	Default value for the parameter.

CLEARCASE REGISTRY CONFIGURATION VALUES

HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\AtriaRegy

The name of the primary registry server host. This key value must exist on every ClearCase host. Set this value on the Registry tab in the ClearCase Control Panel.

HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\InteropRegion

A single word (32 characters maximum, no white space) specifying the UNIX region whose VOBs will be accessed from Windows machines. Set this value on the Registry tab in the ClearCase Control Panel.

HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\RegBackup

The name of the backup registry server host. Set this value on the Registry tab in the ClearCase Control Panel.

HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\Region

A single word (32 characters maximum, no white space) specifying the host's network region. Each ClearCase host belongs to a single network region. All hosts in a network region access VOB and view storage directories using the same global (that is, network) pathnames. Set this value on the Registry tab in the ClearCase Control Panel.

HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\ServerType

On the primary registry server host, this value stores the single keyword master.

HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion\Security\RegPasswd

The network's VOB-tag password, an encrypted character string. You must specify this password to create a public VOB-tag with mkvob or mktag, or to remove a public VOB-tag with rmtag.

The Security subkey and RegPasswd value exist only on the registry server host. If the Security subkey is nonexistent, create it with the rgy_passwd utility. For example:

C:\> rgy_passwd (invoke encrypted-password utility) Password: <enter VOB-tag password>

The administrator should apply a security ACL to the Security subkey to prevent users from directly editing the password in the registry. We recommend that you assign full control to authorized users (users who allowed to change the password; for example, the network administrator), and read permissions to all other users.

FILES

ccase-home-dir\var\rgy\vob_object
ccase-home-dir\var\rgy\view_object
ccase-home-dir\var\rgy\vob_tag
ccase-home-dir\var\rgy\view_tag
ccase-home-dir\var\rgy\regions
ccase-home-dir\var\rgy\storage_path
ccase-home-dir\var\rgy\bbase_object
ccase-home-dir\var\rgy\bbase_tag
ccase-home-dir\var\rgy\site_config