Skip to content

Commit

Permalink
Merge pull request #13258 from omoerbeek/rec-yaml-conv-docs
Browse files Browse the repository at this point in the history
rec: Clarify file name and placement rules for converted old-style files
  • Loading branch information
omoerbeek authored Sep 18, 2023
2 parents 63ef6c0 + 98014b1 commit 1b2d321
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions pdns/recursordist/docs/appendices/yamlconversion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,10 @@ Consult :doc:`../yamlsettings` for details on how settings spread over multiple

The contents of the report can be used to produce YAML settings equivalent to the old-style settings.
This is a manual step and consists of copy-pasting the sections of the conversion report to individual files.
Any settings filename in the include directory should end with ``.yml``.
It is possible to put associated files (like a ``recursor.forward_zones_file``) into the include dir, but do *not* let these files end in ``.yml``, as ``.yml`` files will be interpreted as full configuration files, while the associated settings files are YAML sequences of a specific type.

Any converted settings filename in the **include** directory should end with ``.yml``.
The names of associated files (like a ``recursor.forward_zones_file``) should also end in ``.yml``, but should *not* be put into the **include** directory, as they do not contain full configuration YAML clauses but YAML sequences of a specific type.
The associated files *can* be put in the **config** directory, the directory that is searched for a ``recursor.conf`` or ``recursor.yml`` file.

API Managed Files
-----------------
Expand Down

0 comments on commit 1b2d321

Please sign in to comment.