summaryrefslogtreecommitdiff
path: root/Architecture_and_Design/en-US/Configuration_Management.xml
blob: 487c3f743f40859f3c5e534e520a2e2e84320344 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Architecture_and_Design.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Architecture_and_Design-Configuration_Management">
    <title>Configuration Management</title>
    <para>
        Kolab Groupware includes configuration management, so that adjusting settings for your environment can be automatically deployed to the relevant configuration files, and the corresponding services can be reloaded or restarted.
    </para>
    <para>
        To that end, Kolab Groupware employs a relational, object-oriented model.
    </para>
    <section id="sect-Architecture_and_Design-Configuration_Management-Configuration_Management_Objects">
        <title>Configuration Management Objects</title>
        <para>
            <itemizedlist>
                <listitem>
                    <formalpara id="form-Architecture_and_Design-Configuration_Management_Objects-node">
                        <title>node</title>
                        <para>
                            A node is a single operating system instance with a unique fully qualified domain name. It is the container for roles, as each node in a deployment can be assigned one or more roles.
                        </para>

                    </formalpara>
                    <para>
                        Additionally, a node is assigned an <xref linkend="form-Architecture_and_Design-Configuration_Management_Objects-environment" />, in order to facilitate setups with pre-production environments.
                    </para>

                </listitem>
                <listitem>
                    <formalpara id="form-Architecture_and_Design-Configuration_Management_Objects-role">
                        <title>role</title>
                        <para>
                            A role is a set of tasks to perform in a given environment. For example, a node can be an MTA, or an MTA of a particular type (internal, external).
                        </para>

                    </formalpara>
                    <para>
                        Adding the role "mta-internal" to a node tells the configuration management that certain packages need to be installed, certain configuration settings need to be applied to certain files, and certain services need to be started.
                    </para>

                </listitem>
                <listitem>
                    <formalpara id="form-Architecture_and_Design-Configuration_Management_Objects-file">
                        <title>file</title>
                        <para>
                            A file is related to a service, and contains its configuration settings.
                        </para>

                    </formalpara>

                </listitem>
                <listitem>
                    <formalpara id="form-Architecture_and_Design-Configuration_Management_Objects-setting">
                        <title>setting</title>
                        <para>
                            A setting is a single key-value pair of the augeas path and the desired contents. The contents can be specified as a value, or as the return value of a function to call.
                        </para>

                    </formalpara>
                    <para>
                        For example, the list of Cyrus IMAP administrator login names is contained within <filename>/etc/imapd.conf</filename>, setting <literal>admins</literal>. Its value is a space-separated list of login names.
                    </para>
                    <para>

<screen>(...snip...)
admins: cyrus-admin
(...snip...)</screen>

                    </para>
                    <para>
                        Adding a Cyrus IMAP administrator can be performed by;
                    </para>
                    <para>
                        <itemizedlist>
                            <listitem>
                                <para>
                                    Removing the setting from the management, and directly editing the setting in <filename>/etc/imapd.conf</filename> adding the login name for the new administrator to the space-seperated list.
                                </para>

                            </listitem>
                            <listitem>
                                <para>
                                    Adding the new administrator to the list of login names returned by the function called to get to the value of the setting.
                                </para>
                                <para>
                                    By default, we consider a role <emphasis>cyrus-admins</emphasis> to exist in LDAP, and list the uid attribute values of the accounts with that role.
                                </para>

                            </listitem>

                        </itemizedlist>

                    </para>
                    <para>
                        Because a setting can contain a setting specific for a particular role, while contained within the same file, you can associate the setting with one or more roles and thereby restrict its application to nodes with these roles only.
                    </para>
                    <para>
                        Additionally, settings can vary per environment. Set the environment property on a setting to only apply the setting to nodes in that environment.
                    </para>

                </listitem>
                <listitem>
                    <formalpara id="form-Architecture_and_Design-Configuration_Management_Objects-service">
                        <title>service</title>
                        <para>
                            A service is a (set of) task(s) to perform in a role.
                        </para>

                    </formalpara>

                </listitem>
                <listitem>
                    <formalpara id="form-Architecture_and_Design-Configuration_Management_Objects-package">
                        <title>package</title>
                        <para>
                            para
                        </para>

                    </formalpara>

                </listitem>
                <listitem>
                    <formalpara id="form-Architecture_and_Design-Configuration_Management_Objects-task">
                        <title>task</title>
                        <para>
                            para
                        </para>

                    </formalpara>

                </listitem>
                <listitem>
                    <formalpara id="form-Architecture_and_Design-Configuration_Management_Objects-environment">
                        <title>environment</title>
                        <para>
                            para
                        </para>

                    </formalpara>

                </listitem>

            </itemizedlist>

        </para>

    </section>

    <section id="sect-Architecture_and_Design-Configuration_Management-Kolab_Configuration_File">
        <title>Kolab Configuration File</title>
        <para>
            The main Kolab configuration file is <filename>/etc/kolab/kolab.conf</filename>.
        </para>
        <note>
            <title>TODO</title>
            <para>
                This does not take into account using POSIX permissions for command-line users using the toolchain.
            </para>

        </note>
        <para>
            The format of the configuration file is the INI format, which consists of the following syntax:
        </para>
        <para>

