Browse Source

Add section to README about extraction updates

pull/839/head
Ross McFarland 4 years ago
parent
commit
8f1c713a61
No known key found for this signature in database GPG Key ID: 943B179E15D3B22A
1 changed files with 7 additions and 0 deletions
  1. +7
    -0
      README.md

+ 7
- 0
README.md View File

@ -221,6 +221,13 @@ The table below lists the providers octoDNS supports. We're currently in the pro
| [TinyDnsFileSource](/octodns/source/tinydns.py) | | | A, CNAME, MX, NS, PTR | No | read-only | | [TinyDnsFileSource](/octodns/source/tinydns.py) | | | A, CNAME, MX, NS, PTR | No | read-only |
| [YamlProvider](/octodns/provider/yaml.py) | | | All | Yes | config | | [YamlProvider](/octodns/provider/yaml.py) | | | All | Yes | config |
### Updating to use extracted providers
1. Include the extracted module in your python environment, e.g. if using Route53 that would require adding the `octodns_route53` module to your requirements.txt, setup.py, or similar.
1. Update the `class` value for your provider to the new path, e.g. again for Route53 that would be replacing `octodns.provider.route53.Route53Provider` with `octodns_route53.Route53Provider`
The module required and provider class path for extracted providers can be found in the table above.
#### Notes #### Notes
* ALIAS support varies a lot from provider to provider care should be taken to verify that your needs are met in detail. * ALIAS support varies a lot from provider to provider care should be taken to verify that your needs are met in detail.


Loading…
Cancel
Save