From: Michal 'vorner' Vaner Date: Fri, 3 Feb 2012 21:26:41 +0000 (+0100) Subject: [1596] Documentation X-Git-Tag: trac2351_base~97^2~32^2~3^2~10 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f5ea0617661d39ecd576f3d997cf20009ac05048;p=thirdparty%2Fkea.git [1596] Documentation --- diff --git a/doc/guide/bind10-guide.html b/doc/guide/bind10-guide.html index 6abe287900..4ae31f57cc 100644 --- a/doc/guide/bind10-guide.html +++ b/doc/guide/bind10-guide.html @@ -1,4 +1,4 @@ -BIND 10 Guide

BIND 10 Guide

Administrator Reference for BIND 10

This is the reference guide for BIND 10 version +BIND 10 Guide

BIND 10 Guide

Administrator Reference for BIND 10

This is the reference guide for BIND 10 version 20120127.

Copyright © 2010-2012 Internet Systems Consortium, Inc.

Abstract

BIND 10 is a framework that features Domain Name System (DNS) suite and Dynamic Host Configuration Protocol (DHCP) servers managed by Internet Systems Consortium (ISC). It @@ -10,9 +10,9 @@ The most up-to-date version of this document (in PDF, HTML, and plain text formats), along with other documents for BIND 10, can be found at http://bind10.isc.org/docs. -

Table of Contents

Preface
1. Acknowledgements
1. Introduction
1.1. Supported Platforms
1.2. Required Software
1.3. Starting and Stopping the Server
1.4. Managing BIND 10
2. Installation
2.1. Building Requirements
2.2. Quick start
2.3. Installation from source
2.3.1. Download Tar File
2.3.2. Retrieve from Git
2.3.3. Configure before the build
2.3.4. Build
2.3.5. Install
2.3.6. Install Hierarchy
3. Starting BIND10 with bind10
3.1. Starting BIND 10
3.2. Configuration of started processes
4. Command channel
5. Configuration manager
6. Remote control daemon
6.1. Configuration specification for b10-cmdctl
7. Control and configure user interface
8. Authoritative Server
8.1. Server Configurations
8.2. Data Source Backends
8.3. Loading Master Zones Files
9. Incoming Zone Transfers
9.1. Configuration for Incoming Zone Transfers
9.2. Enabling IXFR
9.3. Secondary Manager
9.4. Trigger an Incoming Zone Transfer Manually
10. Outbound Zone Transfers
11. Recursive Name Server
11.1. Access Control
11.2. Forwarding
12. DHCPv4 Server
12.1. DHCPv4 Server Usage
12.2. DHCPv4 Server Configuration
12.3. Supported standards
12.4. DHCPv4 Server Limitations
13. DHCPv6 Server
13.1. DHCPv6 Server Usage
13.2. DHCPv6 Server Configuration
13.3. Supported DHCPv6 Standards
13.4. DHCPv6 Server Limitations
14. libdhcp++ library
14.1. Interface detection
14.2. DHCPv4/DHCPv6 packet handling
15. Statistics
16. Logging
16.1. Logging configuration
16.1.1. Loggers
16.1.2. Output Options
16.1.3. Example session
16.2. Logging Message Format

List of Tables

3.1.

Preface

Table of Contents

1. Acknowledgements

1. Acknowledgements

ISC would like to acknowledge generous support for +

Table of Contents

