From e5862b05e60663d5eb6ddd893f7cf9b6b85b46f4 Mon Sep 17 00:00:00 2001
From: Vasek Sraier <git@vakabus.cz>
Date: Mon, 6 Mar 2023 20:00:44 +0100
Subject: [PATCH] doc: deployment

---
 doc/deployment-advanced-no-manager.rst   | 10 +++-------
 doc/deployment-docker.rst                |  2 +-
 doc/deployment-manual.rst                | 10 +++++++++-
 doc/deployment-no-systemd-privileges.rst |  2 ++
 doc/deployment-no-systemd-processes.rst  |  2 ++
 doc/deployment-no-systemd.rst            |  2 ++
 doc/deployment-warning.rst               | 10 ++++++++++
 doc/index.rst                            |  2 +-
 8 files changed, 30 insertions(+), 10 deletions(-)
 create mode 100644 doc/deployment-warning.rst

diff --git a/doc/deployment-advanced-no-manager.rst b/doc/deployment-advanced-no-manager.rst
index 155116445..31512fe28 100644
--- a/doc/deployment-advanced-no-manager.rst
+++ b/doc/deployment-advanced-no-manager.rst
@@ -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.
diff --git a/doc/deployment-docker.rst b/doc/deployment-docker.rst
index 6d7a7e6c1..787a9b7a3 100644
--- a/doc/deployment-docker.rst
+++ b/doc/deployment-docker.rst
@@ -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::
     
diff --git a/doc/deployment-manual.rst b/doc/deployment-manual.rst
index 5d05847d8..d53a16926 100644
--- a/doc/deployment-manual.rst
+++ b/doc/deployment-manual.rst
@@ -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
diff --git a/doc/deployment-no-systemd-privileges.rst b/doc/deployment-no-systemd-privileges.rst
index e2c2ab9c0..78e11444b 100644
--- a/doc/deployment-no-systemd-privileges.rst
+++ b/doc/deployment-no-systemd-privileges.rst
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
+.. include:: deployment-warning.rst
+
 Privileges and capabilities
 ===========================
 
diff --git a/doc/deployment-no-systemd-processes.rst b/doc/deployment-no-systemd-processes.rst
index 59aed1b07..362e85460 100644
--- a/doc/deployment-no-systemd-processes.rst
+++ b/doc/deployment-no-systemd-processes.rst
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
+.. include:: deployment-warning.rst
+
 Process management
 ==================
 
diff --git a/doc/deployment-no-systemd.rst b/doc/deployment-no-systemd.rst
index ff5f94513..6cb2bb362 100644
--- a/doc/deployment-no-systemd.rst
+++ b/doc/deployment-no-systemd.rst
@@ -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
index 000000000..117d388c1
--- /dev/null
+++ b/doc/deployment-warning.rst
@@ -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
diff --git a/doc/index.rst b/doc/index.rst
index 12bddad84..255a76035 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -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::
-- 
2.47.3