Edit RST install guide for clarity and accuracy
[krb5.git] / doc / rst_source / krb_admins / install_kdc / index.rst
1 .. note:: This document was copied from **Kerberos V5 Installation
2           Guide** with minor changes. Currently it is under
3           review. Please, send your feedback, corrections and
4           additions to krb5-bugs@mit.edu. Your contribution is greatly
5           appreciated.
6
7
8 Installing KDCs
9 ===============
10
11 When setting up Kerberos in a production environment, it is best to
12 have multiple slave KDCs alongside with a master KDC to ensure the
13 continued availability of the Kerberized services.  Each KDC contains
14 a copy of the Kerberos database.  The master KDC contains the writable
15 copy of the realm database, which it replicates to the slave KDCs at
16 regular intervals.  All database changes (such as password changes)
17 are made on the master KDC.  Slave KDCs provide Kerberos
18 ticket-granting services, but not database administration, when the
19 master KDC is unavailable.  MIT recommends that you install all of
20 your KDCs to be able to function as either the master or one of the
21 slaves.  This will enable you to easily switch your master KDC with
22 one of the slaves if necessary (see :ref:`switch_master_slave`).  This
23 installation procedure is based on that recommendation.
24
25 .. warning::
26     - The Kerberos system relies on the availability of correct time
27       information.  Ensure that the master and all slave KDCs have
28       properly synchronized clocks.
29
30     - It is best to install and run KDCs on secured and dedicated
31       hardware with limited access.  If your KDC is also a file
32       server, FTP server, Web server, or even just a client machine,
33       someone who obtained root access through a security hole in any
34       of those areas could potentially gain access to the Kerberos
35       database.
36
37
38 Install and configure the master KDC
39 ------------------------------------
40
41 Install Kerberos either from the OS-provided packages or from the
42 source (See :ref:`do_build`).
43
44 .. note:: For the purpose of this document we will use the following
45           names::
46
47              kerberos.mit.edu    - master KDC
48              kerberos-1.mit.edu  - slave KDC
49              ATHENA.MIT.EDU      - realm name
50              .k5.ATHENA.MIT.EDU  - stash file
51              admin/admin         - admin principal
52
53           See :ref:`mitK5defaults` for the default names and locations
54           of the relevant to this topic files.  Adjust the names and
55           paths to your system environment.
56
57 .. toctree::
58    :maxdepth: 1
59
60    mod_conf.rst
61    create_db.rst
62    admins_to_acl.rst
63    admins_to_db.rst
64    krb_daemon.rst
65
66
67 Install the Slave KDCs
68 ----------------------
69
70 You are now ready to start configuring the slave KDCs.
71
72 .. note:: Assuming you are setting the KDCs up so that you can easily
73           switch the master KDC with one of the slaves, you should
74           perform each of these steps on the master KDC as well as the
75           slave KDCs, unless these instructions specify otherwise.
76
77 .. toctree::
78    :maxdepth: 1
79
80    slave_install.rst
81    kdc_prop_slave.rst
82
83 Once your KDCs are set up and running, you are ready to use
84 :ref:`kadmin(1)` to load principals for your users, hosts, and other
85 services into the Kerberos database.  This procedure is described
86 fully in :ref:`add_mod_del_princs`.
87
88 You may occasionally want to use one of your slave KDCs as the master.
89 This might happen if you are upgrading the master KDC, or if your
90 master KDC has a disk crash.  See the following section for the
91 instructions.
92
93
94 Switching Master and Slave KDCs
95 -------------------------------
96
97 .. toctree::
98    :maxdepth: 1
99
100    switch_master_slave.rst
101
102
103 Incremental database propagation
104 --------------------------------
105
106 .. toctree::
107    :maxdepth: 1
108
109    ../database/incr_db_prop.rst
110
111
112 Feedback
113 --------
114
115 Please, provide your feedback or suggest a new topic at
116 krb5-bugs@mit.edu?subject=Documentation___install_kdc