Preface
1. Acknowledgements
1. Introduction
1.1. Supported Platforms
1.2. Required Software
1.3. Starting and Stopping the Server
1.4. Managing BIND 10
2. Installation
2.1. Building Requirements
2.2. Quick start
2.3. Installation from source
2.3.1. Download Tar File
2.3.2. Retrieve from Git
2.3.3. Configure before the build
2.3.4. Build
2.3.5. Install
2.3.6. Install Hierarchy
3. Starting BIND10 with bind10
3.1. Starting BIND 10
3.2. Configuration of started processes
4. Command channel
5. Configuration manager
6. Remote control daemon
6.1. Configuration specification for b10-cmdctl
7. Control and configure user interface
8. Authoritative Server
8.1. Server Configurations
8.2. Data Source Backends
8.3. Loading Master Zones Files
9. Incoming Zone Transfers
9.1. Configuration for Incoming Zone Transfers
9.2. Enabling IXFR
9.3. Secondary Manager
9.4. Trigger an Incoming Zone Transfer Manually
10. Outbound Zone Transfers
11. Recursive Name Server
11.1. Access Control
11.2. Forwarding
12. DHCPv4 Server
12.1. DHCPv4 Server Usage
12.2. DHCPv4 Server Configuration
12.3. Supported standards
12.4. DHCPv4 Server Limitations
13. DHCPv6 Server
13.1. DHCPv6 Server Usage
13.2. DHCPv6 Server Configuration
13.3. Supported DHCPv6 Standards
13.4. DHCPv6 Server Limitations
14. libdhcp++ library
14.1. Interface detection
14.2. DHCPv4/DHCPv6 packet handling
15. Statistics
16. Logging
16.1. Logging configuration
16.1.1. Loggers
16.1.2. Output Options
16.1.3. Example session
16.2. Logging Message Format

List of Tables

3.1.

Preface

Table of Contents

1. Acknowledgements

1. Acknowledgements

ISC would like to acknowledge generous support for BIND 10 development of DHCPv4 and DHCPv6 components provided - by Comcast.

Chapter 1. Introduction

Table of Contents

1.1. Supported Platforms
1.2. Required Software
1.3. Starting and Stopping the Server
1.4. Managing BIND 10

+ by Comcast.

Chapter 1. Introduction

Table of Contents

1.1. Supported Platforms
1.2. Required Software
1.3. Starting and Stopping the Server
1.4. Managing BIND 10

BIND is the popular implementation of a DNS server, developer interfaces, and DNS tools. BIND 10 is a rewrite of BIND 9. BIND 10 is written in C++ and Python @@ -23,7 +23,7 @@

This guide covers the experimental prototype of BIND 10 version 20120127. -

1.1. Supported Platforms

+

1.1. Supported Platforms

BIND 10 builds have been tested on Debian GNU/Linux 5 and unstable, Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7 and 8, CentOS Linux 5.3, and MacOS 10.6. @@ -152,7 +152,7 @@ and, of course, DNS. These include detailed developer documentation and code examples. -

Chapter 2. Installation

Table of Contents

2.1. Building Requirements
2.2. Quick start
2.3. Installation from source
2.3.1. Download Tar File
2.3.2. Retrieve from Git
2.3.3. Configure before the build
2.3.4. Build
2.3.5. Install
2.3.6. Install Hierarchy

2.1. Building Requirements

+

Chapter 2. Installation

Table of Contents

2.1. Building Requirements
2.2. Quick start
2.3. Installation from source
2.3.1. Download Tar File
2.3.2. Retrieve from Git
2.3.3. Configure before the build
2.3.4. Build
2.3.5. Install
2.3.6. Install Hierarchy

2.1. Building Requirements

In addition to the run-time requirements, building BIND 10 from source code requires various development include headers.

Note

@@ -214,14 +214,14 @@ the Git code revision control system or as a downloadable tar file. It may also be available in pre-compiled ready-to-use packages from operating system vendors. -

2.3.1. Download Tar File

+

2.3.1. Download Tar File

Downloading a release tar file is the recommended method to obtain the source code.

The BIND 10 releases are available as tar file downloads from ftp://ftp.isc.org/isc/bind10/. Periodic development snapshots may also be available. -

2.3.2. Retrieve from Git

+

2.3.2. Retrieve from Git

Downloading this "bleeding edge" code is recommended only for developers or advanced users. Using development code in a production environment is not recommended. @@ -255,7 +255,7 @@ autoheader, automake, and related commands. -

2.3.3. Configure before the build

+

2.3.3. Configure before the build

BIND 10 uses the GNU Build System to discover build environment details. To generate the makefiles using the defaults, simply run: @@ -286,16 +286,16 @@

