mirror/github-octodns
1
0
Fork 0
mirror of https://github.com/github/octodns.git synced 2024-05-11 05:55:00 +00:00
Code Issues Releases Activity

Add documentation for include_meta config key

Browse Source 
Update README.md to include documentation for the `include_meta` key in the `manager` section of the config.
This commit is contained in:
William Jackson
2022-05-29 16:22:52 -05:00
committed by GitHub
parent fe116fdbb1
commit a17c4f8e0c
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -68,6 +68,7 @@ We start by creating a config file to tell OctoDNS about our providers and the z
```yaml
---
manager:
include_meta: False
max_workers: 2
providers:
@@ -102,6 +103,8 @@ zones:
Further information can be found in the `docstring` of each source and provider class.
The `include_meta` key in the `manager` section of the config controls the creation of a TXT record at the root of a zone that is managed by OctoDNS. If set to `True`, OctoDNS will create a TXT record for the root of the zone with the value `provider=<target-provider>`. If not specified, the default value for `include_meta` is `False`.
The `max_workers` key in the `manager` section of the config enables threading to parallelize the planning portion of the sync.
In this example, `example.net` is an alias of zone `example.com`, which means they share the same sources and targets. They will therefore have identical records.