summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Kaduk <kaduk@mit.edu>2012-10-03 12:29:20 -0400
committerBen Kaduk <kaduk@mit.edu>2012-10-09 15:48:38 -0400
commit92eafef8b949dd59db8cfdf319852d53e24fe2e5 (patch)
treedbfc3a4f063e897b87ec9374eb9613e78fc122e3
parent01f30a7f06110f54c5d69fdd7697347c102f5274 (diff)
downloadkrb5-92eafef8b949dd59db8cfdf319852d53e24fe2e5.tar.gz
krb5-92eafef8b949dd59db8cfdf319852d53e24fe2e5.tar.xz
krb5-92eafef8b949dd59db8cfdf319852d53e24fe2e5.zip
Add a kdb5_util examples for old KDC upgrades
It's a slightly less-contrived use case of the utility than the other example, which reads more like a usage statement. Give a motivating sentence before each example, and note that this new example is not needed in the general upgrade case. The need to dump/load for upgrades prior to 1.2 was documented in the texinfo install guide, but not in any RST sources until now. ticket: 7407
-rw-r--r--doc/rst_source/krb_admins/database.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/rst_source/krb_admins/database.rst b/doc/rst_source/krb_admins/database.rst
index afea975886..2671e0e3f8 100644
--- a/doc/rst_source/krb_admins/database.rst
+++ b/doc/rst_source/krb_admins/database.rst
@@ -370,6 +370,8 @@ To restore a Kerberos database dump from a file, use the
Examples
########
+To load a single principal, either replacing or updating the database:
+
::
shell% kdb5_util load dumpfile principal
@@ -382,6 +384,24 @@ Examples
.. note:: If the database file exists, and the *-update* flag was not
given, *kdb5_util* will overwrite the existing database.
+Using kdb5_util to upgrade a master KDC from krb5 1.1.x:
+
+::
+
+ shell% kdb5_util dump old-kdb-dump
+ shell% kdb5_util dump -ov old-kdb-dump.ov
+ [Create a new KDC installation, using the old stash file/master password]
+ shell% kdb5_util load old-kdb-dump
+ shell% kdb5_util load -update old-kdb-dump.ov
+
+The use of old-kdb-dump.ov for an extra dump and load is necessary
+to preserve per-principal policy information, which is not included in
+the default dump format of krb5 1.1.x.
+
+.. note:: Using kdb5_util to dump and reload the principal database is
+ only necessary when upgrading from versions of krb5 prior
+ to 1.2.0---newer versions will use the existing database as-is.
+
.. _create_stash: