Import Upstream version 1.8.5

[hcoop/debian/openafs.git] / doc / man-pages / pod1 / vos_release.pod.in

=head1 NAME

vos_release - Updates read-only volumes to match the read/write source volume

=head1 SYNOPSIS

=for html
<div class="synopsis">

B<vos release> S<<< B<-id> <I<volume name or ID>> >>>
    [B<-force>] [B<-force-reclone>]
    S<<< [B<-cell> <I<cell name>>] >>>
    [B<-noauth>] [B<-localauth>]
    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
    S<<< [B<-config> <I<config directory>>] >>>
    [B<-help>]

B<vos rel> S<<< B<-i> <I<volume name or ID>> >>>
    [B<-force>] [B<-force-r>]
    S<<< [B<-c> <I<cell name>>] >>>
    [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
    S<<< [B<-co> <I<config directory>>] >>>
    [B<-h>]

=for html
</div>

=head1 DESCRIPTION

The B<vos release> command copies the contents of the indicated read/write
source volume to each read-only site defined in the source volume's Volume
Location Database (VLDB) entry. (Use the B<vos addsite> command to define
sites as necessary before issuing this command). Each read-only copy has
the same name as read/write source with the addition of a C<.readonly>
extension.

For users to have a consistent view of the file system, the release of the
new volume version must be atomic: either all read-only sites receive the
new version, or all sites keep the version they currently have. The B<vos
release> command is designed to ensure that all copies of the volume's
read-only version match both the read/write source and each other. In
cases where problems such as machine or server process outages prevent
successful completion of the release operation, AFS uses two mechanisms to
alert the administrator.

First, the command interpreter generates an error message on the standard
error stream naming each read-only site that did not receive the new
volume version. Second, during the release operation the Volume Location
(VL) Server marks site definitions in the VLDB entry with flags (C<New
release> and C<Old release>) that indicate whether or not the site has the
new volume version. If any flags remain after the operation completes, it
was not successful. The Cache Manager refuses to access a read-only site
marked with the C<Old release> flag, which potentially imposes a greater
load on the sites marked with the C<New release> flag. It is important to
investigate and eliminate the cause of the failure and then to issue the
B<vos release> command as many times as necessary to complete the release
without errors.

The pattern of site flags remaining in the volume's VLDB entry after a
failed release operation can help determine the point at which the
operation failed. Use the B<vos examine> or B<vos listvldb> command to
display the VLDB entry. The VL Server sets the flags in concert with the
Volume Server's operations, as follows:

=over 4

=item *

Before the operation begins, the VL Server sets the C<New release> flag on
the read/write site definition in the VLDB entry and the C<Old release>
flag on read-only site definitions (unless the read-only site has been
defined since the last release operation and has no actual volume, in
which case its site flag remains C<Not released>).

=item *

If necessary, the Volume Server creates a temporary copy (a I<clone>) of
the read/write source called the ReleaseClone (see the following
discussion of when the Volume Server does or does not create a new
ReleaseClone.) It assigns the ReleaseClone its own volume ID number, which
the VL Server records in the C<RClone> field of the source volume's VLDB
entry.

=item *

The Volume Server distributes a copy of the ReleaseClone to each read-only
site defined in the VLDB entry. As the site successfully receives the new
clone, the VL Server sets the site's flag in the VLDB entry to C<New
release>.

=item *

When all the read-only copies are successfully released, the VL Server
clears all the C<New release> site flags. The ReleaseClone is no longer
needed, so the Volume Server deletes it and the VL Server erases its ID
from the VLDB entry.

=back

By default, the Volume Server determines automatically whether or not it
needs to create a new ReleaseClone:

=over 4

=item *

If there are no flags (C<New release>, C<Old release>, or C<Not released>)
on site definitions in the VLDB entry, the previous B<vos release> command
completed successfully and all read-only sites currently have the same
volume. The Volume Server infers that the current B<vos release> command
was issued because the read/write volume has changed. The Volume Server
creates a new ReleaseClone volume and distributes a copy of the clone
volume to all the read-only sites.  In order to reduce the amount of data
transferred during a release, the Volume Server sends incremental changes to
remote sites during the release.  The Volume Server only sends files and
directories which have been changed in the read/write volume since the
previous release.

=item *

If any site definition in the VLDB entry is marked with a flag, either the
previous release operation did not complete successfully or a new
read-only site was defined since the last release. The Volume Server does
not create a new ReleaseClone, instead distributing the entire existing
ReleaseClone to sites marked with the C<Old release> or C<Not released>
flag. As previously noted, the VL Server marks each VLDB site definition
with the C<New release> flag as the site receives the ReleaseClone, and
clears all flags after all sites successfully receive it.

=back

To override the default behavior, forcing the Volume Server to create and
release a new ReleaseClone to the read-only sites, include the B<-force>
flag. This is appropriate if, for example, the data at the read/write site
has changed since the existing ReleaseClone was created during the
previous release operation.

The B<-force-reclone> will force the creation of a new release clone volume,
but will not force a full volume dump to be distributed to the remote sites.
Instead, incremental changes will be distributed when possible.

=head1 OPTIONS

=over 4

=item B<-id> <I<volume name or id>>

Specifies either the complete name or volume ID number of a read/write
volume.

=item B<-force>

Creates a new ReleaseClone and distributes the entire clone volume to
all read-only sites, regardless of the C<New release>, C<Old release>, or
C<Not released> site flags.

=item B<-force-reclone>

Creates a new ReleaseClone and incrementally distributes the clone volume to
all read-only sites, regardless of the C<New release>, C<Old release>, or
C<Not released> site flags.

=include fragments/vos-common.pod

=back

=head1 EXAMPLES

The following command clones the read/write volume usr and releases it to
the read-only sites defined in its VLDB entry.

   % vos release usr

=head1 PRIVILEGE REQUIRED

The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine specified with the B<-server> argument and on each database server
machine. If the B<-localauth> flag is included, the issuer must instead be
logged on to a server machine as the local superuser C<root>.

=head1 SEE ALSO

L<vos(1)>,
L<vos_addsite(1)>,
L<vos_examine(1)>,
L<vos_listvldb(1)>

=head1 COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.