2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-01 14:35:29 +00:00

[#198,!160] Further corrections in the JSON section of Kea UG.

- Remove explicit statements about which server supports which feature
- Clarify planned Logging config changes.
This commit is contained in:
Marcin Siodelski
2018-12-11 11:07:16 +01:00
parent e00f53a3fb
commit 6bc00bbe9d

View File

@@ -47,53 +47,51 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<simpara>shell comments: any text after the hash (#) <simpara>shell comments: any text after the hash (#)
character is ignored. Both Dhcp4 and Dhcp6 allow # in any column, character is ignored.</simpara>
while Ddns requires hash to be in the first column.</simpara>
</listitem> </listitem>
<listitem> <listitem>
<simpara>C comments: any text after the double slashes (//) <simpara>C comments: any text after the double slashes (//)
character is ignored. Both Dhcp4 and Dhcp6 supports this character is ignored.</simpara>
feature.</simpara>
</listitem> </listitem>
<listitem> <listitem>
<simpara>Multiline comments: any text between /* and */ is <simpara>Multiline comments: any text between /* and */ is
ignored. This commenting can span multiple lines. Both Dhcp4 and ignored. This commenting can span multiple lines.</simpara>
Dhcp6 supports this feature.</simpara>
</listitem> </listitem>
<listitem> <listitem>
<simpara>File inclusion: JSON files can include other JSON <simpara>File inclusion: JSON files can include other JSON
files. This can be done by using &lt;?include files. This can be done by using &lt;?include
"file.json"?&gt;. This feature is supported by all Kea "file.json"?&gt;.</simpara>
modules.</simpara>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para>The configuration file consists of a single object (often <para>The configuration file consists of a single object (often
colloquially called a map) started with a curly bracket. It colloquially called a map) started with a curly bracket. It
comprises the "Dhcp4", "Dhcp6", "DhcpDdns", "Control-agent", comprises one of the "Dhcp4", "Dhcp6", "DhcpDdns", "Control-agent",
"Netconf" and/or "Logging" objects. It is possible to define "Netconf" object and the "Logging" object. It is possible to define
additional elements, but they will be ignored and rejected in the additional elements, but they will be ignored and rejected in the
future releases of Kea. For example, it is possible to define Dhcp4, future releases of Kea. It is also possible to include several
Dhcp6 and Logging elements in a single configuration file that supported objects in a single configuration file. For example,
can be used to start both the DHCPv4 and DHCPv6 components. it is possible to include "Dhcp4", "Dhcp6" and "Logging" in a
Combining configurations of multiple modules within a single file single configuration file which can be used to start both the
can be confusing and works badly with the commands that fetch and DHCPv4 and DHCPv6 servers. Combining configurations of multiple
write new configuration. Therefore, support for it will be removed Kea modules within a single file can be confusing and works badly
in the future releases of Kea. with the commands that fetch and write new configuration. Therefore,
support for it will be removed in the future releases of Kea.
</para> </para>
<note> <note>
<para> <para>
The "Logging" object will be moved inside the configuration The "loggers" object will be moved inside the configuration
objects (maps) for respective Kea modules in Kea 1.6.0 release. objects (maps) for respective Kea modules in the Kea 1.6.0 release.
For example: the "Dhcp4" map will contain the "Logging" object For example: the "Dhcp4" map will contain the "loggers" object
specifying logging configuration for the DHCPv4 server. Backward specifying logging configuration for the DHCPv4 server. Backward
compatibility will be maintained until at least Kea 1.7.0 release. compatibility will be maintained until at least Kea 1.7.0 release.
It will be possible to specify "Logging" configuration at both It will be possible to specify "Logging" object (comprising
top level and module configuration level. Ultimately, it "loggers") at the top configuration level and "loggers"
will only be allowed to specify logging configuration at the object at module configuration level. Ultimately, it
module configuration level. will only be allowed to specify "loggers" at the module
configuration level and "Logging" object will be removed.
</para> </para>
</note> </note>