doc/man-pages/pod1/vos_release.pod

   1 =head1 NAME
   2
   3 vos_release - Updates read-only volumes to match the read/write source volume
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos release> S<<< B<-id> <I<volume name or ID>> >>> [B<-force>]
  11     S<<< [B<-cell> <I<cell name>>] >>>
  12     [B<-noauth>] [B<-localauth>]
  13     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  14
  15 B<vos rel> S<<< B<-i> <I<volume name or ID>> >>>
  16     [B<-f>] S<<< [B<-c> <I<cell name>>] >>>
  17     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  18
  19 =for html
  20 </div>
  21
  22 =head1 DESCRIPTION
  23
  24 The B<vos release> command copies the contents of the indicated read/write
  25 source volume to each read-only site defined in the source volume's Volume
  26 Location Database (VLDB) entry. (Use the B<vos addsite> command to define
  27 sites as necessary before issuing this command). Each read-only copy has
  28 the same name as read/write source with the addition of a C<.readonly>
  29 extension.
  30
  31 For users to have a consistent view of the file system, the release of the
  32 new volume version must be atomic: either all read-only sites receive the
  33 new version, or all sites keep the version they currently have. The B<vos
  34 release> command is designed to ensure that all copies of the volume's
  35 read-only version match both the read/write source and each other. In
  36 cases where problems such as machine or server process outages prevent
  37 successful completion of the release operation, AFS uses two mechanisms to
  38 alert the administrator.
  39
  40 First, the command interpreter generates an error message on the standard
  41 error stream naming each read-only site that did not receive the new
  42 volume version. Second, during the release operation the Volume Location
  43 (VL) Server marks site definitions in the VLDB entry with flags (C<New
  44 release> and C<Old release>) that indicate whether or not the site has the
  45 new volume version. If any flags remain after the operation completes, it
  46 was not successful. The Cache Manager refuses to access a read-only site
  47 marked with the C<Old release> flag, which potentially imposes a greater
  48 load on the sites marked with the C<New release> flag. It is important to
  49 investigate and eliminate the cause of the failure and then to issue the
  50 B<vos release> command as many times as necessary to complete the release
  51 without errors.
  52
  53 The pattern of site flags remaining in the volume's VLDB entry after a
  54 failed release operation can help determine the point at which the
  55 operation failed. Use the B<vos examine> or B<vos listvldb> command to
  56 display the VLDB entry. The VL Server sets the flags in concert with the
  57 Volume Server's operations, as follows:
  58
  59 =over 4
  60
  61 =item *
  62
  63 Before the operation begins, the VL Server sets the C<New release> flag on
  64 the read/write site definition in the VLDB entry and the C<Old release>
  65 flag on read-only site definitions (unless the read-only site has been
  66 defined since the last release operation and has no actual volume, in
  67 which case its site flag remains C<Not released>).
  68
  69 =item *
  70
  71 If necessary, the Volume Server creates a temporary copy (a I<clone>) of
  72 the read/write source called the ReleaseClone (see the following
  73 discussion of when the Volume Server does or does not create a new
  74 ReleaseClone.) It assigns the ReleaseClone its own volume ID number, which
  75 the VL Server records in the C<RClone> field of the source volume's VLDB
  76 entry.
  77
  78 =item *
  79
  80 The Volume Server distributes a copy of the ReleaseClone to each read-only
  81 site defined in the VLDB entry. As the site successfully receives the new
  82 clone, the VL Server sets the site's flag in the VLDB entry to C<New
  83 release>.
  84
  85 =item *
  86
  87 When all the read-only copies are successfully released, the VL Server
  88 clears all the C<New release> site flags. The ReleaseClone is no longer
  89 needed, so the Volume Server deletes it and the VL Server erases its ID
  90 from the VLDB entry.
  91
  92 =back
  93
  94 By default, the Volume Server determines automatically whether or not it
  95 needs to create a new ReleaseClone:
  96
  97 =over 4
  98
  99 =item *
 100
 101 If there are no flags (C<New release>, C<Old release>, or C<Not released>)
 102 on site definitions in the VLDB entry, the previous B<vos release> command
 103 completed successfully and all read-only sites currently have the same
 104 volume. The Volume Server infers that the current B<vos release> command
 105 was issued because the read/write volume has changed. The Volume Server
 106 creates a new ReleaseClone and distributes it to all of the read-only
 107 sites.
 108
 109 =item *
 110
 111 If any site definition in the VLDB entry is marked with a flag, either the
 112 previous release operation did not complete successfully or a new
 113 read-only site was defined since the last release. The Volume Server does
 114 not create a new ReleaseClone, instead distributing the existing
 115 ReleaseClone to sites marked with the C<Old release> or C<Not released>
 116 flag. As previously noted, the VL Server marks each VLDB site definition
 117 with the C<New release> flag as the site receives the ReleaseClone, and
 118 clears all flags after all sites successfully receive it.
 119
 120 =back
 121
 122 To override the default behavior, forcing the Volume Server to create and
 123 release a new ReleaseClone to the read-only sites, include the B<-force>
 124 flag. This is appropriate if, for example, the data at the read/write site
 125 has changed since the existing ReleaseClone was created during the
 126 previous release operation.
 127
 128 =head1 OPTIONS
 129
 130 =over 4
 131
 132 =item B<-id> <I<volume name or id>>
 133
 134 Specifies either the complete name or volume ID number of a read/write
 135 volume.
 136
 137 =item B<-force>
 138
 139 Creates a new ReleaseClone and distributes it all read-only sites
 140 regardless of whether or not any site definitions in the VLDB entry are
 141 marked with a flag.
 142
 143 =item B<-cell> <I<cell name>>
 144
 145 Names the cell in which to run the command. Do not combine this argument
 146 with the B<-localauth> flag. For more details, see L<vos(1)>.
 147
 148 =item B<-noauth>
 149
 150 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 151 combine this flag with the B<-localauth> flag. For more details, see
 152 L<vos(1)>.
 153
 154 =item B<-localauth>
 155
 156 Constructs a server ticket using a key from the local
 157 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 158 to the Volume Server and Volume Location Server during mutual
 159 authentication. Do not combine this flag with the B<-cell> argument or
 160 B<-noauth> flag. For more details, see L<vos(1)>.
 161
 162 =item B<-verbose>
 163
 164 Produces on the standard output stream a detailed trace of the command's
 165 execution. If this argument is omitted, only warnings and error messages
 166 appear.
 167
 168 =item B<-encrypt>
 169
 170 Encrypts the command so that the operation's results are not transmitted
 171 across the network in clear text. This option is available in OpenAFS
 172 versions 1.4.11 or later and 1.5.60 or later.
 173
 174 =item B<-noresolve>
 175
 176 Shows all servers as IP addresses instead of the DNS name. This is very
 177 useful when the server address is registered as 127.0.0.1 or when dealing
 178 with multi-homed servers. This option is available in OpenAFS
 179 versions 1.4.8 or later and 1.5.35 or later.
 180
 181 =item B<-help>
 182
 183 Prints the online help for this command. All other valid options are
 184 ignored.
 185
 186 =back
 187
 188 =head1 EXAMPLES
 189
 190 The following command clones the read/write volume usr and releases it to
 191 the read-only sites defined in its VLDB entry.
 192
 193    % vos release usr
 194
 195 =head1 PRIVILEGE REQUIRED
 196
 197 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 198 machine specified with the B<-server> argument and on each database server
 199 machine. If the B<-localauth> flag is included, the issuer must instead be
 200 logged on to a server machine as the local superuser C<root>.
 201
 202 =head1 SEE ALSO
 203
 204 L<vos(1)>,
 205 L<vos_addsite(1)>,
 206 L<vos_examine(1)>,
 207 L<vos_listvldb(1)>
 208
 209 =head1 COPYRIGHT
 210
 211 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 212
 213 This documentation is covered by the IBM Public License Version 1.0.  It was
 214 converted from HTML to POD by software written by Chas Williams and Russ
 215 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.