mirror of
https://github.com/github/octodns.git
synced 2024-05-11 05:55:00 +00:00
117 lines
3.3 KiB
Python
117 lines
3.3 KiB
Python
import logging
|
|
import os
|
|
|
|
from ..record import Record
|
|
from .base import BaseSource
|
|
|
|
|
|
class EnvVarSourceException(Exception):
|
|
pass
|
|
|
|
|
|
class EnvironmentVariableNotFoundException(EnvVarSourceException):
|
|
def __init__(self, data):
|
|
super(EnvironmentVariableNotFoundException, self).__init__(
|
|
f'Unknown environment variable {data}'
|
|
)
|
|
|
|
|
|
class EnvVarSource(BaseSource):
|
|
'''
|
|
This source allows for environment variables to be embedded at octodns
|
|
execution time into zones. Intended to capture artifacts of deployment to
|
|
facilitate operational objectives.
|
|
|
|
The TXT record generated will only have a single value.
|
|
|
|
The record name cannot conflict with any other co-existing sources. If
|
|
this occurs, an exception will be thrown.
|
|
|
|
Possible use cases include:
|
|
- Embedding a version number into a TXT record to monitor update
|
|
propagation across authoritative providers.
|
|
- Capturing identifying information about the deployment process to
|
|
record where and when the zone was updated.
|
|
|
|
version:
|
|
class: octodns.source.envvar.EnvVarSource
|
|
# The environment variable in question, in this example the username
|
|
# currently executing octodns
|
|
variable: USER
|
|
# The TXT record name to embed the value found at the above
|
|
# environment variable
|
|
name: deployuser
|
|
# The TTL of the TXT record (optional, default 60)
|
|
ttl: 3600
|
|
|
|
This source is then combined with other sources in the octodns config
|
|
file:
|
|
|
|
zones:
|
|
netflix.com.:
|
|
sources:
|
|
- yaml
|
|
- version
|
|
targets:
|
|
- ultra
|
|
- ns1
|
|
'''
|
|
|
|
SUPPORTS_GEO = False
|
|
SUPPORTS_DYNAMIC = False
|
|
SUPPORTS = set(('TXT'))
|
|
|
|
DEFAULT_TTL = 60
|
|
|
|
def __init__(self, id, variable, name, ttl=DEFAULT_TTL):
|
|
klass = self.__class__.__name__
|
|
self.log = logging.getLogger(f'{klass}[{id}]')
|
|
self.log.debug(
|
|
'__init__: id=%s, variable=%s, name=%s, ttl=%d',
|
|
id,
|
|
variable,
|
|
name,
|
|
ttl,
|
|
)
|
|
super(EnvVarSource, self).__init__(id)
|
|
self.envvar = variable
|
|
self.name = name
|
|
self.ttl = ttl
|
|
|
|
def _read_variable(self):
|
|
value = os.environ.get(self.envvar)
|
|
if value is None:
|
|
raise EnvironmentVariableNotFoundException(self.envvar)
|
|
|
|
self.log.debug(
|
|
'_read_variable: successfully loaded var=%s val=%s',
|
|
self.envvar,
|
|
value,
|
|
)
|
|
return value
|
|
|
|
def populate(self, zone, target=False, lenient=False):
|
|
self.log.debug(
|
|
'populate: name=%s, target=%s, lenient=%s',
|
|
zone.name,
|
|
target,
|
|
lenient,
|
|
)
|
|
|
|
before = len(zone.records)
|
|
|
|
value = self._read_variable()
|
|
|
|
# We don't need to worry about conflicting records here because the
|
|
# manager will deconflict sources on our behalf.
|
|
payload = {'ttl': self.ttl, 'type': 'TXT', 'values': [value]}
|
|
record = Record.new(
|
|
zone, self.name, payload, source=self, lenient=lenient
|
|
)
|
|
zone.add_record(record, lenient=lenient)
|
|
|
|
self.log.info(
|
|
'populate: found %s records, exists=False',
|
|
len(zone.records) - before,
|
|
)
|