mirror of
https://github.com/github/octodns.git
synced 2024-05-11 05:55:00 +00:00
Add proposed google cloud provider.
Proposed google cloud provider for #23
This commit is contained in:
Petter Hassberg
363
octodns/provider/googlecloud.py
Normal file
363
octodns/provider/googlecloud.py
Normal file
@@ -0,0 +1,363 @@
|
||||
#
|
||||
#
|
||||
#
|
||||
|
||||
from __future__ import absolute_import, division, print_function, \
|
||||
unicode_literals
|
||||
|
||||
import re
|
||||
import shlex
|
||||
import time
|
||||
from logging import getLogger
|
||||
|
||||
from google.cloud import dns
|
||||
|
||||
from .base import BaseProvider
|
||||
from ..record import Record
|
||||
|
||||
|
||||
class _GoogleCloudRecordSetMaker(object):
|
||||
"""Wrapper to make google cloud client resource record sets from OctoDNS
|
||||
Records.
|
||||
|
||||
googlecloud.py:
|
||||
class: octodns.provider.googlecloud._GoogleCloudRecordSetMaker
|
||||
An _GoogleCloudRecordSetMaker creates google cloued client resource
|
||||
records which can be used to update the Google Cloud DNS zones.
|
||||
"""
|
||||
|
||||
def __init__(self, gcloud_zone, record):
|
||||
self.gcloud_zone = gcloud_zone
|
||||
self.record = record
|
||||
|
||||
self._record_set_func = getattr(
|
||||
self, '_record_set_from_{}'.format(record._type))
|
||||
|
||||
def get_record_set(self):
|
||||
return self._record_set_func(self.record)
|
||||
|
||||
def _record_set_from_A(self, record):
|
||||
return self.gcloud_zone.resource_record_set(
|
||||
record.fqdn, record._type, record.ttl, record.values)
|
||||
|
||||
_record_set_from_AAAA = _record_set_from_A
|
||||
|
||||
def _record_set_from_CAA(self, record):
|
||||
return self.gcloud_zone.resource_record_set(
|
||||
record.fqdn, record._type, record.ttl, [
|
||||
'{flags} {tag} {value}'.format(**record.data['value'])])
|
||||
|
||||
def _record_set_from_CNAME(self, record):
|
||||
return self.gcloud_zone.resource_record_set(
|
||||
record.fqdn, record._type, record.ttl, [record.value])
|
||||
|
||||
def _record_set_from_MX(self, record):
|
||||
return self.gcloud_zone.resource_record_set(
|
||||
record.fqdn, record._type, record.ttl, [
|
||||
'{preference} {exchange}'.format(**v.data)
|
||||
for v in record.values])
|
||||
|
||||
def _record_set_from_NAPTR(self, record):
|
||||
return self.gcloud_zone.resource_record_set(
|
||||
record.fqdn, record._type, record.ttl, [
|
||||
'{order} {preference} "{flags}" "{service}" '
|
||||
'"{regexp}" {replacement}'
|
||||
.format(**v.data) for v in record.values])
|
||||
|
||||
_record_set_from_NS = _record_set_from_A
|
||||
|
||||
_record_set_from_PTR = _record_set_from_CNAME
|
||||
|
||||
_record_set_from_SPF = _record_set_from_A
|
||||
|
||||
def _record_set_from_SRV(self, record):
|
||||
return self.gcloud_zone.resource_record_set(
|
||||
record.fqdn, record._type, record.ttl, [
|
||||
'{priority} {weight} {port} {target}'
|
||||
.format(**v.data) for v in record.values])
|
||||
|
||||
def _record_set_from_TXT(self, record):
|
||||
if 'values' in record.data:
|
||||
val = record.data['values']
|
||||
else:
|
||||
val = [record.data['value']]
|
||||
|
||||
return self.gcloud_zone.resource_record_set(
|
||||
record.fqdn, record._type, record.ttl, val)
|
||||
|
||||
|
||||
class GoogleCloudProvider(BaseProvider):
|
||||
"""
|
||||
Google Cloud DNS provider
|
||||
|
||||
google_cloud:
|
||||
class: octodns.provider.googlecloud.GoogleCloudProvider
|
||||
# Credentials file for a service_account or other account can be
|
||||
# specified with the GOOGLE_APPLICATION_CREDENTIALS environment
|
||||
# variable. (https://console.cloud.google.com/apis/credentials)
|
||||
#
|
||||
# The project to work on (not required)
|
||||
# project: foobar
|
||||
"""
|
||||
|
||||
SUPPORTS = set(('A', 'AAAA', 'CAA', 'CNAME', 'MX', 'NAPTR',
|
||||
'NS', 'PTR', 'SPF', 'SRV', 'TXT'))
|
||||
SUPPORTS_GEO = False
|
||||
|
||||
def __init__(self, id, project=None, *args, **kwargs):
|
||||
|
||||
# Logger
|
||||
self.log = getLogger('GoogleCloudProvider[{}]'.format(id))
|
||||
self.id = id
|
||||
|
||||
super(GoogleCloudProvider, self).__init__(id, *args, **kwargs)
|
||||
self.gcloud_client = dns.Client(project=project)
|
||||
|
||||
def _apply(self, plan):
|
||||
"""Required function of manager.py to actually apply a record change.
|
||||
|
||||
:param plan: Contains the zones and changes to be made
|
||||
:type plan: octodns.provider.base.Plan
|
||||
|
||||
:type return: void
|
||||
"""
|
||||
desired = plan.desired
|
||||
changes = plan.changes
|
||||
|
||||
self.log.debug('_apply: zone=%s, len(changes)=%d', desired.name,
|
||||
len(changes))
|
||||
|
||||
# Get gcloud zone, or create one if none existed before.
|
||||
gcloud_zone = self._get_gcloud_zone(desired.name, create=True)
|
||||
|
||||
gcloud_changes = gcloud_zone.changes()
|
||||
|
||||
for change in changes:
|
||||
class_name = change.__class__.__name__
|
||||
if class_name in 'Create':
|
||||
gcloud_changes.add_record_set(
|
||||
self._record_to_record_set(gcloud_zone, change.record))
|
||||
elif class_name == 'Delete':
|
||||
gcloud_changes.delete_record_set(
|
||||
self._record_to_record_set(gcloud_zone, change.record))
|
||||
elif class_name == 'Update':
|
||||
gcloud_changes.delete_record_set(
|
||||
self._record_to_record_set(gcloud_zone, change.existing))
|
||||
gcloud_changes.add_record_set(
|
||||
self._record_to_record_set(gcloud_zone, change.new))
|
||||
else:
|
||||
raise RuntimeError('Change type "{}" for change "{!s}" '
|
||||
'is none of "Create", "Delete" or "Update'
|
||||
.format(class_name, change))
|
||||
|
||||
gcloud_changes.create()
|
||||
i = 1
|
||||
while gcloud_changes.status != 'done':
|
||||
self.log.debug("Waiting for changes to complete")
|
||||
time.sleep(i)
|
||||
gcloud_changes.reload()
|
||||
if i < 30:
|
||||
i += 2
|
||||
|
||||
def _create_gcloud_zone(self, dns_name):
|
||||
"""Creates a google cloud ManagedZone with dns_name, and zone named
|
||||
derived from it. calls .create() method and returns it.
|
||||
|
||||
:param dns_name: fqdn of zone to create
|
||||
:type dns_name: str
|
||||
|
||||
:type return: new google.cloud.dns.ManagedZone
|
||||
"""
|
||||
# Zone name must begin with a letter, end with a letter or digit,
|
||||
# and only contain lowercase letters, digits or dashes
|
||||
zone_name = re.sub("[^a-z0-9-]", "",
|
||||
dns_name[:-1].replace('.', "-"))
|
||||
# make sure that the end result did not end up wo leading letter
|
||||
if re.match('[^a-z]', zone_name[0]):
|
||||
# I cannot think of a situation where a zone name derived from
|
||||
# a domain name would'nt start with leading letter and thereby
|
||||
# violate the constraint, however if such a situation is
|
||||
# encountered, add a leading "a" here.
|
||||
zone_name = "a%s" % zone_name
|
||||
|
||||
gcloud_zone = self.gcloud_client.zone(
|
||||
name=zone_name,
|
||||
dns_name=dns_name
|
||||
)
|
||||
gcloud_zone.create(client=self.gcloud_client)
|
||||
|
||||
self.log.info("Created zone %s. Fqdn %s." %
|
||||
(zone_name, dns_name))
|
||||
|
||||
return gcloud_zone
|
||||
|
||||
def _get_gcloud_records(self, gcloud_zone, page_token=None):
|
||||
""" Generator function which yields ResourceRecordSet for the managed
|
||||
gcloud zone, until there are no more records to pull.
|
||||
|
||||
:param gcloud_zone: zone to pull records from
|
||||
:type gcloud_zone: google.cloud.dns.ManagedZone
|
||||
:param page_token: page token for the page to get
|
||||
|
||||
:return: a resource record set
|
||||
:type return: google.cloud.dns.ResourceRecordSet
|
||||
"""
|
||||
gcloud_iterator = gcloud_zone.list_resource_record_sets(
|
||||
page_token=page_token)
|
||||
for gcloud_record in gcloud_iterator:
|
||||
yield gcloud_record
|
||||
# This is to get results which may be on a "paged" page.
|
||||
# (if more than max_results) entries.
|
||||
if gcloud_iterator.next_page_token:
|
||||
for gcloud_record in self._get_gcloud_records(
|
||||
gcloud_zone, gcloud_iterator.next_page_token):
|
||||
# yield from is in python 3 only.
|
||||
yield gcloud_record
|
||||
|
||||
def _get_gcloud_zone(self, dns_name, page_token=None, create=False):
|
||||
"""Return the ManagedZone which has has the matching dns_name, or
|
||||
None if no such zone exist, unless create=True, then create a new
|
||||
one and return it.
|
||||
|
||||
:param dns_name: fqdn of dns name for zone to get.
|
||||
:type dns_name: str
|
||||
:param page_token: page token for the page to get
|
||||
:type page_token: str
|
||||
:param create: if true, create ManagedZone if it does not exist
|
||||
already
|
||||
|
||||
:type return: new google.cloud.dns.ManagedZone
|
||||
"""
|
||||
# Find the google name for the incoming zone
|
||||
gcloud_zones = self.gcloud_client.list_zones(page_token=page_token)
|
||||
for gcloud_zone in gcloud_zones:
|
||||
if gcloud_zone.dns_name == dns_name:
|
||||
return gcloud_zone
|
||||
else:
|
||||
# Zone not found. Check if there are more results which could be
|
||||
# retrieved by checking "next_page_token".
|
||||
if gcloud_zones.next_page_token:
|
||||
return self._get_gcloud_zone(dns_name,
|
||||
gcloud_zones.next_page_token)
|
||||
else:
|
||||
# Nothing found, either return None or else create zone and
|
||||
# return that one (if create=True)
|
||||
self.log.debug('_get_gcloud_zone: zone name=%s, '
|
||||
'was not found by %s.',
|
||||
dns_name, self.gcloud_client)
|
||||
if create:
|
||||
return self._create_gcloud_zone(dns_name)
|
||||
|
||||
@staticmethod
|
||||
def _record_to_record_set(gcloud_zone, record):
|
||||
"""create google.cloud.dns.ResourceRecordSet from ocdodns.Record
|
||||
|
||||
:param record: a record object
|
||||
:type record: ocdodns.Record
|
||||
:param gcloud_zone: a google gcloud zone
|
||||
:type gcloud_zone: google.cloud.dns.ManagedZone
|
||||
:type return: google.cloud.dns.ResourceRecordSet
|
||||
"""
|
||||
grm = _GoogleCloudRecordSetMaker(gcloud_zone, record)
|
||||
|
||||
return grm.get_record_set()
|
||||
|
||||
def populate(self, zone, target=False, lenient=False):
|
||||
"""Required function of manager.py to collect records from zone.
|
||||
|
||||
:param zone: A dns zone
|
||||
:type zone: octodns.zone.Zone
|
||||
:param target: Unused.
|
||||
:type target: bool
|
||||
:param lenient: Unused. Check octodns.manager for usage.
|
||||
:type lenient: bool
|
||||
|
||||
:type return: void
|
||||
"""
|
||||
|
||||
self.log.debug('populate: name=%s, target=%s, lenient=%s', zone.name,
|
||||
target, lenient)
|
||||
before = len(zone.records)
|
||||
|
||||
gcloud_zone = self._get_gcloud_zone(zone.name)
|
||||
|
||||
_records = set()
|
||||
if gcloud_zone:
|
||||
for gcloud_record in self._get_gcloud_records(gcloud_zone):
|
||||
if gcloud_record.record_type.upper() in self.SUPPORTS:
|
||||
_records.add(gcloud_record)
|
||||
for gcloud_record in _records:
|
||||
record_name = gcloud_record.name
|
||||
if record_name.endswith(zone.name):
|
||||
# google cloud always return fqdn. Make relative record
|
||||
# here. "root" records will then get the '' record_name,
|
||||
# which is also the way dyn likes it.
|
||||
record_name = record_name[:-(len(zone.name) + 1)]
|
||||
typ = gcloud_record.record_type.upper()
|
||||
data = getattr(self, '_data_for_{}'.format(typ))
|
||||
data = data(gcloud_record)
|
||||
data['type'] = typ
|
||||
data['ttl'] = gcloud_record.ttl
|
||||
self.log.debug('populate: adding record {} records: {!s}'
|
||||
.format(record_name, data))
|
||||
record = Record.new(zone, record_name, data, source=self)
|
||||
zone.add_record(record)
|
||||
|
||||
self.log.info('populate: found %s records', len(zone.records) - before)
|
||||
|
||||
def _data_for_A(self, gcloud_record):
|
||||
return {
|
||||
'values': gcloud_record.rrdatas
|
||||
}
|
||||
|
||||
_data_for_AAAA = _data_for_A
|
||||
|
||||
def _data_for_CAA(self, gcloud_record):
|
||||
return {
|
||||
'values': [{
|
||||
'flags': v[0],
|
||||
'tag': v[1],
|
||||
'value': v[2]}
|
||||
for v in [shlex.split(g) for g in gcloud_record.rrdatas]]}
|
||||
|
||||
def _data_for_CNAME(self, gcloud_record):
|
||||
return {
|
||||
'value': gcloud_record.rrdatas[0]
|
||||
}
|
||||
|
||||
def _data_for_MX(self, gcloud_record):
|
||||
return {'values': [{
|
||||
"preference": v[0],
|
||||
"exchange": v[1]}
|
||||
for v in [shlex.split(g) for g in gcloud_record.rrdatas]]}
|
||||
|
||||
def _data_for_NAPTR(self, gcloud_record):
|
||||
return {'values': [{
|
||||
'order': v[0],
|
||||
'preference': v[1],
|
||||
'flags': v[2],
|
||||
'service': v[3],
|
||||
'regexp': v[4],
|
||||
'replacement': v[5]}
|
||||
for v in [shlex.split(g) for g in gcloud_record.rrdatas]]}
|
||||
|
||||
_data_for_NS = _data_for_A
|
||||
|
||||
_data_for_PTR = _data_for_CNAME
|
||||
|
||||
_data_for_SPF = _data_for_A
|
||||
|
||||
def _data_for_SRV(self, gcloud_record):
|
||||
return {'values': [{
|
||||
'priority': v[0],
|
||||
'weight': v[1],
|
||||
'port': v[2],
|
||||
'target': v[3]}
|
||||
for v in [shlex.split(g) for g in gcloud_record.rrdatas]]}
|
||||
|
||||
def _data_for_TXT(self, gcloud_record):
|
||||
if len(gcloud_record.rrdatas) > 1:
|
||||
return {
|
||||
'values': gcloud_record.rrdatas}
|
||||
return {
|
||||
'value': gcloud_record.rrdatas[0]}
|
||||
Reference in New Issue
Block a user