From d9dc7e28fe73b1e3ac2773fb1efd44e67de5e21d Mon Sep 17 00:00:00 2001 From: Jason Edgecombe Date: Fri, 27 Jun 2008 04:29:12 +0000 Subject: [PATCH] man-page-vldb_convert-20080626 FIXES 104192 LICENSE BSD New man page for vldb_convert. --- doc/man-pages/README | 1 - doc/man-pages/pod8/vldb_convert.pod | 135 ++++++++++++++++++++++++++++ 2 files changed, 135 insertions(+), 1 deletion(-) create mode 100644 doc/man-pages/pod8/vldb_convert.pod diff --git a/doc/man-pages/README b/doc/man-pages/README index 7cc5c535db..4c95e98d2c 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -215,7 +215,6 @@ Known Problems restorevol rmtsysd tokens.krb - vldb_convert vos setfields vsys diff --git a/doc/man-pages/pod8/vldb_convert.pod b/doc/man-pages/pod8/vldb_convert.pod new file mode 100644 index 0000000000..d5d5021e19 --- /dev/null +++ b/doc/man-pages/pod8/vldb_convert.pod @@ -0,0 +1,135 @@ +=head1 NAME + +vldb_convert - Convert the VLDB to/from Transarc AFS versions 3.1-3.4a + +=head1 SYNOPSIS + +=for html +
+ +B [B] S<<< [B<-to>] > >>> + S<<< [B<-from>] > >>> + S<<< [B<-path>] > >>> [B<-showversion>] + [B<-dumpvldb>] [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B command is used to convert legacy Transarc 3.1-3.4 +VLDB database files between versions. This command is not needed when +using OpenAFS except in the case of preparing to migrate a pre-3.4 version +of Transarc AFS to OpenAFS. + +In order to convert the VLDB file, do the following: + +=over 4 + +=item 1. + +Shutdown the B process on all server machines. B is +typically run only on the Cell servers, which must be listed in +F or DNS. + +=item 2. + +Backup the VLDB file F on the sync site to a safe +place. Typically, the sync site if the machine with the lowest IP address. + +=item 3. + +Remove the F file from all cell server machines. + +=item 4. + +Remove the F file from the non-sync site server +machines. + +=item 5. + +Run the B command on the VLDB file using the following +command: + + # vldb_convert -path /usr/afs/db/vldb.DB0 + +=item 6. + +Copy the new version of the vlserver binaries to all Cell servers. + +=item 7. + +Restart the vlserver process on all Cell servers. The new VLDB will be +distributed to all of the Cell servers. + +=item 8. + +Confirm that all Cell servers are synchronized and that the vldb looks in +good shape. + +=back + +=head1 CAUTIONS + +Backup the VLDB file to a different directory or machine before performing +the upgrade. Be sure that all vlserver processes are always running the +same version. This requires downtime, but for this conversion, all +vlserver instances must be at the same version. This restriction is +relaxed in OpenAFS. + +=head1 OPTIONS + +=over 4 + +=item [B] + +This is an optional string that does nothing. + +=item [B<-to>] > + +This option is required when downgrading or when upgrading to a version +less than 3.4. Specify 1, 2, 3, or 4 to choose version 3.1, 3.2, 3.3, or +3,4 respectively. This defaults to version 3.4. + +=item [B<-from>] > + +This option is required when downgrading. Specify 1, 2, 3, or 4 to choose +version 3.1, 3.2, 3.3, or 3.4 respectively. + +=item [B<-path>] > + +Specifies the path the VLDB file. This defaults to F +and only needs to be used if the VLDB file is not in the default path.. + +=item B<-showversion> + +Shows the current version of the VLDB. This option can only be used by itself. + +=item B<-dumpvldb> + +Produces verbose debugging output during the conversion process. + +=item B<-help> + +Prints the online help for this command. All other valid options are +ignored. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have read and write access to the file +F. This usually means that root access is required +on the cell server machines. + +=head1 SEE ALSO + +L + +=head1 COPYRIGHT + +Copyright 2008 Jason Edgecombe + +This documentation is covered by the BSD License as written in the +doc/LICENSE file. This man page was written by Jason Edgecombe for +OpenAFS.