If the configure fails, it may be due to missing or old dependencies. -

2.3.4. Build

+

2.3.4. Build

After the configure step is complete, to build the executables from the C++ code and prepare the Python scripts, run: 

$ make

-

2.3.5. Install

+

2.3.5. Install

To install the BIND 10 executables, support files, and documentation, run: 

$ make install

-

Note

The install step may require superuser privileges.

2.3.6. Install Hierarchy

+

Note

The install step may require superuser privileges.

2.3.6. Install Hierarchy

The following is the layout of the complete BIND 10 installation:

  • bin/ — @@ -395,7 +395,7 @@ during startup or shutdown. Unless specified, the component is started in usual way. This is the list of components that need to be started in a special way, with the value of special used for them: -

    Table 3.1. 

    ComponentSpecialDescription
    b10-authauthAuthoritative server
    b10-resolverresolverThe resolver
    b10-cmdctlcmdctlThe command control (remote control interface)


    +

    Table 3.1. 

    ComponentSpecialDescription
    b10-authauthAuthoritative server
    b10-resolverresolverThe resolver
    b10-cmdctlcmdctlThe command control (remote control interface)


    The kind specifies how a failure of the component should be handled. If it is set to “dispensable” @@ -451,7 +451,23 @@

    In short, you should think twice before disabling something here. -

Chapter 4. Command channel

+

+ It is possible to start some components multiple times (currently + b10-auth and b10-resolzer). + You might want to do that to gain more performance (each one uses only + single core). Just put multiple entries under different names, like + this, with the same config: + 

> config add Boss/components b10-resolver-2
+> config set Boss/components/b10-resolver-2/special resolver
+> config set Boss/components/b10-resolver-2/kind needed
+> config commit

+

+ However, this is work in progress and the support is not yet complete. + For example, each resolver will have its own cache, each authoritative + server will keep its own copy of in-memory data and there could be + problems with locking the sqlite database, if used. The configuration + might be changed to something more convenient in future. +

Chapter 4. Command channel

The BIND 10 components use the b10-msgq message routing daemon to communicate with other BIND 10 components. The b10-msgq implements what is called the @@ -607,12 +623,12 @@ shutdown the details and relays (over a b10-msgq command channel) the configuration on to the specified module.

-

Chapter 8. Authoritative Server

Table of Contents

8.1. Server Configurations
8.2. Data Source Backends
8.3. Loading Master Zones Files

+

Chapter 8. Authoritative Server

Table of Contents

8.1. Server Configurations
8.2. Data Source Backends
8.3. Loading Master Zones Files

The b10-auth is the authoritative DNS server. It supports EDNS0 and DNSSEC. It supports IPv6. Normally it is started by the bind10 master process. -

8.1. Server Configurations

+

8.1. Server Configurations

b10-auth is configured via the b10-cfgmgr configuration manager. The module name is “Auth”. @@ -632,7 +648,7 @@ This may be a temporary setting until then.

shutdown
Stop the authoritative DNS server.

-

8.2. Data Source Backends

Note

+

8.2. Data Source Backends

Note

For the development prototype release, b10-auth supports a SQLite3 data source backend and in-memory data source backend. @@ -646,7 +662,7 @@ This may be a temporary setting until then. The default is /usr/local/var/.) This data file location may be changed by defining the “database_file” configuration. -

8.3. Loading Master Zones Files

+

8.3. Loading Master Zones Files

RFC 1035 style DNS master zone files may imported into a BIND 10 data source by using the b10-loadzone utility. @@ -675,7 +691,7 @@ This may be a temporary setting until then. If you reload a zone already existing in the database, all records from that prior zone disappear and a whole new set appears. -

Chapter 9. Incoming Zone Transfers

Table of Contents

9.1. Configuration for Incoming Zone Transfers
9.2. Enabling IXFR
9.3. Secondary Manager
9.4. Trigger an Incoming Zone Transfer Manually

+

Chapter 9. Incoming Zone Transfers

