gautada / dyndns-container

Determines the external IP address and updates a dns server

dynip

Adstract

DynIP is a dynamic ip tool that determines the external IP address and updates a dns servics. This container serves a microservice as an API for other services.

Features

• Microservice - API server.
• Plugin Architecture - A simple mechanism to support multiple dns providers
• Hover Plugin - Access client for the Hover API
• Client - A cli client for use with crond to invoke the lookup/update

Feature Detail

Microservice

• /ip Lookup the external IP. Returns previous and current ip, as well as the last timestamp inside a status envelope.
• /record Update the IP for an fqdn. This method takes plugin, name(host), and domain to form the fqdn for a specific service. There are two method get retrieve the dns record; the post updates the dns record with an additional param for ip.
• /field Update the content for TXT record. This is the same parameters as /host.

Plugin Architecture

This provides a mechanism for connecting to DNS providers in a standard way. The interface is defined in the dyndns_plugin.py file.

Providers

• Hover: Uses the api provided by hover. It is fairly simple and I will let the code speak for itself.

Client

The client.py provides a simple script to use the API. This should be referenced for any other clients using the API. For consistency the client uses the same config file /etc/container/dyndns.yml.

Development

Configuration

To configure the service a config file /etc/container/dyndns.yml must be provided. Below is an example only the hover plugin is working.

plugins:
  - name: hover
    username: {USERNAME}
    password: {PASSWORD}
    domains:
      {DOMAIN}.{TLD}:
      - {HOST1}
      - {HOST2}
      - {HOST3}
  - name: route53
    user: example
    password: actualpwd
    domains:
      foobar.org
      - xyz
      - abc

Architecture

Context

Container

Component

Administration

Issues

The official to list is kept in a GitHub Issue List

Notes

• Updated to the latest spec Issue #4

dyndns-container's Issues

Need to add the centralized logging capability to watch the logs from the client apps

Refactor the API to use record instead of host and field.

Package and release to pypi

API for checking that the app has the correct ip

Create an internal IP checker for the public IP. This would be used in the status checker.

Move the hover class to pypi

Create an API for other services to check/get external IP

Add environment variables to default args.

Break apart the pieces of this container

Need to breakup the manager, my-ip, and update functions and put all of this in personal pypi.

Checklist update

• README conforms to the gist
• .gitignore conforms to the gist
• Confirm the drone.yml file
• Volume folders are present (development-volume & backup-volume)
• docker-compose(.yml) works
• Manifest folder present (and origin to private repository is correct
• Issue List is linked to proper URI
• Signoff ({date and signature of last check})
• Confirm backup (maybe add to testing layer)
• Confirm healthcheck (maybe add to testing layer)
• Regenerate all architecture images
• Decouple alpine upstream image in Containerfile, docker-compose.yml, and drone.yml