Commit 2fcf010b authored by mrazekales's avatar mrazekales

common-model documentation

parent 0b371f2b
Pipeline #40579 passed with stages
in 1 minute and 5 seconds
.cache .cache
.eggs .eggs
.idea
*.pyc *.pyc
bin bin
dist dist
......
...@@ -21,19 +21,69 @@ Data Model is located in ``data-model/`` project directory. ...@@ -21,19 +21,69 @@ Data Model is located in ``data-model/`` project directory.
* `Current schema tree`_ * `Current schema tree`_
* `Example JSON data`_ * `Example JSON data`_
Common Data model is divided into several sections. ----------------------------------------
Common Model - `cznic-resolver-common`_
----------------------------------------
Common Data model configuration options are divided into several sections.
In order to unify Knot and Unbound configuration into the `cznic-resolver-common`_,
some configurations are not generated directly from value in the common model, but before generating
must be converted to configuration value which is accepted by resolver.
Here is how some values are converted:
server: server:
------------- ^^^^^^^
There is no ``group-name`` option for Unbound to set.
.. code-block:: python
DataModel: "server": {
"user-name": "username",
"group-name": "group"
}
KnotResolver: user('username','group') # Conversion: no conversion
Unbound: username: "username" # Conversion: no conversion
network: network:
------------- ^^^^^^^^
resolver: resolver:
------------- ^^^^^^^^^
**stub-zones**:
.. code-block:: python
DataModel: "stub-zones": [
{
"domain": "stub.example.com",
"nameserver": "192.0.2.1",
"port": 53 # Default: 53
}
]
KnotResolver: STUB('192.0.2.1@53') # Conversion: 'nameserver' + port -> nameserver@port'
Unbound: stub-zone:
name: "stub.example.com" # Conversion: no conversion
stub-addr: "192.0.2.1@53" # Conversion: 'nameserver' + port -> nameserver@port'
logging
^^^^^^^
**verbosity**:
.. code-block:: python
DataModel: "verbosity": 0-5 # Default: 1
KnotResolver: verbosity: 0-5 # Conversion: no conversion
Unbound: verbose(true/false) # Conversion: 0 -> false 1-5 -> true
logging:
-------------
dnssec: dnssec:
------------- -------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment