]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
docs: moved old lua configuration to section "advanced configuration"
authorVasek Sraier <git@vakabus.cz>
Sun, 8 Jan 2023 22:04:15 +0000 (23:04 +0100)
committerVasek Sraier <git@vakabus.cz>
Tue, 10 Jan 2023 19:20:57 +0000 (20:20 +0100)
doc/config-lua-overview.rst
doc/config-lua.rst [new file with mode: 0644]
doc/index.rst

index 35d667a9ef06b45bd3f2ec3d058530823740bc1e..d5316c04417125514fc5cfe9d7752199cf9a2d48 100644 (file)
@@ -1,6 +1,3 @@
-
-
-
 .. _config-syntax:
 
 Syntax
diff --git a/doc/config-lua.rst b/doc/config-lua.rst
new file mode 100644 (file)
index 0000000..bcdf2fe
--- /dev/null
@@ -0,0 +1,23 @@
+
+Advanced configuration (Lua)
+============================
+
+Knot Resolver can be configured declaratively by using YAML files or YAML/JSON HTTP API. However, there is another option. The actual worker processes (the ``kresd`` executable) speaks a different configuration language, it internally uses the Lua runtime and the respective programming language.
+
+Essentially, the declarative configuration is only used for validation and as an external interface. After validation, a Lua configuration is generated and passed into individual ``kresd`` instances. You can see the generated configuration files within the Resolver's working directory or you can manually run the conversion of declarative configuration with the ``kresctl convert`` command.
+
+.. warning::
+        While there are no plans of ever removing the Lua configuration, we do not guarantee absence of backwards incompatible changes. Starting with Knot Resolver version 6 and later, we consider the Lua interface internal and a subject to change. While we don't have any breaking changes planned for the foreseeable future, they might come.
+
+        **Therefore, use this only when you don't have any other option. And please let us know about it and we might try to accomodate your usecase in the declarative configuration.**
+
+.. toctree::
+   :maxdepth: 2
+   
+   config-lua-overview
+   config-network
+   config-performance
+   config-policy
+   config-logging-monitoring
+   config-dnssec
+   config-experimental
\ No newline at end of file
index 4c5f4944b071da1d309accfb8e9c38aef3c73e80..5c2ccb0ebca3d58d8a46e59eca83a66c0901a603 100644 (file)
@@ -48,13 +48,8 @@ and it provides a state-machine like API for extensions.
 
    config-overview
    config-schema
-   config-network
-   config-performance
-   config-policy
-   config-logging-monitoring
-   config-dnssec
-   config-experimental
    config-no-systemd
+   config-lua
 
 
 .. toctree::