autoconf-updates-for-ac-check-lib-quoting-20010629
[openafs.git] / doc / html / AdminReference / auarf270.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf269.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf271.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRVOS_RELEASE" HREF="auarf002.htm#ToC_284">vos release</A></H2>
19 <A NAME="IDX5782"></A>
20 <A NAME="IDX5783"></A>
21 <A NAME="IDX5784"></A>
22 <A NAME="IDX5785"></A>
23 <A NAME="IDX5786"></A>
24 <A NAME="IDX5787"></A>
25 <A NAME="IDX5788"></A>
26 <A NAME="IDX5789"></A>
27 <A NAME="IDX5790"></A>
28 <A NAME="IDX5791"></A>
29 <A NAME="IDX5792"></A>
30 <A NAME="IDX5793"></A>
31 <A NAME="IDX5794"></A>
32 <A NAME="IDX5795"></A>
33 <A NAME="IDX5796"></A>
34 <A NAME="IDX5797"></A>
35 <A NAME="IDX5798"></A>
36 <A NAME="IDX5799"></A>
37 <A NAME="IDX5800"></A>
38 <A NAME="IDX5801"></A>
39 <A NAME="IDX5802"></A>
40 <A NAME="IDX5803"></A>
41 <A NAME="IDX5804"></A>
42 <P><STRONG>Purpose</STRONG>
43 <P>Updates the contents of read-only volumes to match their read/write source
44 volume
45 <P><STRONG>Synopsis</STRONG>
46 <PRE><B>vos release -id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-f</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>] 
47             [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
48     
49 <B>vos rel -i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-f</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
50 </PRE>
51 <P><STRONG>Description</STRONG>
52 <P>The <B>vos release</B> command copies the contents of the indicated
53 read/write source volume to each read-only site defined in the source
54 volume's Volume Location Database (VLDB) entry. (Use the <B>vos
55 addsite</B> command to define sites as necessary before issuing this
56 command). Each read-only copy has the same name as read/write source
57 with the addition of a <B>.readonly</B> extension.
58 <P>For users to have a consistent view of the file system, the release of the
59 new volume version must be atomic: either all read-only sites receive
60 the new version, or all sites keep the version they currently have. The
61 <B>vos release</B> command is designed to ensure that all copies of the
62 volume's read-only version match both the read/write source and each
63 other. In cases where problems such as machine or server process
64 outages prevent successful completion of the release operation, AFS uses two
65 mechanisms to alert the administrator.
66 <P>First, the command interpreter generates an error message on the standard
67 error stream naming each read-only site that did not receive the new volume
68 version. Second, during the release operation the Volume Location (VL)
69 Server marks site definitions in the VLDB entry with flags (<TT>New
70 release</TT> and <TT>Old release</TT>) that indicate whether or not the
71 site has the new volume version. If any flags remain after the
72 operation completes, it was not successful. The Cache Manager refuses
73 to access a read-only site marked with the <TT>Old release</TT> flag, which
74 potentially imposes a greater load on the sites marked with the <TT>New
75 release</TT> flag. It is important to investigate and eliminate the
76 cause of the failure and then to issue the <B>vos release</B> command as
77 many times as necessary to complete the release without errors.
78 <P>The pattern of site flags remaining in the volume's VLDB entry after a
79 failed release operation can help determine the point at which the operation
80 failed. Use the <B>vos examine</B> or <B>vos listvldb</B>
81 command to display the VLDB entry. The VL Server sets the flags in
82 concert with the Volume Server's operations, as follows:
83 <OL TYPE=1>
84 <P><LI>Before the operation begins, the VL Server sets the <TT>New release</TT>
85 flag on the read/write site definition in the VLDB entry and the <TT>Old
86 release</TT> flag on read-only site definitions (unless the read-only site
87 has been defined since the last release operation and has no actual volume, in
88 which case its site flag remains <TT>Not released</TT>).
89 <P><LI>If necessary, the Volume Server creates a temporary copy (a
90 <I>clone</I>) of the read/write source called the ReleaseClone (see the
91 following discussion of when the Volume Server does or does not create a new
92 ReleaseClone.) It assigns the ReleaseClone its own volume ID number,
93 which the VL Server records in the <TT>RClone</TT> field of the source
94 volume's VLDB entry.
95 <P><LI>The Volume Server distributes a copy of the ReleaseClone to each read-only
96 site defined in the VLDB entry. As the site successfully receives the
97 new clone, the VL Server sets the site's flag in the VLDB entry to
98 <TT>New release</TT>.
99 <P><LI>When all the read-only copies are successfully released, the VL Server
100 clears all the <TT>New release</TT> site flags. The ReleaseClone is
101 no longer needed, so the Volume Server deletes it and the VL Server erases its
102 ID from the VLDB entry.
103 </OL>
104 <P>By default, the Volume Server determines automatically whether or not it
105 needs to create a new ReleaseClone:
106 <UL>
107 <P><LI>If there are no flags (<TT>New release</TT>, <TT>Old release</TT>, or
108 <TT>Not released</TT>) on site definitions in the VLDB entry, the previous
109 <B>vos release</B> command completed successfully and all read-only sites
110 currently have the same volume. The Volume Server infers that the
111 current <B>vos release</B> command was issued because the read/write
112 volume has changed. The Volume Server creates a new ReleaseClone and
113 distributes it to all of the read-only sites.
114 <P><LI>If any site definition in the VLDB entry is marked with a flag, either the
115 previous release operation did not complete successfully or a new read-only
116 site was defined since the last release. The Volume Server does not
117 create a new ReleaseClone, instead distributing the existing ReleaseClone to
118 sites marked with the <TT>Old release</TT> or <TT>Not released</TT>
119 flag. As previously noted, the VL Server marks each VLDB site
120 definition with the <TT>New release</TT> flag as the site receives the
121 ReleaseClone, and clears all flags after all sites successfully receive
122 it.
123 </UL>
124 <P>To override the default behavior, forcing the Volume Server to create and
125 release a new ReleaseClone to the read-only sites, include the <B>-f</B>
126 flag. This is appropriate if, for example, the data at the read/write
127 site has changed since the existing ReleaseClone was created during the
128 previous release operation.
129 <P><STRONG>Options</STRONG>
130 <DL>
131 <P><DT><B>-id
132 </B><DD>Specifies either the complete name or volume ID number of a read/write
133 volume.
134 <P><DT><B>-f
135 </B><DD>Creates a new ReleaseClone and distributes it all read-only sites
136 regardless of whether or not any site definitions in the VLDB entry are marked
137 with a flag.
138 <P><DT><B>-cell
139 </B><DD>Names the cell in which to run the command. Do not combine this
140 argument with the <B>-localauth</B> flag. For more details, see the
141 introductory <B>vos</B> reference page.
142 <P><DT><B>-noauth
143 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
144 issuer. Do not combine this flag with the <B>-localauth</B>
145 flag. For more details, see the introductory <B>vos</B> reference
146 page.
147 <P><DT><B>-localauth
148 </B><DD>Constructs a server ticket using a key from the local
149 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
150 interpreter presents it to the Volume Server and Volume Location Server during
151 mutual authentication. Do not combine this flag with the
152 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
153 see the introductory <B>vos</B> reference page.
154 <P><DT><B>-verbose
155 </B><DD>Produces on the standard output stream a detailed trace of the
156 command's execution. If this argument is omitted, only warnings
157 and error messages appear.
158 <P><DT><B>-help
159 </B><DD>Prints the online help for this command. All other valid options
160 are ignored.
161 </DL>
162 <P><STRONG>Examples</STRONG>
163 <P>The following command clones the read/write volume <B>usr</B> and
164 releases it to the read-only sites defined in its VLDB entry.
165 <PRE>   % <B>vos release usr</B>
166    
167 </PRE>
168 <P><STRONG>Privilege Required</STRONG>
169 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
170 the machine specified with the <B>-server</B> argument and on each
171 database server machine. If the <B>-localauth</B> flag is included,
172 the issuer must instead be logged on to a server machine as the local
173 superuser <B>root</B>.
174 <P><STRONG>Related Information</STRONG>
175 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
176 <P><A HREF="auarf253.htm#HDRVOS_ADDSITE">vos addsite</A>
177 <P><A HREF="auarf261.htm#HDRVOS_EXAMINE">vos examine</A>
178 <P><A HREF="auarf265.htm#HDRVOS_LISTVLDB">vos listvldb</A>
179 <P>
180 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf269.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf271.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
181 <!-- Begin Footer Records  ========================================== -->
182 <P><HR><B> 
183 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
184 </B> 
185 <!-- End Footer Records  ============================================ -->
186 <A NAME="Bot_Of_Page"></A>
187 </BODY></HTML>