Table of Contents

9.1. Configuration for Incoming Zone Transfers
9.2. Enabling IXFR
9.3. Secondary Manager
9.4. Trigger an Incoming Zone Transfer Manually

Incoming zones are transferred using the b10-xfrin process which is started by bind10. When received, the zone is stored in the corresponding BIND 10 @@ -693,7 +709,7 @@ This may be a temporary setting until then. In the current development release of BIND 10, incoming zone transfers are only available for SQLite3-based data sources, that is, they don't work for an in-memory data source. -

9.1. Configuration for Incoming Zone Transfers

+

9.1. Configuration for Incoming Zone Transfers

In practice, you need to specify a list of secondary zones to enable incoming zone transfers for these zones (you can still trigger a zone transfer manually, without a prior configuration @@ -709,7 +725,7 @@ This may be a temporary setting until then. > config commit

(We assume there has been no zone configuration before). -

9.2. Enabling IXFR

+

9.2. Enabling IXFR

As noted above, b10-xfrin uses AXFR for zone transfers by default. To enable IXFR for zone transfers for a particular zone, set the use_ixfr @@ -761,7 +777,7 @@ This may be a temporary setting until then. (i.e. no SOA record for it), b10-zonemgr will automatically tell b10-xfrin to transfer the zone in. -

9.4. Trigger an Incoming Zone Transfer Manually

+

9.4. Trigger an Incoming Zone Transfer Manually

To manually trigger a zone transfer to retrieve a remote zone, you may use the bindctl utility. For example, at the bindctl prompt run: @@ -818,7 +834,7 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

use the system wide TSIG configuration. The way to specify zone specific configuration (ACLs, etc) is likely to be changed, too. -

Chapter 11. Recursive Name Server

Table of Contents

11.1. Access Control
11.2. Forwarding

+

Chapter 11. Recursive Name Server

Table of Contents

11.1. Access Control
11.2. Forwarding

The b10-resolver process is started by bind10. @@ -857,7 +873,7 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

(Replace the “2” as needed; run “config show - Resolver/listen_on” if needed.)

11.1. Access Control

+ Resolver/listen_on” if needed.)

11.1. Access Control

By default, the b10-resolver daemon only accepts DNS queries from the localhost (127.0.0.1 and ::1). The Resolver/query_acl configuration may @@ -890,7 +906,7 @@ Xfrout/transfer_acl[0] {"action": "ACCEPT"} any (default)

(Replace the “2” as needed; run “config show Resolver/query_acl” if needed.)

Note

This prototype access control configuration - syntax may be changed.

11.2. Forwarding

+ syntax may be changed.

11.2. Forwarding

To enable forwarding, the upstream address and port must be configured to forward queries to, such as: @@ -1202,7 +1218,7 @@ eth0 fe80::21e:8cff:fe9b:7349 } }

-

Chapter 16. Logging

Table of Contents

16.1. Logging configuration
16.1.1. Loggers
16.1.2. Output Options
16.1.3. Example session
16.2. Logging Message Format

16.1. Logging configuration

+

Chapter 16. Logging

Table of Contents

16.1. Logging configuration
16.1.1. Loggers
16.1.2. Output Options
16.1.3. Example session
16.2. Logging Message Format

16.1. Logging configuration

The logging system in BIND 10 is configured through the Logging module. All BIND 10 modules will look at the @@ -1211,7 +1227,7 @@ eth0 fe80::21e:8cff:fe9b:7349 -

16.1.1. Loggers

+

16.1.1. Loggers

Within BIND 10, a message is logged through a component called a "logger". Different parts of BIND 10 log messages @@ -1232,7 +1248,7 @@ eth0 fe80::21e:8cff:fe9b:7349 (what to log), and the output_options (where to log). -

16.1.1.1. name (string)

+

16.1.1.1. name (string)

Each logger in the system has a name, the name being that of the component using it to log messages. For instance, if you want to configure logging for the resolver module, @@ -1305,7 +1321,7 @@ eth0 fe80::21e:8cff:fe9b:7349 “Auth.cache” logger will appear in the output with a logger name of “b10-auth.cache”). -

