]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: deployment
authorVasek Sraier <git@vakabus.cz>
Mon, 6 Mar 2023 19:00:44 +0000 (20:00 +0100)
committerAleš Mrázek <ales.mrazek@nic.cz>
Mon, 5 Jun 2023 13:34:21 +0000 (15:34 +0200)
doc/deployment-advanced-no-manager.rst
doc/deployment-docker.rst
doc/deployment-manual.rst
doc/deployment-no-systemd-privileges.rst
doc/deployment-no-systemd-processes.rst
doc/deployment-no-systemd.rst
doc/deployment-warning.rst [new file with mode: 0644]
doc/index.rst

index 155116445df4a2d64450b8410e354fbb4a2f70ee..31512fe28c60e6e40dcb27add3954ae96da7ba97 100644 (file)
@@ -1,5 +1,8 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
+
+.. include:: deployment-warning.rst
+
 .. _advanced-no-manager:
 
 *************************
@@ -7,13 +10,6 @@ Usage without the manager
 *************************
 
 
-.. warning::
-
-    This page is intended for experienced users only. If you follow these instructions, you are not protected from footguns elimited with the introduction of the manager. However, if you want to continue using Knot Resolver as before version ``6.0.0`` this is chapter for you.
-
-    For new and less experienced users, we recommend using the newer approach starting in :ref:`Getting Started <gettingstarted-intro>` chapter.
-
-
 There are a few downsides to using the Knot Resolver without the manager:.
 
 * Configuration is a imperative Lua script and can't be properly validated without actually running it.
index 6d7a7e6c115da2fb574adc02836c77c65e140ea2..787a9b7a37e324000549f22b7faafe7e13c9a224 100644 (file)
@@ -13,7 +13,7 @@ An official Docker image can be found on `Docker Hub <https://hub.docker.com/r/c
 
     docker run --rm -ti -P docker.io/cznic/knot-resolver
 
-The configuration file is located at ``/etc/knot-resolver/config.yml`` and the cache is at ``/var/cache/knot-resolver``. Having persistent cache in a mounted volume will help a lot with performance just after restart.
+The configuration file is located at ``/etc/knot-resolver/config.yml`` and the cache is at ``/var/cache/knot-resolver``. We recommend configuring a persistent cache across container restarts.
 
 .. warning::
     
index 5d05847d8db0b9e2d8692fdedff6092d0cd12833..d53a16926262cc466da0c45d8bdc56aa1504d319 100644 (file)
@@ -4,4 +4,12 @@ Manual
 
 The Knot Resolver can be started with the command ``knot-resolver``. You can provide an optional argument ``--config path/to/config.yml`` to load a different than default configuration file.
 
-The resolver does not have any external runtime dependencies and it should be able to run in most environments. The resolver does not interact with cgroups or namespaces and you can run it multiple times as long as you use a different runtime directory in the configuration.
\ No newline at end of file
+The resolver does not have any external runtime dependencies and it should be able to run in most environments. It should be possible to wrap it with any container technology.
+
+
+Multiple instances on a single server
+=====================================
+
+The only limitation for running multiple instances of Knot Resolver is that all instances must have a different runtime directory. There are however safeguards in place that should prevent accidental runtime directory conflicts.
+
+It is possible to share cache between multiple instances, just make sure that all instances have the same cache config and there is only a single garbage collector running (disable it in all but one config file).
\ No newline at end of file
index e2c2ab9c037c4766466089252ea3907442cf299a..78e11444b50f7d32f44bdf4db5111acba39df416 100644 (file)
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
+.. include:: deployment-warning.rst
+
 Privileges and capabilities
 ===========================
 
index 59aed1b074465ea4df149c088cf311bb55c90c81..362e85460b8a8288ff1731c6dca8d7ebd41cf155 100644 (file)
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
+.. include:: deployment-warning.rst
+
 Process management
 ==================
 
index ff5f94513cee805f5be2a52ed4c7893c7996c527..6cb2bb362dc1314e4ca57531c5aca9fee8999743 100644 (file)
@@ -2,6 +2,8 @@
 
 .. _usage-without-systemd:
 
+.. include:: deployment-warning.rst
+
 *****************************************
 Usage without systemd and without manager
 *****************************************
diff --git a/doc/deployment-warning.rst b/doc/deployment-warning.rst
new file mode 100644 (file)
index 0000000..117d388
--- /dev/null
@@ -0,0 +1,10 @@
+.. warning::
+
+    This page is intended for experienced users only. If you follow these
+    instructions, you are not protected from footguns elimited with the
+    introduction of the ``kres-manager``. However, if you want to continue
+    using Knot Resolver the same as before the version ``6.0.0`` this is a chapter
+    for you.
+
+    For new and less experienced users, we recommend using the newer approach
+    starting in the :ref:`Getting Started <gettingstarted-startup>` chapter.
\ No newline at end of file
index 12bddad8416537dd6d5ab1e2ed1d9f013b6edb91..255a760356901c3b74e8f1edadc19d57ad3ebbef 100644 (file)
@@ -35,8 +35,8 @@ If you are a new user, please start with chapter for :ref:`getting started <gett
    :maxdepth: 1
 
    deployment-systemd
-   deployment-docker
    deployment-manual
+   deployment-docker
    deployment-advanced
 
 .. toctree::