From 59eb68cba28e72a8a0e58d651a12d5d4bb1fe2e1 Mon Sep 17 00:00:00 2001 From: Vasek Sraier Date: Fri, 3 Mar 2023 16:05:26 +0100 Subject: [PATCH] doc: docker deployment --- doc/deployment-docker.rst | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/doc/deployment-docker.rst b/doc/deployment-docker.rst index db874c615..6d7a7e6c1 100644 --- a/doc/deployment-docker.rst +++ b/doc/deployment-docker.rst @@ -1,3 +1,21 @@ ****** Docker -****** \ No newline at end of file +****** + + +.. note:: + + Before version 6, our Docker images were not meant to be used in production. This is no longer the case and with the introduction of ``kres-manager``, Knot Resolver runs in containers without any issues. + +An official Docker image can be found on `Docker Hub `_. The image contains Knot Resolver as if it was installed from our official distro packages. + +.. code-block:: bash + + 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. + +.. warning:: + + While the container image contains normal installation of Knot Resolver and there shouldn't be any differences between running it natively and in a container, we (the developers) do not have any experience using the Docker image in production. Especially, beware of running the DNS resolver with a software defined network (i.e. in Kubernetes). There will likely be some performance penalties for doing so. We haven't done any measurements comparing different types of installations so we don't know the performance differences. If you have done some measurements yourself, please reach out to us and we will share it here with everyone else. + \ No newline at end of file -- 2.47.3