dynamic-cloud-dns-client's Introduction

Dynamic Cloud DNS Client

This is a simple client for the Dynamic Cloud DNS project.

Designed to run under Linux systemd, it consists of a small Python script, which uses the ipify API to retrieve the current IP and if the IP address has changed, calls the cloud function configured as per the instructions for Dynamic Cloud DNS.

Prerequisites

Needs Python 3, requests and backoff

pip3 install -r requirements.txt

Setup

Copy dynamic_cloud_dns_client.py to /usr/local/bin
Copy [email protected] to /etc/systemd/system
Copy dynamic_cloud_dns_client_your.host to /etc (replace your.host with your actual hostname)
Edit dynamic_cloud_dns_client_your.host and fill in the environment variables
Enable and start your service: systemctl enable [email protected]

Run sudo ./install.sh your.host to do the first 3 steps. Run just sudo ./install.sh to do the first two steps.

Testing

Probably a good idea to do this in a virtualenv:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -t test-requirements.txt
pytest

License

DCDNS Client is licensed under the MIT License.

See LICENSE for more details.

dynamic-cloud-dns-client's People

Contributors

Stargazers

Watchers

dynamic-cloud-dns-client's Issues

config file - better explanation of variables

# the Cloud DNS zone to update
DCDNS_ZONE=**_MYHOST_**

https://console.cloud.google.com/net-services/dns/zones/**_MYHOST_**/details?project=myexampleproject

is it a proper mapping?

the DNS hostname to update, e.g. your.host.com

DCDNS_HOST=dynamichost.domain.com

https://console.cloud.google.com/net-services/dns/zones/**_MYHOST_**/rrsets/your.host.com./A/view?project=myexampleproject

is it a proper mapping?

the URL of your deployed cloud function

DCDNS_FUNCTION_URL=https://us-central1-myexampleproject .cloudfunctions.net/updateHost
cant figure out where to find "us-central1" i have got
https://console.cloud.google.com/compute/instances?project=myexampleproject => Zone = "northamerica-northeast2-a" is it the same ?

check format of IP addresses before submitting

It could be possible that for some reason the ipify API returns some incorrect data, like returning an IPv4 address from https://api6.ipify.org

We should check the format of the value returned, and ignore if it isn't correct.

client sometimes gets stuck

logs entries like

DEBUG    urllib3.connectionpool    Starting new HTTPS connection (1): api.ipify.org

then nothing

Typo in install.sh echoed instructions

In install.sh the line:

echo "Edit /etc/dynamic_cloud_dns_client_$1 and then run systemctl enable dynamic_cloud_dns_client@$1.service"

should have dashes rather than underscores for "dynamic-cloud-dns-client@$1.service".

Otherwise when someone copies and pastes the message to enable the service they naturally get an error.

Request to ipify should have retry logic

If the request to ipify fails for any reason, it raises an error, which causes the main loop to exit, and systemd is responsible for restarting it.

It would be much better if there was at least an attempt to retry the request before failing.

Recommend Projects

crazystick / dynamic-cloud-dns-client Goto Github PK