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

Add "get-zone" command (#613)

Browse Source 
* Add GetZoneRecords to DNSProvider interface
* dnscontrol now uses ufave/cli/v2
* NEW: get-zones.md
* HasRecordTypeName should be a method on models.Records not models.DomainConfig
* Implement BIND's GetZoneRecords
* new WriteZoneFile implemented
* go mod vendor
* Update docs to use get-zone instead of convertzone
* Add CanGetZone capability and update all providers.
* Get all zones for a provider at once (#626)
* implement GetZoneRecords for cloudflare
* munge cloudflare ttls
* Implement GetZoneRecords for cloudflare (#625)

Co-authored-by: Craig Peterson <192540+captncraig@users.noreply.github.com>
This commit is contained in:
Tom Limoncelli
2020-02-18 08:59:18 -05:00
committed by GitHub
parent cd680cc738
commit 87ad01d194
49 changed files with 1327 additions and 612 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/migrating.md
View File

@@ -42,34 +42,51 @@ For a small domain you can probably create the `D()` statements by
hand, possibly with your text editor's search and replace functions.
However, where's the fun in that?
The `convertzone` tool can automate 90% of the conversion for you. It
reads a BIND-style zone file or an OctoDNS-style YAML file and outputs a `D()` statement
that is usually fairly complete. You may need to touch it up a bit.
The `dnscontrol get-zones` subcommand
[documented here]({{site.github.url}}/get-zones)
can automate 90% of the conversion for you. It
reads BIND-style zonefiles, or will use a providers API to gather the DNS records. It will then output the records in a variety of formats, including
the as a `D()` statement
that is usually fairly complete. You may need to touch it up a bit,
especially if you use pseudo record types in one provider that are
not supported by another.
The convertzone command is in the `cmd/convertzone` subdirectory.
Build instructions are
[here](https://github.com/StackExchange/dnscontrol/blob/master/cmd/convertzone/README.md).
Example 1: Read a BIND zonefile
If you do not use BIND already, most DNS providers will export your
existing zone data to a file called the BIND zone file format.
Most DNS Service Providers have an 'export to zonefile' feature.
For example, suppose you owned the `foo.com` domain and the zone file
was in a file called `old/zone.foo.com`. This command will convert the file:
```
dnscontrol get-zones -format=dsl bind BIND example.com
dnscontrol get-zones -format=dsl -out=draft.js bind BIND example.com
```
convertzone -out=dsl foo.com <old/zone.foo.com >first-draft.js
This will read the file `zones/example.com.zone`. The system is a bit
inflexible and that must be the filename. You can copy the file to
that name, or use a symlink.
If you are converting an OctoDNS file, add the flag `-in=octodns`:
Add the contents of `draft.js` to `dnsconfig.js` and edit it as needed.
convertzone -in=octodns -out=dsl foo.com <config/foo.com.yaml >first-draft.js
Example 2: Read from a provider
Add the contents of `first-draft.js` to `dnsconfig.js`
This requires creating a `creds.json` file as described in
[Getting Started]({{site.github.url}}/getting-started).
Suppose your `creds.json` file has the name `global_aws`
for the provider `ROUTE53`. Your command would look like this:
```
dnscontrol get-zones -format=dsl global_aws ROUTE53 example.com
dnscontrol get-zones -format=dsl -out=draft.js global_aws ROUTE53 example.com
```
Add the contents of `draft.js` to `dnsconfig.js` and edit it as needed.
Run `dnscontrol preview` and see if it finds any differences.
Edit dnsconfig.js until `dnscontrol preview` shows no errors and
no changes to be made. This means the conversion of your old DNS
data is correct.
convertzone makes a guess at what to do with NS records.
`dnscontrol get-zones` makes a guess at what to do with NS records.
An NS record at the apex is turned into a NAMESERVER() call, the
rest are left as NS(). You probably want to check each of them for
correctness.
@@ -81,7 +98,7 @@ Of course, once `dnscontrol preview` runs cleanly, you can do any
kind of cleanups you want. In fact, they should be easier to do
now that you are using DNSControl!
If convertzone could have done a better job, please
If `dnscontrol get-zones` could have done a better job, please
[let us know](https://github.com/StackExchange/dnscontrol/issues)!
## Example workflow
@@ -91,7 +108,8 @@ to convert a zone. Lines that start with `#` are comments.
# Note this command uses ">>" to append to dnsconfig.js. Do
# not use ">" as that will erase the existing file.
convertzone -out=dsl foo.com <old/zone.foo.com >>dnsconfig.js
dnscontrol get-zones -format=dsl -out=draft.js bind BIND foo.com
cat >>dnsconfig.js draft.js # Append to dnsconfig.js
#
dnscontrol preview
vim dnsconfig.js
@@ -105,4 +123,4 @@ to convert a zone. Lines that start with `#` are comments.
vim dnsconfig.js
dnscontrol preview
# (repeat until all warnings/errors are resolved)
dnscontrol push
dnscontrol push