Skip to content
Snippets Groups Projects
Commit 36f3d878 authored by Ondřej Surý's avatar Ondřej Surý
Browse files

Add initial skeleton for documentation

parent a8d96970
No related branches found
No related tags found
No related merge requests found
<chapter>
<title>Knot DNS Configuration</title>
<para>
[TODO]
</para>
</chapter>
<chapter>
<title>Introduction</title>
<para>
The reader of this document is assumed to know the principles of
Domain Name System.
</para>
<section>
<title>What is Knot DNS</title>
<para>
Knot DNS implements a domain name server. It implements only
authoritative domain name service and can be used to serve DNS
zones in the Internet.
</para>
<para>
Knot DNS supports following features:
<simplelist>
<member>TCP/UDP</member>
<member>AXFR</member>
<member>IXFR</member>
<member>TSIG</member>
<member>...</member>
</simplelist>
</para>
</section>
<section>
<title>Scope of Document</title>
<para>
This document covers the basic information on installing,
configuring and troubleshooting the Knot DNS server. We have
also dedicated a chapter for users of other DNS server
implementations where describe how to migrate their
configuration to Knot DNS.
</para>
</section>
<section>
<title>Conventions Used in This Document</title>
<para>
[TODO]:
</para>
</section>
</chapter>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V5.1//EN"
"http://www.oasis-open.org/docbook/xml/5.1/docbookx.dtd" [
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY resources SYSTEM "resources.xml">
<!ENTITY installation SYSTEM "installation.xml">
<!ENTITY configuration SYSTEM "configuration.xml">
<!ENTITY migration SYSTEM "migration.xml">
<!ENTITY reference SYSTEM "reference.xml">
<!ENTITY security SYSTEM "security.xml">
<!ENTITY troubleshooting SYSTEM "troubleshooting.xml">
]>
<book xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
<title>Knot DNS Reference Manual</title>
<author>
<personname>
<firstname>Ondřej</firstname><surname>Surý</surname>
<email>ondrej.sury@nic.cz</email>
<affiliation>CZ.NIC, z.s.p.o.</affiliation>
</personame>
</author>
<copyright><year>2012</year><holder>CZ.NIC, z.s.p.o.</holder></copyright>
</info>
&introduction;
&resources;
&installation;
&configuration;
&migration;
&reference;
&security;
&troubleshooting;
</book>
<chapter>
<title>Migration for other DNS servers</title>
<section>
<title>Knot DNS for BIND users</title>
<para>
[TODO]
</para>
</section>
<section>
<title>Knot DNS for NSD users</title>
<para>
[TODO]
</para>
</section>
<section>
<title>Knot DNS for PowerDNS users</title>
<para>
[TODO]
</para>
</section>
<section>
<title>Knot DNS for djbdns users</title>
<para>
[TODO]
</para>
</section>
</chapter>
<chapter>
<title>Knot DNS Configuration Reference</title>
<para>
[TODO]
</para>
</chapter>
<chapter>
<title>Knot DNS Resource Requirements</title>
<section>
<title>Hardware Requirements</title>
<para>
Knot DNS requirements are not very demanding for typical
installations, and a comodity server or virtualized solution
will be sufficient in most cases.
</para>
<para>
However please not that there are some scenarios that will
require the administrator attention and a testing of exact
requirements before deploying Knot DNS in a production. These
cases include deployment for a large number of zones (DNS
hosting), a large number of records in one or more zones (TLD)
or large number of requests.
</para>
</section>
<section>
<title>CPU Requirements</title>
<para>
Knot DNS is not very CPU requiring, but it can consume some CPU
</para>
</section>
<section>
<title>Memory Requirements</title>
<para>
Knot DNS implementation focuses on the performance and thus can
be very demanding for the memory. The rough estimate for memory
requirements is 5-7 times of the size of the zone in text
format. Again this is only a estimate and you are advised to do
your own measurements before deploying Knot DNS into the
production.
</para>
</section>
<section>
<title>Supported Operating System</title>
<para>
Knot DNS itself is written in a portable way, but it depends on
userspace-rcu library, which is the main constraint when it
comes to the operating system support. As far as we know the
Knot DNS and userspace-rcu library can be compiled and run on
Linux, FreeBSD, OpenBSD, NetBSD and Mac OS X.
</para>
</section>
</chapter>
<chapter>
<title>Security Considerations</title>
<para>
[TODO]
- faces the internet
- Linux capabilities used
</para>
</chapter>
<chapter>
<title>Troubleshooting</title>
<para>
Check the LOGS!
</para>
</chapter>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment