diff options
| author |  Yong Tang <yong.tang.github@outlook.com>
| 2019-08-17 14:46:48 -0700 |
|---|---|---|
| committer |  Miek Gieben <miek@miek.nl>
| 2019-08-17 21:46:48 +0000 |
| commit | b53d822e62f36c1cdd693b67d172efd1d7c60cdc (patch) | |
| tree | f7a9a8421ba27ff26c749dcf692f11c79443733e /plugin/clouddns | |
| parent | ef7efae761238afeddcef4ea102f4672793b2a61 (diff) | |
| download | coredns-b53d822e62f36c1cdd693b67d172efd1d7c60cdc.tar.gz coredns-b53d822e62f36c1cdd693b67d172efd1d7c60cdc.tar.zst coredns-b53d822e62f36c1cdd693b67d172efd1d7c60cdc.zip | |
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>
Diffstat (limited to 'plugin/clouddns')
| -rw-r--r-- | plugin/clouddns/README.md | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/plugin/clouddns/README.md b/plugin/clouddns/README.md index 4aa5f04fb..94156ea08 100644 --- a/plugin/clouddns/README.md +++ b/plugin/clouddns/README.md @@ -6,14 +6,18 @@ ## Description -The clouddns plugin is useful for serving zones from resource record -sets in GCP clouddns. This plugin supports all [Google Cloud DNS records](https://cloud.google.com/dns/docs/overview#supported_dns_record_types). -The clouddns plugin can be used when coredns is deployed on GCP or elsewhere. +The clouddns plugin is useful for serving zones from resource record sets in GCP clouddns. +This plugin supports all [Google Cloud DNS records](https://cloud.google.com/dns/docs/overview#supported_dns_record_types). +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 ~~~ txt -clouddns [ZONE:PROJECT_NAME:HOSTED_ZONE_NAME...] { +clouddns [ZONE:PROJECT_ID:HOSTED_ZONE_NAME...] { credentials [FILENAME] fallthrough [ZONES...] } @@ -23,12 +27,14 @@ clouddns [ZONE:PROJECT_NAME:HOSTED_ZONE_NAME...] { 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. +* **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 @@ -43,7 +49,7 @@ Enable clouddns with implicit GCP credentials and resolve CNAMEs via 10.0.0.1: ~~~ txt . { - clouddns example.org.:gcp-example-project:example-zone + clouddns example.org.:gcp-example-project:example-zone forward . 10.0.0.1 } ~~~ @@ -53,7 +59,7 @@ Enable clouddns with fallthrough: ~~~ txt . { clouddns example.org.:gcp-example-project:example-zone clouddns example.com.:gcp-example-project:example-zone-2 { - fallthrough example.gov. + fallthrough example.gov. } } ~~~ |