diff --git a/doc/configuration.xml b/doc/configuration.xml new file mode 100644 index 0000000000000000000000000000000000000000..41250782a8c30c85fd7ac38dcc24f1e2c43f6b7b --- /dev/null +++ b/doc/configuration.xml @@ -0,0 +1,6 @@ +<chapter> + <title>Knot DNS Configuration</title> + <para> + [TODO] + </para> +</chapter> diff --git a/doc/introduction.xml b/doc/introduction.xml new file mode 100644 index 0000000000000000000000000000000000000000..6ba90a304e072041eda94adb5dfa0981191a5e01 --- /dev/null +++ b/doc/introduction.xml @@ -0,0 +1,41 @@ +<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> diff --git a/doc/knot.xml b/doc/knot.xml new file mode 100644 index 0000000000000000000000000000000000000000..bd3ab1f13c5bce860493eec98becf2dbf3f7d668 --- /dev/null +++ b/doc/knot.xml @@ -0,0 +1,34 @@ +<?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> diff --git a/doc/migration.xml b/doc/migration.xml new file mode 100644 index 0000000000000000000000000000000000000000..0f42b4790f4258847c68f5ce38a0d325cb319611 --- /dev/null +++ b/doc/migration.xml @@ -0,0 +1,32 @@ +<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> diff --git a/doc/reference.xml b/doc/reference.xml new file mode 100644 index 0000000000000000000000000000000000000000..fddd5552ee98162f85d06e56af699d4efcc2323a --- /dev/null +++ b/doc/reference.xml @@ -0,0 +1,6 @@ +<chapter> + <title>Knot DNS Configuration Reference</title> + <para> + [TODO] + </para> +</chapter> diff --git a/doc/resources.xml b/doc/resources.xml new file mode 100644 index 0000000000000000000000000000000000000000..7d6c75d1a3e8f1efbdd72e85d5ee895e460eb856 --- /dev/null +++ b/doc/resources.xml @@ -0,0 +1,47 @@ +<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> diff --git a/doc/security.xml b/doc/security.xml new file mode 100644 index 0000000000000000000000000000000000000000..ab06d307be600163c4b6f0d8a468b3b390351bb3 --- /dev/null +++ b/doc/security.xml @@ -0,0 +1,10 @@ +<chapter> + <title>Security Considerations</title> + <para> + [TODO] + + - faces the internet + + - Linux capabilities used + </para> +</chapter> diff --git a/doc/troubleshooting.xml b/doc/troubleshooting.xml new file mode 100644 index 0000000000000000000000000000000000000000..92e60d20411133b440ed7cecabde8c96a7e42926 --- /dev/null +++ b/doc/troubleshooting.xml @@ -0,0 +1,6 @@ +<chapter> + <title>Troubleshooting</title> + <para> + Check the LOGS! + </para> +</chapter>