16.1.1.2. severity (string)

+

16.1.1.2. severity (string)

This specifies the category of messages logged. Each message is logged with an associated severity which @@ -1321,7 +1337,7 @@ eth0 fe80::21e:8cff:fe9b:7349 -

16.1.1.3. output_options (list)

+

16.1.1.3. output_options (list)

Each logger can have zero or more output_options. These specify where log @@ -1331,7 +1347,7 @@ eth0 fe80::21e:8cff:fe9b:7349 The other options for a logger are: -

16.1.1.4. debuglevel (integer)

+

16.1.1.4. debuglevel (integer)

When a logger's severity is set to DEBUG, this value specifies what debug messages should be printed. It ranges @@ -1340,7 +1356,7 @@ eth0 fe80::21e:8cff:fe9b:7349 If severity for the logger is not DEBUG, this value is ignored. -

16.1.1.5. additive (true or false)

+

16.1.1.5. additive (true or false)

If this is true, the output_options from the parent will be used. For example, if there are two @@ -1354,18 +1370,18 @@ eth0 fe80::21e:8cff:fe9b:7349 -

16.1.2. Output Options

+

16.1.2. Output Options

The main settings for an output option are the destination and a value called output, the meaning of which depends on the destination that is set. -

16.1.2.1. destination (string)

+

16.1.2.1. destination (string)

The destination is the type of output. It can be one of: -

  • console
  • file
  • syslog

16.1.2.2. output (string)

+

  • console
  • file
  • syslog

16.1.2.2. output (string)

Depending on what is set as the output destination, this value is interpreted as follows: @@ -1387,12 +1403,12 @@ eth0 fe80::21e:8cff:fe9b:7349 The other options for output_options are: -

16.1.2.2.1. flush (true of false)

+

16.1.2.2.1. flush (true of false)

Flush buffers after each log message. Doing this will reduce performance but will ensure that if the program terminates abnormally, all messages up to the point of termination are output. -

16.1.2.2.2. maxsize (integer)

+

16.1.2.2.2. maxsize (integer)

Only relevant when destination is file, this is maximum file size of output files in bytes. When the maximum size is reached, the file is renamed and a new file opened. @@ -1401,11 +1417,11 @@ eth0 fe80::21e:8cff:fe9b:7349 etc.)

If this is 0, no maximum file size is used. -

16.1.2.2.3. maxver (integer)

+

16.1.2.2.3. maxver (integer)

Maximum number of old log files to keep around when rolling the output file. Only relevant when destination is “file”. -

16.1.3. Example session

+

16.1.3. Example session

In this example we want to set the global logging to write to the file /var/log/my_bind10.log, @@ -1566,7 +1582,7 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified) And every module will now be using the values from the logger named “*”. -

16.2. Logging Message Format

+

16.2. Logging Message Format

Each message written by BIND 10 to the configured logging destinations comprises a number of components that identify the origin of the message and, if the message indicates diff --git a/doc/guide/bind10-guide.xml b/doc/guide/bind10-guide.xml index c551c5f969..eafbbd8c78 100644 --- a/doc/guide/bind10-guide.xml +++ b/doc/guide/bind10-guide.xml @@ -913,7 +913,24 @@ address, but the usual ones don't." mean? --> In short, you should think twice before disabling something here. - + + It is possible to start some components multiple times (currently + b10-auth and b10-resolzer). + You might want to do that to gain more performance (each one uses only + single core). Just put multiple entries under different names, like + this, with the same config: + > config add Boss/components b10-resolver-2 +> config set Boss/components/b10-resolver-2/special resolver +> config set Boss/components/b10-resolver-2/kind needed +> config commit + + + However, this is work in progress and the support is not yet complete. + For example, each resolver will have its own cache, each authoritative + server will keep its own copy of in-memory data and there could be + problems with locking the sqlite database, if used. The configuration + might be changed to something more convenient in future. +