Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
COREDNS-CLOUDDNS(7)		 CoreDNS Plugins	     COREDNS-CLOUDDNS(7)

NAME
     clouddns - enables serving zone data from GCP Cloud DNS.

DESCRIPTION
     The  clouddns  plugin is useful for serving zones from resource record sets
     in GCP Cloud DNS.	This  plugin  supports	all  Google  Cloud  DNS  records
     <https://cloud.google.com/dns/docs/overview#supported_dns_record_types>.
     This  plugin can be used when CoreDNS is deployed on GCP or elsewhere. Note
     that this plugin accesses the resource records  through  the  Google  Cloud
     API.  For	records in a privately hosted zone, it is not necessary to place
     CoreDNS and this plugin in the 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 from FILENAME (nor-
	 mally a .json file).  This field is optional. If this field is not pro-
	 vided then authentication will be done automatically, e.g., through en-
	 vironmental variable GOOGLE_APPLICATION_CREDENTIALS. Note that  CoreDNS
	 validates  that  the  given file has a valid credentials type, but does
	 not validate the credentials  file  for  malicious  input.  Please  see
	 Google Cloud's authentication method <https://cloud.google.com/docs/au-
	 thentication>	and  validating  credential configurations from external
	 sources   <https://docs.cloud.google.com/docs/authentication/client-li-
	 braries#external-credentials> for more details.

     *	 fallthrough  If  zone	matches and no record can be generated, pass re-
	 quest to the next plugin.  If [ZONES...] is omitted,  then  fallthrough
	 happens  for  all  zones for which the plugin is authoritative. If spe-
	 cific zones are listed (for example in-addr.arpa  and	ip6.arpa),  then
	 only queries for those zones will be subject to fallthrough.

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

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

     Enable clouddns with fallthrough:

	    example.org {
		clouddns example.org.:gcp-example-project:example-zone 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
	    }

CoreDNS 			   March 2026		     COREDNS-CLOUDDNS(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=coredns-clouddns&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help