Name: puppet-google-dns
Owner: Google Cloud Platform
Description: null
Created: 2017-06-16 23:19:13.0
Updated: 2018-04-18 08:07:10.0
Pushed: 2018-04-18 08:07:08.0
Homepage: null
Size: 92
Language: Ruby
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This Puppet module manages the resource of Google Cloud DNS. You can manage its resources using standard Puppet DSL and the module will, under the hood, ensure the state described will be reflected in the Google Cloud Platform resources.
To install this module on your Puppet Master (or Puppet Client/Agent), use the Puppet module installer:
puppet module install google-gdns
Optionally you can install support to all Google Cloud Platform products at
once by installing our “bundle” google-cloud
module:
puppet module install google-cloud
All Google Cloud Platform modules use an unified authentication mechanism,
provided by the google-gauth
module. Don't worry, it is automatically
installed when you install this module.
h_credential { 'mycred':
th => $cred_path, # e.g. '/home/nelsonjr/my_account.json'
ovider => serviceaccount,
opes => [
'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
Please refer to the google-gauth
module for further requirements, i.e.
required gems.
gdns_managed_zone
_managed_zone { 'id-for-testzone-3-com':
sure => present,
me => 'testzone-3-com',
s_name => 'test.somewild-example.com.',
scription => 'Test Example Zone',
oject => 'google.com:graphite-playground',
edential => 'mycred',
gdns_project
_project { 'google.com:graphite-playground':
edential => 'mycred',
ota_managed_zones => 10000,
ota_total_rrdata_size_per_change => 100000,
gdns_resource_record_set
_managed_zone { 'some-managed-zone':
sure => present,
me => 'testzone-4-com',
s_name => 'testzone-4.com.',
scription => 'Test Example Zone',
oject => 'google.com:graphite-playground',
edential => 'mycred',
_resource_record_set { 'www.testzone-4.com.':
sure => present,
naged_zone => 'some-managed-zone',
pe => 'A',
l => 600,
rget => [
'10.1.2.3',
'40.5.6.7',
'80.9.10.11'
oject => 'google.com:graphite-playground',
edential => 'mycred',
_resource_record_set { 'sites.testzone-4.com.':
sure => present,
naged_zone => 'some-managed-zone',
pe => 'CNAME',
rget => 'www.testzone-4.com.',
oject => 'google.com:graphite-playground',
edential => 'mycred',
_resource_record_set { 'deleteme.testzone-4.com.':
sure => absent,
naged_zone => 'some-managed-zone',
pe => 'A',
oject => 'google.com:graphite-playground',
edential => 'mycred',
gdns_managed_zone
:
A zone is a subtree of the DNS namespace under one administrative
responsibility. A ManagedZone is a resource that represents a DNS zone
hosted by the Cloud DNS service.gdns_project
:
A project resource. The project is a top level container for resources
including Cloud DNS ManagedZones.gdns_resource_record_set
:
A single DNS record that exists on a domain name (i.e. in a managed
zone).
This record defines the information about the domain and where the
domain / subdomains direct to.
The record will include the domain/subdomain name, a type (i.e. A, AAA,
CAA, MX, CNAME, NS, etc)Some fields are output-only. It means you cannot set them because they are provided by the Google Cloud Platform. Yet they are still useful to ensure the value the API is assigning (or has assigned in the past) is still the value you expect.
For example in a DNS the name servers are assigned by the Google Cloud DNS service. Checking these values once created is useful to make sure your upstream and/or root DNS masters are in sync. Or if you decide to use the object ID, e.g. the VM unique ID, for billing purposes. If the VM gets deleted and recreated it will have a different ID, despite the name being the same. If that detail is important to you you can verify that the ID of the object did not change by asserting it in the manifest.
gdns_managed_zone
A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
_managed_zone { 'id-for-testzone-3-com':
sure => present,
me => 'testzone-3-com',
s_name => 'test.somewild-example.com.',
scription => 'Test Example Zone',
oject => 'google.com:graphite-playground',
edential => 'mycred',
_managed_zone { 'id-of-resource':
eation_time => time,
scription => string,
s_name => string,
=> integer,
me => string,
me_server_set => [
string,
...
me_servers => [
string,
...
oject => string,
edential => reference to gauth_credential,
description
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
dns_name
The DNS name of this managed zone, for instance “example.com.“.
name
Required. User assigned name for this resource. Must be unique within the project.
name_server_set
Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
id
: Output only.
Unique identifier for the resource; defined by the server.
name_servers
: Output only.
Delegate your managed_zone to these virtual name servers;
defined by the server
creation_time
: Output only.
The time that this resource was created on the server.
This is in RFC3339 text format.
gdns_project
A project resource. The project is a top level container for resources including Cloud DNS ManagedZones.
_project { 'google.com:graphite-playground':
edential => 'mycred',
ota_managed_zones => 10000,
ota_total_rrdata_size_per_change => 100000,
_project { 'id-of-resource':
mber => integer,
ota_managed_zones => integer,
ota_resource_records_per_rrset => integer,
ota_rrset_additions_per_change => integer,
ota_rrset_deletions_per_change => integer,
ota_rrsets_per_managed_zone => integer,
ota_total_rrdata_size_per_change => integer,
oject => string,
edential => reference to gauth_credential,
number
: Output only.
Unique numeric identifier for the resource; defined by the server.
quota_managed_zones
: Output only.
Maximum allowed number of managed zones in the project.
quota_resource_records_per_rrset
: Output only.
Maximum allowed number of ResourceRecords per ResourceRecordSet.
quota_rrset_additions_per_change
: Output only.
Maximum allowed number of ResourceRecordSets to add per
ChangesCreateRequest.
quota_rrset_deletions_per_change
: Output only.
Maximum allowed number of ResourceRecordSets to delete per
ChangesCreateRequest.
quota_rrsets_per_managed_zone
: Output only.
Maximum allowed number of ResourceRecordSets per zone in the
project.
quota_total_rrdata_size_per_change
: Output only.
Maximum allowed size for total rrdata in one ChangesCreateRequest
in bytes.
gdns_resource_record_set
A single DNS record that exists on a domain name (i.e. in a managed zone). This record defines the information about the domain and where the domain / subdomains direct to.
The record will include the domain/subdomain name, a type (i.e. A, AAA, CAA, MX, CNAME, NS, etc)
_managed_zone { 'some-managed-zone':
sure => present,
me => 'testzone-4-com',
s_name => 'testzone-4.com.',
scription => 'Test Example Zone',
oject => 'google.com:graphite-playground',
edential => 'mycred',
_resource_record_set { 'www.testzone-4.com.':
sure => present,
naged_zone => 'some-managed-zone',
pe => 'A',
l => 600,
rget => [
'10.1.2.3',
'40.5.6.7',
'80.9.10.11'
oject => 'google.com:graphite-playground',
edential => 'mycred',
_resource_record_set { 'sites.testzone-4.com.':
sure => present,
naged_zone => 'some-managed-zone',
pe => 'CNAME',
rget => 'www.testzone-4.com.',
oject => 'google.com:graphite-playground',
edential => 'mycred',
_resource_record_set { 'deleteme.testzone-4.com.':
sure => absent,
naged_zone => 'some-managed-zone',
pe => 'A',
oject => 'google.com:graphite-playground',
edential => 'mycred',
_resource_record_set { 'id-of-resource':
naged_zone => reference to gdns_managed_zone,
me => string,
rget => [
string,
...
l => integer,
pe => 'A', 'AAAA', 'CAA', 'CNAME', 'MX', 'NAPTR', 'NS', 'PTR', 'SOA', 'SPF', 'SRV' or 'TXT',
oject => string,
edential => reference to gauth_credential,
name
Required. For example, www.example.com.
type
Required. One of valid DNS resource types.
ttl
Number of seconds that this ResourceRecordSet can be cached by resolvers.
target
As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
managed_zone
Required. A reference to ManagedZone resource
This module has been tested on:
Testing on other platforms has been minimal and cannot be guaranteed.
Some files in this package are automatically generated by Magic Modules.
We use a code compiler to produce this module in order to avoid repetitive tasks and improve code quality. This means all Google Cloud Platform Puppet modules use the same underlying authentication, logic, test generation, style checks, etc.
Learn more about the way to change autogenerated files by reading the CONTRIBUTING.md file.
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING.md for more information on how to get started.
This project contains tests for rspec, rspec-puppet and rubocop to verify functionality. For detailed information on using these tools, please see their respective documentation.
install bundler
le install
le exec rspec
le exec rubocop
In case you need to debug tests in this module you can set the following variables to increase verbose output:
Variable | Side Effect
————————|—————————————————
PUPPET_HTTP_VERBOSE=1
| Prints network access information by Puppet provier.
PUPPET_HTTP_DEBUG=1
| Prints the payload of network calls being made.
GOOGLE_HTTP_VERBOSE=1
| Prints debug related to the network calls being made.
GOOGLE_HTTP_DEBUG=1
| Prints the payload of network calls being made.
During test runs (using rspec) you can also set:
Variable | Side Effect
————————|—————————————————
RSPEC_DEBUG=1
| Prints debug related to the tests being run.
RSPEC_HTTP_VERBOSE=1
| Prints network expectations and access.