Browse Source

Document directory requirements more clearly.

Signed-off-by: Christian Funkhouser <cfunkhouser@heroku.com>
pull/336/head
Christian Funkhouser 7 years ago
parent
commit
a65181b61d
No known key found for this signature in database GPG Key ID: 6894A9878C7FB782
1 changed files with 16 additions and 5 deletions
  1. +16
    -5
      octodns/provider/yaml.py

+ 16
- 5
octodns/provider/yaml.py View File

@ -131,11 +131,22 @@ class SplitYamlProvider(YamlProvider):
Core provider for records configured in multiple YAML files on disk. Core provider for records configured in multiple YAML files on disk.
Behaves mostly similarly to YamlConfig, but interacts with multiple YAML Behaves mostly similarly to YamlConfig, but interacts with multiple YAML
files, instead of a single monolitic one. The files are named RECORD.yaml,
except for any record which cannot be represented easily as a file; these
are stored in the catchall file, which is a YAML file the zone name,
prepended with a '$'. For example, a zone, 'github.com.' would have a
catch-all file named '$github.com.yaml'.
files, instead of a single monolitic one. All files are stored in a
subdirectory matching the name of the zone (including the trailing .) of
the directory config. The files are named RECORD.yaml, except for any
record which cannot be represented easily as a file; these are stored in
the catchall file, which is a YAML file the zone name, prepended with '$'.
For example, a zone, 'github.com.' would have a catch-all file named
'$github.com.yaml'.
A full directory structure for the zone github.com. managed under directory
"zones/" would be:
zones/
github.com./
$github.com.yaml
www.yaml
...
config: config:
class: octodns.provider.yaml.SplitYamlProvider class: octodns.provider.yaml.SplitYamlProvider


Loading…
Cancel
Save