From f92e168c174ab5752f9aaa0fe7e77541b71a9004 Mon Sep 17 00:00:00 2001 From: Vlad Voloshyn Date: Sun, 13 Jan 2019 20:30:01 +0200 Subject: [PATCH] Add description about default_ttl and enforce_order keys in config --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index a421301..6f2c195 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ providers: config: class: octodns.provider.yaml.YamlProvider directory: ./config + default_ttl: 3600 + enforce_order: True dyn: class: octodns.provider.dyn.DynProvider customer: 1234 @@ -56,6 +58,10 @@ zones: `class` is a special key that tells OctoDNS what python class should be loaded. Any other keys will be passed as configuration values to that provider. In general any sensitive or frequently rotated values should come from environmental variables. When OctoDNS sees a value that starts with `env/` it will look for that value in the process's environment and pass the result along. +`enforce_order` is a special key that tells OctoDNS to enforce sorting order on the yaml config. By default it is set to True. + +If you don't want to set same TTL each time for your records, you can optionally use `default_ttl` key - it will be used in records when not specified in the data. By default it is set to 3600 seconds. + Further information can be found in the `docstring` of each source and provider class. Now that we have something to tell OctoDNS about our providers & zones we need to tell it about or records. We'll keep it simple for now and just create a single `A` record at the top-level of the domain.