mirror of
https://github.com/coredns/coredns.git
synced 2026-01-23 08:52:54 -05:00
Doc update (#2792)
* Fix spelling in coredns.1 and corefile.7 md files * Run make -f Makefile.doc Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
@@ -1,11 +1,11 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-ETCD" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-ETCD" 7 "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH NAME
|
||||
.SH "NAME"
|
||||
.PP
|
||||
\fIetcd\fP - enables reading zone data from an etcd version 3 instance.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
The data in etcd instance has to be encoded as
|
||||
a message
|
||||
@@ -17,7 +17,7 @@ like SkyDNS
|
||||
The etcd plugin makes extensive use of the forward plugin to forward and query other servers in the
|
||||
network.
|
||||
|
||||
.SH SYNTAX
|
||||
.SH "SYNTAX"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -48,7 +48,7 @@ etcd [ZONES...] {
|
||||
path PATH
|
||||
endpoint ENDPOINT...
|
||||
credentials USERNAME PASSWORD
|
||||
upstream [ADDRESS...]
|
||||
upstream
|
||||
tls CERT KEY CACERT
|
||||
}
|
||||
|
||||
@@ -70,9 +70,7 @@ queries for those zones will be subject to fallthrough.
|
||||
.IP \(bu 4
|
||||
\fB\fCupstream\fR upstream resolvers to be used resolve external names found in etcd (think CNAMEs)
|
||||
pointing to external names. If you want CoreDNS to act as a proxy for clients, you'll need to add
|
||||
the \fIforward\fP plugin. If no \fBADDRESS\fP is given, CoreDNS will resolve CNAMEs against itself.
|
||||
\fBADDRESS\fP can be an IP address, and IP:port or a string pointing to a file that is structured
|
||||
as /etc/resolv.conf.
|
||||
the \fIforward\fP plugin.
|
||||
.IP \(bu 4
|
||||
\fB\fCtls\fR followed by:
|
||||
|
||||
@@ -91,7 +89,7 @@ is needed.
|
||||
.RE
|
||||
|
||||
|
||||
.SH SPECIAL BEHAVIOUR
|
||||
.SH "SPECIAL BEHAVIOUR"
|
||||
.PP
|
||||
CoreDNS etcd plugin leverages directory structure to look for related entries. For example an entry \fB\fC/skydns/test/skydns/mx\fR would have entries like \fB\fC/skydns/test/skydns/mx/a\fR, \fB\fC/skydns/test/skydns/mx/b\fR and so on. Similarly a directory \fB\fC/skydns/test/skydns/mx1\fR will have all \fB\fCmx1\fR entries.
|
||||
|
||||
@@ -102,7 +100,7 @@ With etcd3, support for hierarchical keys are dropped
|
||||
.PP
|
||||
This causes two lookups from CoreDNS to etcdv3 in certain cases.
|
||||
|
||||
.SH MIGRATION TO \fB\fCetcdv3\fR API
|
||||
.SH "MIGRATION TO "\fB\fCetcdv3\fR" API"
|
||||
.PP
|
||||
With CoreDNS release \fB\fC1.2.0\fR, you'll need to migrate existing CoreDNS related data (if any) on your etcd server to etcdv3 API. This is because with \fB\fCetcdv3\fR support, CoreDNS can't see the data stored to an etcd server using \fB\fCetcdv2\fR API.
|
||||
|
||||
@@ -110,7 +108,7 @@ With CoreDNS release \fB\fC1.2.0\fR, you'll need to migrate existing CoreDNS rel
|
||||
Refer this blog by CoreOS team
|
||||
\[la]https://coreos.com/blog/migrating-applications-etcd-v3.html\[ra] to migrate to etcdv3 API.
|
||||
|
||||
.SH EXAMPLES
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
This is the default SkyDNS setup, with everything specified in full:
|
||||
|
||||
@@ -175,7 +173,7 @@ Before getting started with these examples, please setup \fB\fCetcdctl\fR (with
|
||||
If you prefer, you can use \fB\fCcurl\fR to populate the \fB\fCetcd\fR server, but with \fB\fCcurl\fR the endpoint URL depends on the version of \fB\fCetcd\fR. For instance, \fB\fCetcd v3.2\fR or before uses only [CLIENT-URL]/v3alpha/* while \fB\fCetcd v3.5\fR or later uses [CLIENT-URL]/v3/* . Also, Key and Value must be base64 encoded in the JSON payload. With \fB\fCetcdctl\fR these details are automatically taken care off. You can check this document
|
||||
\[la]https://github.com/coreos/etcd/blob/master/Documentation/dev-guide/api_grpc_gateway.md#notes\[ra] for details.
|
||||
|
||||
.SS REVERSE ZONES
|
||||
.SS "REVERSE ZONES"
|
||||
.PP
|
||||
Reverse zones are supported. You need to make CoreDNS aware of the fact that you are also
|
||||
authoritative for the reverse. For instance if you want to add the reverse for 10.0.0.0/24, you'll
|
||||
@@ -217,7 +215,7 @@ reverse.skydns.local.
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SS ZONE NAME AS A RECORD
|
||||
.SS "ZONE NAME AS A RECORD"
|
||||
.PP
|
||||
The zone name itself can be used as A record. This behavior can be achieved by writing special entries to the ETCD path of your zone. If your zone is named \fB\fCskydns.local\fR for example, you can create an \fB\fCA\fR record for this zone as follows:
|
||||
|
||||
@@ -270,7 +268,7 @@ If you query the zone name now, you will get the following response:
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SS ZONE NAME AS AAAA RECORD
|
||||
.SS "ZONE NAME AS AAAA RECORD"
|
||||
.PP
|
||||
If you would like to use \fB\fCAAAA\fR records for the zone name too, you can set the following:
|
||||
|
||||
@@ -298,7 +296,7 @@ If you query the zone name for \fB\fCAAAA\fR now, you will get the following res
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SS SRV RECORD
|
||||
.SS "SRV RECORD"
|
||||
.PP
|
||||
If you would like to use \fB\fCSRV\fR records, you can set the following:
|
||||
|
||||
@@ -327,7 +325,7 @@ If you query the zone name for \fB\fCSRV\fR now, you will get the following resp
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SS TXT RECORD
|
||||
.SS "TXT RECORD"
|
||||
.PP
|
||||
If you would like to use \fB\fCTXT\fR records, you can set the following:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user