Files
designate/designate/backend/agent_backend/impl_denominator.py
T
Erik Olof Gunnar Andersson 097ffec548 Finalized centralization of configuration
This patch removes get_cfg_opts from the plugin class,
and moves all configuration directly into designate.conf.

There are no changes in the generated configuration due
to this patch.

Finally, this complets the blueprint to centralize all
configuration, and is a follow up to this patch
I3be68bf294157631a9bac128df0841220020de96

blueprint centralize-config-designate

Change-Id: I007fc004fc533950c5eda3974f41f05c6db5b43f
2019-06-18 18:41:10 +00:00

234 lines
8.3 KiB
Python

# Copyright 2015 Dyn Inc.
#
# Author: Yasha Bubnov <ybubnov@dyn.com>
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import itertools
import dns.rdata
import dns.rdatatype
import dns.rdataclass
import six
from oslo_config import cfg
from oslo_concurrency import lockutils
from oslo_log import log as logging
from designate.backend.agent_backend import base
from designate import exceptions
from designate import utils
CFG_GROUP_NAME = 'backend:agent:denominator'
LOG = logging.getLogger(__name__)
class Denominator(object):
def __init__(self, config):
super(Denominator, self).__init__()
self.config = config
def update_record(self, zone, **kwargs):
return self._execute(['record', '-z', zone, 'replace'], kwargs)
def create_record(self, zone, **kwargs):
return self._execute(['record', '-z', zone, 'add'], kwargs)
def delete_record(self, zone, **kwargs):
return self._execute(['record', '-z', zone, 'delete'], kwargs)
def get_record(self, zone, **kwargs):
return self._execute(['record', '-z', zone, 'get'], kwargs)
def get_records(self, zone, **kwargs):
return self._execute(['record', '-z', zone, 'list'], kwargs)
def create_zone(self, **kwargs):
return self._execute(['zone', 'add'], kwargs)
def update_zone(self, **kwargs):
return self._execute(['zone', 'update'], kwargs)
def delete_zone(self, **kwargs):
return self._execute(['zone', 'delete'], kwargs)
def _params(self, **kwargs):
params = [('--%s' % k, str(v)) for k, v in kwargs.items()]
return list(itertools.chain(*params))
def _base(self):
call = ['denominator', '-q', '-n', self.config.name]
# NOTE: When path to denominator configuration file is omitted,
# ~/.denominatorconfig file will be used by default.
if self.config.config_file:
call.extend(['-C', self.config.config_file])
return call
def _execute(self, op, kwargs):
try:
call = self._base() + op + self._params(**kwargs)
LOG.debug(('Executing Denominator call: %s' % ' '.join(call)))
stdout, _ = utils.execute(*call)
return stdout
except utils.processutils.ProcessExecutionError as e:
LOG.debug('Denominator call failure: %s' % e)
raise exceptions.DesignateException(e)
class DenominatorBackend(base.AgentBackend):
__plugin_name__ = 'denominator'
__backend_status__ = 'untested'
def __init__(self, agent_service):
super(DenominatorBackend, self).__init__(agent_service)
self.denominator = Denominator(
cfg.CONF[CFG_GROUP_NAME])
def start(self):
LOG.info("Started Denominator backend")
def stop(self):
LOG.info("Stopped Denominator backend")
def find_zone_serial(self, zone_name):
LOG.debug("Finding %s", zone_name)
zone_name = zone_name.rstrip('.')
output = self.denominator.get_record(
zone=zone_name,
type='SOA',
name=zone_name)
try:
text = ' '.join(output.split()[3:])
rdata = dns.rdata.from_text(dns.rdataclass.IN,
dns.rdatatype.SOA,
text)
except Exception:
return None
return rdata.serial
def create_zone(self, zone):
LOG.debug("Creating %s", zone.origin.to_text())
zone_name = zone.origin.to_text(omit_final_dot=True)
if six.PY3 and isinstance(zone_name, bytes):
zone_name = zone_name.decode('utf-8')
# Use SOA TTL as zone default TTL
soa_record = zone.find_rrset(zone.origin, dns.rdatatype.SOA)
rname = soa_record.items[0].rname.derelativize(origin=zone.origin)
# Lock zone to prevent concurrent changes.
with self._sync_zone(zone.origin):
# NOTE: If zone already exists, denominator will update it with
# new values, in other a duplicate zone will be created if
# provider supports such functionality.
self.denominator.create_zone(
name=zone_name,
ttl=soa_record.ttl,
email=rname)
# Add records one by one.
for name, ttl, rtype, data in self._iterate_records(zone):
# Some providers do not support creation of SOA record.
rdatatype = dns.rdatatype.from_text(rtype)
if rdatatype == dns.rdatatype.SOA:
continue
self.denominator.create_record(
zone=zone_name,
name=name,
type=rtype,
ttl=ttl,
data=data)
def update_zone(self, zone):
LOG.debug("Updating %s", zone.origin)
zone_name = zone.origin.to_text(omit_final_dot=True)
if six.PY3 and isinstance(zone_name, bytes):
zone_name = zone_name.decode('utf-8')
soa_record = zone.find_rrset(zone.origin, dns.rdatatype.SOA)
rname = soa_record.items[0].rname.derelativize(origin=zone.origin)
with self._sync_zone(zone.origin):
# Update zone with a new parameters
self.denominator.update_zone(
id=zone_name,
ttl=soa_record.ttl,
email=rname)
# Fetch records to create a differential update of a zone.
output = self.denominator.get_records(zone_name)
subzones = dict()
# subzones dict will contain names of subzones without
# trailing dot.
for raw in output.splitlines():
data = raw.split()
name, rtype = data[0], data[1]
rtypes = subzones.get(name, set())
rtypes.add(rtype)
subzones[name] = rtypes
for name, ttl, rtype, data in self._iterate_records(zone):
record_action = self.denominator.create_record
if name in subzones and rtype in subzones[name]:
# When RR set already exists, replace it with a new one.
rdatatype = dns.rdatatype.from_text(rtype)
record_action = self.denominator.update_record
# So next call will ADD a new record to record set
# instead of replacing of the existing one.
subzones[name].remove(rtype)
# NOTE: DynECT does not support deleting of the SOA
# record. Skip updating of the SOA record.
if rdatatype == dns.rdatatype.SOA:
continue
record_action(zone=zone_name,
name=name,
type=rtype,
ttl=ttl,
data=data)
# Remaining records should be deleted
for name, types in subzones.items():
for rtype in types:
self.denominator.delete_record(
zone=zone_name, id=name, type=rtype)
def delete_zone(self, zone_name):
LOG.debug('Delete Zone: %s' % zone_name)
with self._sync_zone(zone_name):
self.denominator.delete_zone(id=zone_name)
def _sync_zone(self, zone_name):
LOG.debug('Synchronising zone: %s' % zone_name)
return lockutils.lock('denominator-%s' % zone_name)
def _iterate_records(self, zone):
for rname, ttl, rdata in zone.iterate_rdatas():
name = rname.derelativize(origin=zone.origin)
name = name.to_text(omit_final_dot=True)
if six.PY3 and isinstance(name, bytes):
name = name.decode('utf-8')
data = rdata.to_text(origin=zone.origin, relativize=False)
yield name, ttl, dns.rdatatype.to_text(rdata.rdtype), data