Refactor DDNS updater code

.github/dependabot.yml

@@ -13,6 +13,9 @@ updates:
     schedule:
       interval: "weekly"
     groups:
+      pydantic-deps:
+        patterns:
+          - "pydantic*"
       pip-deps:
         patterns:
           - "*"

default.env

@@ -56,38 +56,59 @@ CONTRIBUTOOR_USERNAME=
 CONTRIBUTOOR_PASSWORD=
 
 # Secure web proxy - advanced use, please see instructions
-DOMAIN=example.com
+# Email to be used with Let's Encrypt certificates
 ACME_EMAIL=user@example.com
+# Cloudflare tokens and zone id, if using traefik-cf.yml
 CF_DNS_API_TOKEN=SECRETTOKEN
 CF_ZONE_API_TOKEN=
 CF_ZONE_ID=
+# AWS profile (optional) or access keys, zone id, and region, if using traefik-aws.yml
 AWS_PROFILE=
-AWS_HOSTED_ZONE_ID=
 AWS_ACCESS_KEY_ID=
 AWS_SECRET_ACCESS_KEY=
-CNAME_LIST=
+AWS_HOSTED_ZONE_ID=
 AWS_REGION=us-east-2
+# TTL for all created records
 TTL=300
 
+# The domain that all records are under, has to match the zone id of the provider
+DOMAIN=example.com
+# The host record that is updated with the external IP address of this host, A and AAAA records
+DDNS_HOST=node
+# Comma-separated list of CNAME records to create, pointing at "DDNS_HOST.DOMAIN"
+# All entries will have the DOMAIN appended, e.g. grafana creates a CNAME entry grafana.example.com
+# When using Cloudflare, each entry can receive an optional proxy override, like so:
+# grafana:proxy,rpc:noproxy,prometheus
+CNAME_LIST=
+# Whether to default to proxied or not in CloudFlare.
+CF_PROXY=false
+# Host names used in their respective *-traefik.yml files, to be reachable via traefik
+# Grafana, Siren and Prysm Web are exposed via traefik by default, if traefik is in use
 GRAFANA_HOST=grafana
 SIREN_HOST=siren
 PRYSM_HOST=prysm
+# ee-traefik.yml. This is EXTREMELY niche, do not expose engine API just because
 EE_HOST=engine
+# el-traefik.yml to expose the execution RPC and WS APIs
 EL_HOST=rpc
 EL_LB=rpc-lb
 EL_WS_HOST=ws
 EL_WS_LB=ws-lb
+# rpc-proxy-traefik.yml, to expose the RPC and WS APIs of the Nimbus Verified Proxy
 PROXY_RPC_HOST=rpc
 PROXY_WS_HOST=ws
+# cl-traefik.yml, to expose the consensus REST API
 CL_HOST=cl
 CL_LB=cl-lb
+# Specific to Lighthouse, exposes the keymanager API of the Lighthouse VC, used for Siren
 VC_HOST=vc
+# prometheus-traefik.yml, expose the Prometheus port
 PROM_HOST=prometheus
+# loki-traefik.yml, expose the Loki port
 LOKI_HOST=loki
+# tempo-traefik.yml, expose the Tempo ports
 TEMPO_GRPC_HOST=tempo-grpc
 TEMPO_HTTP_HOST=tempo-http
-DDNS_SUBDOMAIN=node
-DDNS_PROXY=false
 
 # Some clients suggest adjusting to higher (or lower) peer count. Adjust here, per client
 # Nimbus peer count should not be set below 70. CL_MIN_PEER_COUNT is used for Teku only.
@@ -504,4 +525,4 @@ DOCKER_ROOT=/var/lib/docker
 DOCKER_SOCK=/var/run/docker.sock
 
 # Used by ethd update - please do not adjust
-ENV_VERSION=57
+ENV_VERSION=58

ethd

@@ -1761,9 +1761,9 @@ __update_value_in_env() {
 }
 
 
-__env_migrate() {
-  local old_vars=( )
-  local new_vars=( )
+__migrate_env() {
+  local old_vars=( DDNS_PROXY DDNS_SUBDOMAIN )
+  local new_vars=( CF_PROXY DDNS_HOST )
   local error
   local line
   local index
@@ -2380,7 +2380,7 @@ update() {
     __non_interactive=1
   fi
 
-  __env_migrate
+  __migrate_env
   if [[ "${__env_migrated}" -eq 1 ]] && ! cmp -s "${__env_file}" "${__env_file}".source; then  # Create .bak early
     ${__as_owner} cp "${__env_file}".source "${__env_file}".bak
   fi