<screen>[section]
; comment line

key1 = value
key2 = value
    continued value for key2</screen>

        </para>
        <para>
            The configuration file has a mandatory section, <literal>[kolab]</literal>, which controls much of the information to the base of the Kolab deployment.
        </para>
        <section id="sect-Architecture_and_Design-Kolab_Configuration_File-kolab">
            <title>[kolab]</title>
            <para>
                The following is an overview of settings available in the <literal>[kolab]</literal> section:
            </para>
            <para>
                <itemizedlist>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-kolab-auth_mechanism_ldap">
                            <title><literal>auth_mechanism</literal> (<emphasis>ldap</emphasis>)</title>
                            <para>
                                The authentication and authorization database technology to use for the primary domain name space in this Kolab deployment. If not set, defaults to a value of 'ldap'.
                            </para>

                        </formalpara>
                        <para>
                            Possible options currently include: 'ldap'.
                        </para>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-kolab-primary_domain_constants.domainname">
                            <title><literal>primary_domain</literal> (<emphasis>constants.domainname</emphasis>)</title>
                            <para>
                                The primary domain name space for this Kolab deployment. If not set, defaults to the value of the PyKolab constant <literal>domainname</literal>, which is derived from the system fully qualified domain name.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-kolab-imap_backend_cyrus_imap">
                            <title><literal>imap_backend</literal> (<emphasis>cyrus-imap</emphasis>)</title>
                            <para>
                                The IMAP backend technology used.
                            </para>

                        </formalpara>
                        <para>
                            Valid options currently include: <emphasis>cyrus-imap</emphasis>
                        </para>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-kolab-default_quota_None">
                            <title><literal>default_quota</literal> (<emphasis>None</emphasis>)</title>
                            <para>
                                Default quota to apply to user mailboxes. Any integer representing a number of kilobytes will do. Defaults to 'None', which is actually to say, no default quota will be applied.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-kolab-virtual_domains_userid">
                            <title><literal>virtual_domains</literal> (<emphasis>userid</emphasis>)</title>
                            <para>
                                In which mode the IMAP 'virtual_domains' feature is enabled. Not in use yet.
                            </para>

                        </formalpara>

                    </listitem>

                </itemizedlist>

            </para>

        </section>

        <section id="sect-Architecture_and_Design-Kolab_Configuration_File-ldap">
            <title>[ldap]</title>
            <para>
                The primary LDAP settings are contained within this section. The following settings are available:
            </para>
            <para>
                <itemizedlist>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-ldap_uri_ldaplocalhost389">
                            <title><literal>ldap_uri</literal> (<emphasis>ldap://localhost:389</emphasis>)</title>
                            <para>
                                The URI to the LDAP server. Contains only the scheme ('ldap', 'ldaps'), the LDAP server connection address (an IP address or DNS name), and the port to use.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-base_dn_None">
                            <title><literal>base_dn</literal> (<emphasis>None</emphasis>)</title>
                            <para>
                                This setting contains the absolute top-level that Kolab is allowed to use. While most commonly the same value as the root distinguished name (root dn) for the tree, <emphasis>dc=example,dc=org</emphasis> for example, this is not always the case.
                            </para>

                        </formalpara>
                        <para>
                            Despite the fact that Kolab can generate a domain-component oriented naming scheme base dn from the domain name space configured as or believed to be the primary domain, Kolab often requires the configuration of the overall base distinguished name (base dn) as LDAP trees may use a non-domain component oriented naming scheme, such as <emphasis>o=organization,c=nl</emphasis>, or use a different level of depth.
                        </para>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-bind_dn_None">
                            <title><literal>bind_dn</literal> (<emphasis>None</emphasis>)</title>
                            <para>
                                The distinguished name of the account to use for bind operations. This is part of a set of bind credentials used as a last resort only.
                            </para>

                        </formalpara>
                        <para>
                            If you have other, more functionally specific bind credentials configured as well, set this to the bind dn which has the least privileges (i.e. an anonymous user).
                        </para>
                        <para>
                            If you have no other functionally more specific bind credentials configured, set this to the bind dn used to allow the most actions to be executed against the LDAP server, for example <emphasis>cn=Directory Manager</emphasis>.
                        </para>
                        <para>
                            See <xref linkend="sect-Architecture_and_Design-Kolab_Configuration_File-Use_of_Bind_Credentials" /> for more information on configuring functional specific bind credentials.
                        </para>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-bind_pw_None">
                            <title><literal>bind_pw</literal> (<emphasis>None</emphasis>)</title>
                            <para>
                                The password corresponding with the bind dn configured in <xref linkend="form-Architecture_and_Design-ldap-bind_dn_None" />.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-auth_attributes_mail">
                            <title><literal>auth_attributes</literal> (<emphasis>mail</emphasis>)</title>
                            <para>
                                A comma- or comma-space separated list of entry attribute names of which the value is to be allowed as the login name during authentication.
                            </para>

                        </formalpara>
                        <para>
                            This enables an administrator to allow users to login with their entry's <literal>uid</literal> attribute value, in addition to their entry's <literal>mail</literal> attribute value.
                        </para>
                        <para>
                            Common attribute names in this list include: <literal>alias</literal>, <literal>mail</literal>, <literal>mailAlternateAddress</literal>, <literal>uid</literal>.
                        </para>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-quota_attribute_mailquota">
                            <title><literal>quota_attribute</literal> (<emphasis>mailquota</emphasis>)</title>
                            <para>
                                The attribute to use for a user's mail quota.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-mailserver_attribute_mailhost">
                            <title><literal>mailserver_attribute</literal> (<emphasis>mailhost</emphasis>)</title>
                            <para>
                                The attribute to use for a user's mail server.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-user_base_dn_base_dns">
                            <title><literal>user_base_dn</literal> (<emphasis>%(base_dn)s</emphasis>)</title>
                            <para>
                                The base dn to use when searching for users.
                            </para>

                        </formalpara>
                        <para>
                            If not specified, the value of <xref linkend="form-Architecture_and_Design-ldap-base_dn_None" /> is used.
                        </para>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-user_filter_objectClass">
                            <title><literal>user_filter</literal> (<emphasis>(objectClass=*)</emphasis>)</title>
                            <para>
                                The filter to use when searching for users.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-user_name_attribute_uid">
                            <title><literal>user_name_attribute</literal> (<emphasis>uid</emphasis>)</title>
                            <para>
                                The RDN attribute name (and value) to use. The value for this configuration setting should use a globally unique attribute.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-user_scope_sub">
                            <title><literal>user_scope</literal> (<emphasis>sub</emphasis>)</title>
                            <para>
                                The scope to use when searching for users.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-kolab_user_base_dn_base_dns">
                            <title><literal>kolab_user_base_dn</literal> (<emphasis>%(base_dn)s</emphasis>)</title>
                            <para>
                                The base dn to use when searching for users of type 'kolab'.
                            </para>

                        </formalpara>
                        <para>
                            If not specified, the value of <xref linkend="form-Architecture_and_Design-ldap-user_base_dn_base_dns" /> is used.
                        </para>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-kolab_user_filter_objectClass">
                            <title><literal>kolab_user_filter</literal> (<emphasis>(objectClass=*)</emphasis>)</title>
                            <para>
                                The filter to use when searching for users of type 'kolab'.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-kolab_user_scope_sub">
                            <title><literal>kolab_user_scope</literal> (<emphasis>sub</emphasis>)</title>
                            <para>
                                The scope to use when searching for users of type 'kolab'.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-special_user_base_dn_base_dns">
                            <title><literal>special_user_base_dn</literal> (<emphasis>%(base_dn)s</emphasis>)</title>
                            <para>
                                The base dn to use when searching for users of type 'special'.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-special_user_filter_objectClass">
                            <title><literal>special_user_filter</literal> (<emphasis>(objectClass=*)</emphasis>)</title>
                            <para>
                                The filter to use when searching for users of type 'special'.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-special_user_scope_sub">
                            <title><literal>special_user_scope</literal> (<emphasis>sub</emphasis>)</title>
                            <para>
                                The scope to use when searching for users of type 'special'.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-group_base_dn_base_dns">
                            <title><literal>group_base_dn</literal> (<emphasis>%(base_dn)s</emphasis>)</title>
                            <para>
                                The base dn to use when searching for groups.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-group_filter_objectClass">
                            <title><literal>group_filter</literal> (<emphasis>(objectClass=*)</emphasis>)</title>
                            <para>
                                The filter to use when searching for groups.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-group_name_attribute_cn">
                            <title><literal>group_name_attribute</literal> (<emphasis>cn</emphasis>)</title>
                            <para>
                                The RDN attribute to use for groups. This should use a globally unique attribute.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-group_scope_sub">
                            <title><literal>group_scope</literal> (<emphasis>sub</emphasis>)</title>
                            <para>
                                The scope to use when searching for groups.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-domain_base_dn_base_dns">
                            <title><literal>domain_base_dn</literal> (<emphasis>%(base_dn)s</emphasis>)</title>
                            <para>
                                The base dn to use when searching for domains.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-domain_filter_objectClass">
                            <title><literal>domain_filter</literal> (<emphasis>(objectClass=*)</emphasis>)</title>
                            <para>
                                The filter to use when searching for domains.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-domain_scope_sub">
                            <title><literal>domain_scope</literal> (<emphasis>sub</emphasis>)</title>
                            <para>
                                The scope to use when searching for domains.
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-domain_name_attribute_associateddomain">
                            <title><literal>domain_name_attribute</literal> (<emphasis>associateddomain</emphasis>)</title>
                            <para>
                                The naming attribute for domains. Results in the first value of the list of values contained within the attribute values for a single entry to be used as the Relative Distinguished Name (RDN).
                            </para>

                        </formalpara>

                    </listitem>
                    <listitem>
                        <formalpara id="form-Architecture_and_Design-ldap-domain_rootdn_attribute_inetdomainbasedn">
                            <title><literal>domain_rootdn_attribute</literal> (<emphasis>inetdomainbasedn</emphasis>)</title>
                            <para>
                                The attribute that contains a reference to the root dn to use for the domain.
                            </para>

                        </formalpara>

                    </listitem>

                </itemizedlist>

            </para>

        </section>

        <section id="sect-Architecture_and_Design-Kolab_Configuration_File-A_Base_DN_for_Every_Type">
            <title>A Base DN for Every Type</title>
            <para>
                The configuration can hold a base distinguished name setting for every type of account or group available in the Kolab deployment.
            </para>
            <para>
                When the configuration is used, the Kolab programs attempt to get user or group type specific settings first, and fall back onto the generic setting. When, for example, the base dn for Kolab users is needed, first the setting <literal>kolab_user_base_dn</literal> is obtained from the configuration, and should it not have been configured, it will fall back to using <literal>user_base_dn</literal>. Should that setting also not be available, the program will fall back to using <literal>base_dn</literal>.
            </para>
            <para>
                The configuration for a particular type of user or group primarily serves large LDAP directories.
            </para>

        </section>

        <section id="sect-Architecture_and_Design-Kolab_Configuration_File-Use_of_Bind_Credentials">
            <title>Use of Bind Credentials</title>
            <para>
                The configuration can hold a series of bind credentials, ...;
            </para>

        </section>


    </section>


</chapter>