doc/man-pages/pod5/BosConfig.pod

   1 =head1 NAME
   2
   3 BosConfig - Defines server processes for the BOS Server to monitor
   4
   5 =head1 DESCRIPTION
   6
   7 The BosConfig file lists the processes that the Basic OverSeer
   8 (BOS) Server monitors on its server machine, and thus defines which AFS server
   9 processes run on the machine. It specifies how the BOS Server reacts
  10 when a process fails, and also defines the times at which the BOS Server
  11 automatically restarts processes as part of performance maintenance.
  12 The file must reside in the B</usr/afs/local> directory on each AFS
  13 server machine.
  14
  15 A server process entry in the BosConfig file records the
  16 following information:
  17
  18 =over 4
  19
  20 =item *
  21
  22 TheI< entry type>, which is one of the following:
  23 L<(1)>
  24 L<(1)>
  25
  26
  27 =over 4
  28
  29 =item cronL<(1)
  30 >
  31
  32 Designates a server process that runs periodically instead of
  33 continuously. The BOS Server starts a cron process only at specified
  34 times, not whenever it fails. All standard AFS process entries except
  35 B<fs> are simple (there are no standard cron processes).
  36
  37 =item fsL<(1)
  38 L<(1)>
  39 L<(1)>
  40 L<(1)>
  41 >
  42
  43 Designates a group of interdependent server processes. If one of
  44 the processes fails, the BOS Server must coordinate its restart with the
  45 restart of the other processes in the group, possibly by stopping them
  46 first.
  47
  48 There is only one standard entry of this type, for which the conventional
  49 name is B<fs>. It combines three server processes: the
  50 File Server (B<fileserver> process), the Volume Server
  51 (B<volserver> process), and the Salvager (B<salvager>
  52 process). These processes all operate on the same data--the AFS
  53 data stored on an AFS server machine's B</vicep> partitions and
  54 mounted in the AFS filespace--but in different ways. Grouping the
  55 processes prevents them from attempting to access the same data
  56 simultaneously, which can cause corruption.
  57
  58 During normal operation, the Salvager process is not active. If the
  59 File Server process fails, however, the BOS Server stops the Volume Server
  60 process and runs the Salvager process to correct any corruption that resulted
  61 from the failure. (The administrator can also issue the B<bos
  62 salvage> command to invoke the Salvager process.) If the Volume
  63 Server fails, the BOS Server can restart it without stopping the File Server
  64 or running the Salvager.
  65
  66 =item simpleL<(1)
  67 >
  68
  69 Designates a server process that runs independently of any other on the
  70 server machine. If a simple process fails, the BOS Server does not have
  71 to coordinate its restart with any other process.
  72
  73 =back
  74
  75 =item *
  76
  77 The I<entry name>. The conventional name for an entry in the
  78 B<BosConfig> file and the associated process matches the binary
  79 filename. When issuing any B<bos> command that takes the
  80 B<-instance> argument, identify each process by the name used in the
  81 B<BosConfig> file. For a list of the names, see the B<bos
  82 create> reference page.
  83
  84
  85 =item *
  86
  87 The process's I<status flag>, which determines whether the BOS
  88 Server attempts to start the process in two cases: each time the BOS
  89 Server itself restarts, and when the process fails. The
  90 B<BosConfig> file currently uses a binary notation to indicate whether
  91 the BOS Server attempts to restart the process as necessary or does not
  92 monitor it at all. For the sake of clarity, the AFS documentation
  93 refers to the flags as B<Run> and B<NotRun> instead.
  94 Only a system administrator, not the BOS Server, can change the flag.
  95 L<(1)>
  96 L<(1)>
  97
  98
  99 =item *
 100
 101 One or more I<command parameters> which the BOS Server invokes to
 102 start the process or processes associated with the entry:
 103
 104
 105 =over 4
 106
 107 =item *
 108
 109 A cron entry has two command parameters, the first the complete
 110 pathname to the program, and the second the time at which the BOS Server
 111 invokes the program.
 112
 113
 114 =item *
 115
 116 The fs entry has three command parameters, each the complete
 117 pathname to the B<fileserver>, B<volserver>, and
 118 B<salvager> programs, in that order.
 119
 120
 121 =item *
 122
 123 A simple entry has only one command parameter, the complete
 124 pathname to the program.
 125
 126
 127 =back
 128
 129 =back
 130
 131 In addition to server process entries, the BosConfig file
 132 specifies the times at which the BOS Server performs two types of automatic
 133 process restarts:
 134
 135 =over 4
 136
 137 =item *
 138
 139 The I<general restart> time at which the BOS Server restarts itself
 140 and then each process for which the entry in the B<BosConfig> file has
 141 status flag B<Run>. The default setting is Sunday at 4:00
 142 a.m.
 143
 144
 145 =item *
 146
 147 The I<binary restart> time at which the BOS Server restarts any
 148 server process for which the time stamp on the binary file in the
 149 B</usr/afs/bin> directory is later than the last restart time for the
 150 process. The default is 5:00 a.m.
 151
 152
 153 =back
 154
 155 Although the BosConfig file is in ASCII format, do not use a
 156 text editor to alter it. Its format is subject to change and
 157 incorrectly formatted entries can prevent server startup in ways that are
 158 difficult to diagnose. Instead always use the appropriate commands from
 159 the B<bos> command suite:
 160
 161 =over 4
 162
 163 =item *
 164
 165 The bos create command to create an entry in the file and start
 166 the associated process
 167
 168
 169 =item *
 170
 171 The bos delete command to remove an entry from the file after
 172 the B<bos stop> command is used to stop the associated process
 173
 174
 175 =item *
 176
 177 The bos getrestart command to display the times at which the
 178 BOS Server performs automatic restarts
 179
 180
 181 =item *
 182
 183 The bos setrestart command to set the times at which the BOS
 184 Server performs automatic process restarts
 185
 186
 187 =item *
 188
 189 The bos start command to change an entry's status flag to
 190 B<Run> and start the associated process
 191
 192
 193 =item *
 194
 195 The bos status command to display all processes listed in the
 196 file
 197
 198
 199 =item *
 200
 201 The bos stop command to change an entry's status flag to
 202 B<NotRun> and stop the associated process
 203
 204
 205 =back
 206
 207 There are also bos commands that start and stop processes
 208 without changing entries in the B<BosConfig> file. The BOS
 209 Server reads the B<BosConfig> file only when it starts, transferring
 210 the information into its memory. Thus a process's status as
 211 represented in the BOS Server's memory can diverge from its status in the
 212 B<BosConfig> file. The following commands change a
 213 process's status in the BOS Server's memory only:
 214 L<(1)>
 215 L<(1)>
 216 L<(1)>
 217
 218 =over 4
 219
 220 =item *
 221
 222 The bos restart command restarts a specified set of processes,
 223 all processes, or all processes other than the BOS Server
 224
 225
 226 =item *
 227
 228 The bos shutdown command stops a process
 229
 230
 231 =item *
 232
 233 The bos startup command starts a process
 234
 235
 236 =back
 237
 238 =head1 SEE ALSO
 239
 240 L<bos_create(1)>,
 241 L<bos_delete(1)>,
 242 L<bos_getrestart(1)>,
 243 L<bos_restart(1)>,
 244 L<bos_setrestart(1)>,
 245 L<bos_shutdown(1)>,
 246 L<bos_start(1)>,
 247 L<bos_startup(1)>,
 248 L<bos_status(1)>,
 249 L<bos_stop(1)>,
 250 L<bos_salvage(1)>,
 251 L<fileserver(1)>,
 252 L<salvager(1)>,
 253 L<volserver(1)>
 254
 255 =head1 COPYRIGHT
 256
 257 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 258
 259 This documentation is covered by the IBM Public License Version 1.0.  It was
 260 converted from HTML to POD by software written by Chas Williams and Russ
 261 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.