History

Yong Tang b53d822e62 Additional content in clouddns plugin, and format of markdown (#3138 ) This PR adds some content in clouddns plugin to mention about the fact that privately hosted zone does not need to attach to a VPC. Also change PROJECT_NAME to PROJECTT_ID, and reformt the markdown to replace tab with 4 whitespace. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>		2019-08-17 21:46:48 +00:00
..
clouddns.go	Add Google Cloud DNS plugin (#3011 )	2019-08-17 13:59:09 -07:00
clouddns_test.go	Add Google Cloud DNS plugin (#3011 )	2019-08-17 13:59:09 -07:00
gcp.go	Add Google Cloud DNS plugin (#3011 )	2019-08-17 13:59:09 -07:00
log_test.go	Add Google Cloud DNS plugin (#3011 )	2019-08-17 13:59:09 -07:00
README.md	Additional content in clouddns plugin, and format of markdown (#3138 )	2019-08-17 21:46:48 +00:00
setup.go	Add Google Cloud DNS plugin (#3011 )	2019-08-17 13:59:09 -07:00
setup_test.go	Add Google Cloud DNS plugin (#3011 )	2019-08-17 13:59:09 -07:00

README.md

clouddns

Name

clouddns - enables serving zone data from GCP clouddns.

Description

The clouddns plugin is useful for serving zones from resource record sets in GCP clouddns. This plugin supports all Google Cloud DNS records. The clouddns plugin can be used when coredns is deployed on GCP or elsewhere. Note that this plugin access the the resource records through Google Cloud API. For records in a privately hosted zone, it is not necessary to place CoreDNS and this plugin in associated VPC network. In fact the private hosted zone could be created without any associated VPC and this plugin could still access the resource records under the hosted zone.

Syntax

clouddns [ZONE:PROJECT_ID:HOSTED_ZONE_NAME...] {
    credentials [FILENAME]
    fallthrough [ZONES...]
}

ZONE 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.
PROJECT_ID the project ID of the Google Cloud project.
HOSTED_ZONE_NAME the name of the hosted zone that contains the resource record sets to be accessed.
credentials is used for reading the credential file.
FILENAME GCP credentials file path (normally a .json file).
fallthrough If zone matches and no record can be generated, pass request to the next plugin. If [ZONES...] is omitted, then fallthrough happens for all zones for which the plugin is authoritative. If specific zones are listed (for example in-addr.arpa and ip6.arpa), then only queries for those zones will be subject to fallthrough.
ZONES zones it should be authoritative for. If empty, the zones from the configuration block

Examples

Enable clouddns with implicit GCP credentials and resolve CNAMEs via 10.0.0.1:

. {
    clouddns example.org.:gcp-example-project:example-zone
    forward . 10.0.0.1
}

Enable clouddns with fallthrough:

. {
    clouddns example.org.:gcp-example-project:example-zone clouddns example.com.:gcp-example-project:example-zone-2 {
        fallthrough example.gov.
    }
}

Enable clouddns with multiple hosted zones with the same domain:

. {
    clouddns example.org.:gcp-example-project:example-zone example.com.:gcp-example-project:other-example-zone
}