2c418b9fd5
* Fix spelling in coredns.1 and corefile.7 md files * Run make -f Makefile.doc Signed-off-by: Miek Gieben <miek@miek.nl>
125 lines
3.2 KiB
Groff
125 lines
3.2 KiB
Groff
.\" Generated by Mmark Markdown Processer - mmark.nl
|
|
.TH "COREDNS-ROUTE53" 7 "April 2019" "CoreDNS" "CoreDNS Plugins"
|
|
|
|
.SH "NAME"
|
|
.PP
|
|
\fIroute53\fP - enables serving zone data from AWS route53.
|
|
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
The route53 plugin is useful for serving zones from resource record
|
|
sets in AWS route53. This plugin supports all Amazon Route 53 records
|
|
(https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html
|
|
\[la]https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html\[ra]).
|
|
The route53 plugin can be used when coredns is deployed on AWS or elsewhere.
|
|
|
|
.SH "SYNTAX"
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
route53 [ZONE:HOSTED\_ZONE\_ID...] {
|
|
[aws\_access\_key AWS\_ACCESS\_KEY\_ID AWS\_SECRET\_ACCESS\_KEY]
|
|
upstream
|
|
credentials PROFILE [FILENAME]
|
|
fallthrough [ZONES...]
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.IP \(bu 4
|
|
\fBZONE\fP the name of the domain to be accessed. When there are multiple zones with overlapping
|
|
domains (private vs. public hosted zone), CoreDNS does the lookup in the given order here.
|
|
Therefore, for a non-existing resource record, SOA response will be from the rightmost zone.
|
|
.IP \(bu 4
|
|
\fBHOSTED\fIZONE\fPID\fP the ID of the hosted zone that contains the resource record sets to be
|
|
accessed.
|
|
.IP \(bu 4
|
|
\fBAWS\fIACCESS\fPKEY_ID\fP and \fBAWS\fISECRET\fPACCESS_KEY\fP the AWS access key ID and secret access key
|
|
to be used when query AWS (optional). If they are not provided, then coredns tries to access
|
|
AWS credentials the same way as AWS CLI, e.g., environmental variables, AWS credentials file,
|
|
instance profile credentials, etc.
|
|
.IP \(bu 4
|
|
\fB\fCupstream\fRis used for resolving services that point to external hosts (eg. used to resolve
|
|
CNAMEs). CoreDNS will resolve against itself.
|
|
.IP \(bu 4
|
|
\fB\fCcredentials\fR is used for reading the credential file and setting the profile name for a given
|
|
zone.
|
|
.IP \(bu 4
|
|
\fBPROFILE\fP AWS account profile name. Defaults to \fB\fCdefault\fR.
|
|
.IP \(bu 4
|
|
\fBFILENAME\fP AWS credentials filename. Defaults to \fB\fC~/.aws/credentials\fR are used.
|
|
.IP \(bu 4
|
|
\fB\fCfallthrough\fR If zone matches and no record can be generated, pass request to the next plugin.
|
|
If \fB[ZONES...]\fP is omitted, then fallthrough happens for all zones for which the plugin is
|
|
authoritative. If specific zones are listed (for example \fB\fCin-addr.arpa\fR and \fB\fCip6.arpa\fR), then
|
|
only queries for those zones will be subject to fallthrough.
|
|
.IP \(bu 4
|
|
\fBZONES\fP zones it should be authoritative for. If empty, the zones from the configuration block
|
|
|
|
|
|
.SH "EXAMPLES"
|
|
.PP
|
|
Enable route53 with implicit AWS credentials and an upstream:
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
\&. {
|
|
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 {
|
|
upstream
|
|
}
|
|
forward . 10.0.0.1
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.PP
|
|
Enable route53 with explicit AWS credentials:
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
\&. {
|
|
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 {
|
|
aws\_access\_key AWS\_ACCESS\_KEY\_ID AWS\_SECRET\_ACCESS\_KEY
|
|
}
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.PP
|
|
Enable route53 with fallthrough:
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
\&. {
|
|
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 example.gov.:Z654321543245 {
|
|
fallthrough example.gov.
|
|
}
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.PP
|
|
Enable route53 with multiple hosted zones with the same domain:
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
\&. {
|
|
route53 example.org.:Z1Z2Z3Z4DZ5Z6Z7 example.org.:Z93A52145678156
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|