quarked-ddns

Provides Free (if you have your domain registered with AWS Route53) Dynamic DNS solution.

Integrates with Google WiFi Router API and/or uses public services.

If Google WiFi integration is disabled quarked-ddns will use public services endpoints from the list below in order to get and verify your public IP:

http://checkip.amazonaws.com
https://api.ipify.org
https://api.myip.com
https://icanhazip.com
http://checkip.dyndns.org
http://trackip.net
http://ip-api.com

In order to protect your environment at least two public services responses are used to identify and confirm the IP change by your ISP. For more info about the workflow involving public endpoints/services read this wiki page.

This list is exposed by the service configuration (ConfigMap in K8's deployments), so it's pretty easy to modify/adjust. It is also very cheap to deploy your own 'what is my IP' service and use it as an endpoint for the quarked-ddns.

If you own or aware of any other mainstream router that provides the REST API or some reliable public IP service - let us know.

Prerequisites

1. Domain managed by the Amazon Route53
2. AWS_ACCESS_KEY_ID and AWS_SECRET_KEY for IAM that can manage your domain (read below how to get it)

Resources

quarked-ddns runs on Quarkus, i.e. the resource consumption is minimal (~11MiB of RAM & ~2mCPU):

it takes ~36ms to boot

Target Platforms

quarked-ddns service supports following deployments:

• Native linux binary
• Java process
• Docker container
• Kubernetes cluster (Helm Chart available)
• Kubernetes/Rancher Application

Configuration

1. Use Amazon IAM to add/update user for programmatic access with permissions to list and manage your hosted zone. It can look like this:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "route53:GetHostedZone",
        "route53:GetHostedZoneCount",
        "route53:ListHostedZonesByName",
        "route53:ListResourceRecordSets",
        "route53:ChangeResourceRecordSets"
      ],
      "Resource": [
        "arn:aws:route53:::hostedzone/<HOSTEDZONEID>"
      ]
    }
  ]
}

2. Get your domain ZoneId from AWS Route53 service
3. If you use Google WiFi Router - verify you got the response by hitting http://192.168.86.1/api/v1/status

How to run

Linux Binary

Grab the quarked-ddns-linux binary from the recent release, and create .env file in the working directory with the following content:

route53.domain=<your-domain>
route53.region=<your-iam-user-region>
route53.hostedZoneId=<your-hosted-zone-id>

You can set your AWS key and secret as env variables for the process:

$export AWS_ACCESS_KEY_ID=<your-key-id>
$export AWS_SECRET_KEY=<your-secret-key>
$./gwifi-ddns-linux

Or provide them as cmd line parameters:

$./gwifi-ddns-linux -Daws.accessKeyId=<your-key-id> -Daws.secretKey=your-secret-key

With no extra cmd line parameters the service will use the defaults specified below:

logLevel=INFO
qddns.ipCheckInterval=5m
qddns.routerIP=192.168.86.1

If you want to disable Google WiFi Router API integration (if you don't have one) and want 10m check interval:

$./gwifi-ddns-linux -Dqddns.routerIP=none -Dqddns.ipCheckInterval=10m

Java Process

Java 11+ is required, verify your environment (and update if needed):

$java -version

Running and configuring Java process is not different from running native Linux executable. Grab the quarkus-app.tar.gz binary from the recent release, unpack it and create .env file in your working directory (see above):

$java -jar quarkus-app/quarkus-run.jar

To provide config properties the same env variables can be used or cmd line parameters:

$java -DlogLevel=DEBUG -jar quarkus-app/quarkus-run.jar

Docker Container

Docker image auto created from the source available on DockerHub

$docker pull zeppelinux/quarked-ddns:tag

Note, there are two docker images available vX.X-linux and vX.X-jvm. Linux one uses Linux executable while JVM one runs Java.

Then you have to set up all the required env variables, read here about how to do it.

Helm Chart

Helm/Kubernetes deployments require quarked-ddns Secret with AWS_ACCESS_KEY_ID and AWS_SECRET_KEY keys/values available in the same namespace where the app is installed.

helm repo add zeppelinux https://charts.diligesoft.com
helm show values zeppelinux/quarked-ddns

Following values have to be customized, normally in your own values.yaml file:

route53:
  hostedZoneId: <YOUR-HOSTED-ZONE-ID>
  domain: <your-domain>
  region: <IAM USER REGION>

helm install -f values.yaml quarked-ddns zeppelinux/quarked-ddns - installs the service in the default namespace

Rancher

Add Helm Charts Catalogue to the Rancher catalogs and enjoy Rancher Apps UI to run it

How To compile and run locally

This project uses Quarkus, the Supersonic Subatomic Java Framework, so all the goodies of Quarkus are available out of the box

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/.