StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-12-09 21:55:57 +08:00
Code Issues Projects Releases Packages Wiki Activity
dnscontrol/integrationTest/profiles.json
Jakob Ackermann 1e67585e8f
HETZNER_V2: Add provider for Hetzner DNS API (#3837) 
Closes https://github.com/StackExchange/dnscontrol/issues/3787

This PR is adding a `HETZNER_V2` provider for the "new" Hetzner DNS API.

Testing:
- The integration tests are passing.
- Manual testing:
  - `preview` (see diff for existing zone)
- `preview --populate-on-preview` (see full diff for newly created zone)
  - `push` (see full diff; no diff after push)
- `push` (see full diff; no diff after push to newly created zone --
i.e. single pass and done)

```js
var REG_NONE = NewRegistrar('none')
var DSP = NewDnsProvider('HETZNER_V2')

D('testing-2025-11-14-7.dev', REG_NONE, DnsProvider(DSP),
    A('@', '127.0.0.1')
)
```

<details>

```
# push for newly created zone
CONCURRENTLY checking for 1 zone(s)
SERIALLY checking for 0 zone(s)
Waiting for concurrent checking(s) to complete...DONE
******************** Domain: testing-2025-11-14-7.dev
1 correction (HETZNER_V2)
#1: Ensuring zone "testing-2025-11-14-7.dev" exists in "HETZNER_V2"
SUCCESS!
CONCURRENTLY gathering records of 1 zone(s)
SERIALLY gathering records of 0 zone(s)
Waiting for concurrent gathering(s) to complete...DONE
******************** Domain: testing-2025-11-14-7.dev
4 corrections (HETZNER_V2)
#1: ± MODIFY-TTL testing-2025-11-14-7.dev NS helium.ns.hetzner.de. ttl=(3600->300)
± MODIFY-TTL testing-2025-11-14-7.dev NS hydrogen.ns.hetzner.com. ttl=(3600->300)
± MODIFY-TTL testing-2025-11-14-7.dev NS oxygen.ns.hetzner.com. ttl=(3600->300)
SUCCESS!
#2: + CREATE testing-2025-11-14-7.dev A 127.0.0.1 ttl=300
SUCCESS!
Done. 5 corrections.
```
</details>

Feedback for @jooola and @LKaemmerling:
- The SDK was very useful in getting 80% there! Nice! 🎉 
- Footgun:
- The `result` values are not "up-to-date" after waiting for an
`Action`, e.g. `Zone.AuthoritativeNameservers.Assigned` is not set when
`Client.Zone.Create()` returns and the following "wait" will not update
it.
- Taking a step back here: Waiting for an `Action` with a separate SDK
call does not seem very natural to me. Does the SDK-user need to know
that you are processing operations asynchronous? (Which seems like an
implementation detail to me, something that the SDK could abstrct over.)
Can `Client.Zone.Create()` return the final `Zone` instead of the
intermediate result?
- Features missing compared to the DNS Console, in priority order:
- It is no longer possible to remove your provided name servers from the
root/apex. Use-case: dual-home/multi-home zone with fewer than three
servers from Hetzner. I'm operating one of these and cannot migrate over
until this is fixed.
- Performance regression due to lack of bulk create/modify. E.g. [one of
the test
suites](a71b89e5a2/integrationTest/integration_test.go (L619))
spends about 4.5 minutes on making creating 100 record-sets and then
another 4 minutes for deleting them in sequence again. With your async
API, these are `create 2*100 + delete 2*100 = 400` API calls.
Previously, these were `create 1 + delete 100 = 101` API calls. Are you
planning on adding batch processing again?
- Usability nits
- Compared to other record-set based APIs, upserts for record-sets are
missing. This applies to records of a record-set and the ttl of the
record-set (see separate SDK calls for the cases `diff2.CREATE` vs
`diff2.CHANGE` and two calls in `diff2.CHANGE` for updating the TTL vs
records).
- Some SDK methods return an `Action` (e.g. `Zone.ChangeRRSetTTL()`),
others wrap the `Action` in a struct (`Client.Zone.CreateRRSet()`) --
even when the struct has a single field (`ZoneRRSetDeleteResult`).

---------

Co-authored-by: "Jonas L." <jooola@users.noreply.github.com>
Co-authored-by: "Lukas Kämmerling" <LKaemmerling@users.noreply.github.com>
Co-authored-by: Tom Limoncelli <6293917+tlimoncelli@users.noreply.github.com>
2025-11-30 09:14:54 -05:00

348 lines
9.1 KiB
JSON
Raw Blame History

{
"ADGUARDHOME": {
"TYPE": "ADGUARDHOME",
"domain": "$ADGUARDHOME_DOMAIN",
"host": "$ADGUARDHOME_HOST",
"password": "$ADGUARDHOME_PASSWORD",
"username": "$ADGUARDHOME_USERNAME"
},
"AKAMAIEDGEDNS": {
"TYPE": "AKAMAIEDGEDNS",
"access_token": "$AED_ACCESS_TOKEN",
"client_secret": "$AED_CLIENT_SECRET",
"client_token": "$AED_CLIENT_TOKEN",
"contract_id": "$AED_CONTRACT_ID",
"domain": "$AED_DOMAIN",
"group_id": "$AED_GROUP_ID",
"host": "$AED_HOST"
},
"AUTODNS": {
"TYPE": "AUTODNS",
"context": "$AUTODNS_CONTEXT",
"domain": "$AUTODNS_DOMAIN",
"password": "$AUTODNS_PASSWORD",
"username": "$AUTODNS_USERNAME"
},
"AXFRDDNS": {
"TYPE": "AXFRDDNS",
"domain": "$AXFRDDNS_DOMAIN",
"master": "$AXFRDDNS_MASTER",
"nameservers": "ns.example.com",
"transfer-key": "$AXFRDDNS_TRANSFER_KEY",
"transfer-mode": "$AXFRDDNS_TRANSFER_MODE",
"update-key": "$AXFRDDNS_UPDATE_KEY",
"update-mode": "$AXFRDDNS_UPDATE_MODE"
},
"AXFRDDNS_DNSSEC": {
"TYPE": "AXFRDDNS",
"domain": "$AXFRDDNS_DNSSEC_DOMAIN",
"master": "$AXFRDDNS_DNSSEC_MASTER",
"nameservers": "ns.example.com",
"transfer-key": "$AXFRDDNS_DNSSEC_TRANSFER_KEY",
"transfer-mode": "$AXFRDDNS_DNSSEC_TRANSFER_MODE",
"update-key": "$AXFRDDNS_DNSSEC_UPDATE_KEY",
"update-mode": "$AXFRDDNS_DNSSEC_UPDATE_MODE"
},
"AZURE_DNS": {
"ClientID": "$AZURE_DNS_CLIENT_ID",
"ClientSecret": "$AZURE_DNS_CLIENT_SECRET",
"ResourceGroup": "$AZURE_DNS_RESOURCE_GROUP",
"SubscriptionID": "$AZURE_DNS_SUBSCRIPTION_ID",
"TYPE": "AZURE_DNS",
"TenantID": "$AZURE_DNS_TENANT_ID",
"domain": "$AZURE_DNS_DOMAIN"
},
"BIND": {
"TYPE": "BIND",
"domain": "$BIND_DOMAIN"
},
"BUNNY_DNS": {
"TYPE": "BUNNY_DNS",
"api_key": "$BUNNY_DNS_API_KEY",
"domain": "$BUNNY_DNS_DOMAIN"
},
"CLOUDFLAREAPI": {
"TYPE": "CLOUDFLAREAPI",
"accountid": "$CLOUDFLAREAPI_ACCOUNTID",
"apikey": "$CLOUDFLAREAPI_KEY",
"apitoken": "$CLOUDFLAREAPI_TOKEN",
"apiuser": "$CLOUDFLAREAPI_USER",
"domain": "$CLOUDFLAREAPI_DOMAIN"
},
"CLOUDFLAREAPI_OLD": {
"TYPE": "CLOUDFLAREAPI_OLD",
"apikey": "$CF_KEY",
"apiuser": "$CF_USER",
"domain": "$CF_DOMAIN",
"knownFailures": "54"
},
"CLOUDNS": {
"TYPE": "CLOUDNS",
"auth-id": "$CLOUDNS_AUTH_ID",
"auth-password": "$CLOUDNS_AUTH_PASSWORD",
"domain": "$CLOUDNS_DOMAIN",
"sub-auth-id": "$CLOUDNS_SUB_AUTH_ID"
},
"CNR": {
"TYPE": "CNR",
"apientity": "$CNR_ENTITY",
"apilogin": "$CNR_UID",
"apipassword": "$CNR_PW",
"debugmode": "$CNR_DEBUGMODE",
"domain": "$CNR_DOMAIN"
},
"CSCGLOBAL": {
"TYPE": "CSCGLOBAL",
"api-key": "$CSCGLOBAL_APIKEY",
"domain": "$CSCGLOBAL_DOMAIN",
"notification_emails": "$CSCGLOBAL_NOTIFICATION",
"user-token": "$CSCGLOBAL_USERTOKEN"
},
"DESEC": {
"TYPE": "DESEC",
"auth-token": "$DESEC_TOKEN",
"domain": "$DESEC_DOMAIN"
},
"DIGITALOCEAN": {
"TYPE": "DIGITALOCEAN",
"domain": "$DIGITALOCEAN_DOMAIN",
"token": "$DIGITALOCEAN_TOKEN"
},
"DNSIMPLE": {
"TYPE": "DNSIMPLE",
"baseurl": "https://api.sandbox.dnsimple.com",
"domain": "$DNSIMPLE_DOMAIN",
"token": "$DNSIMPLE_TOKEN"
},
"DNSMADEEASY": {
"TYPE": "DNSMADEEASY",
"api_key": "$DNSMADEEASY_API_KEY",
"domain": "$DNSMADEEASY_DOMAIN",
"sandbox": "true",
"secret_key": "$DNSMADEEASY_SECRET_KEY"
},
"DOMAINNAMESHOP": {
"TYPE": "DOMAINNAMESHOP",
"domain": "$DOMAINNAMESHOP_DOMAIN",
"secret": "$DOMAINNAMESHOP_SECRET",
"token": "$DOMAINNAMESHOP_TOKEN"
},
"EXOSCALE": {
"TYPE": "EXOSCALE",
"apikey": "$EXOSCALE_API_KEY",
"apizone": "ch-gva-2",
"dns-endpoint": "https://api.exoscale.com/v2",
"domain": "$EXOSCALE_DOMAIN",
"secretkey": "$EXOSCALE_SECRET_KEY"
},
"FORTIGATE": {
"TYPE": "FORTIGATE",
"apiKey": "$FORTIGATE_API_KEY",
"debug_http": "$FORTIGATE_DEBUG_HTTP",
"domain": "$FORTIGATE_DOMAIN",
"host": "$FORTIGATE_HOST",
"insecure_tls": "$FORTIGATE_NO_SSL_VERIFY",
"vdom": "$FORTIGATE_VDOM"
},
"GANDI_V5": {
"TYPE": "GANDI_V5",
"apikey": "$GANDI_V5_APIKEY",
"domain": "$GANDI_V5_DOMAIN",
"token": "$GANDI_V5_TOKEN"
},
"GCLOUD": {
"TYPE": "GCLOUD",
"client_email": "$GCLOUD_EMAIL",
"domain": "$GCLOUD_DOMAIN",
"private_key": "$GCLOUD_PRIVATEKEY",
"project_id": "$GCLOUD_PROJECT",
"type": "$GCLOUD_TYPE"
},
"GCORE": {
"TYPE": "GCORE",
"api-key": "$GCORE_API_KEY",
"domain": "$GCORE_DOMAIN"
},
"HEDNS": {
"TYPE": "HEDNS",
"domain": "$HEDNS_DOMAIN",
"password": "$HEDNS_PASSWORD",
"session-file-path": ".",
"totp-key": "$HEDNS_TOTP_SECRET",
"username": "$HEDNS_USERNAME"
},
"HETZNER": {
"TYPE": "HETZNER",
"api_key": "$HETZNER_API_KEY",
"domain": "$HETZNER_DOMAIN"
},
"HETZNER_V2": {
"TYPE": "HETZNER_V2",
"api_token": "$HETZNER_V2_API_TOKEN",
"domain": "$HETZNER_V2_DOMAIN"
},
"HEXONET": {
"TYPE": "HEXONET",
"apientity": "$HEXONET_ENTITY",
"apilogin": "$HEXONET_UID",
"apipassword": "$HEXONET_PW",
"debugmode": "$HEXONET_DEBUGMODE",
"domain": "$HEXONET_DOMAIN",
"ipaddress": "$HEXONET_IP"
},
"HOSTINGDE": {
"TYPE": "HOSTINGDE",
"authToken": "$HOSTINGDE_AUTHTOKEN",
"domain": "$HOSTINGDE_DOMAIN"
},
"HUAWEICLOUD": {
"KeyId": "$HUAWEICLOUD_KEY_ID",
"Region": "$HUAWEICLOUD_REGION",
"SecretKey": "$HUAWEICLOUD_KEY",
"TYPE": "HUAWEICLOUD",
"domain": "$HUAWEICLOUD_DOMAIN"
},
"INWX": {
"TYPE": "INWX",
"domain": "$INWX_DOMAIN",
"password": "$INWX_PASSWORD",
"sandbox": "1",
"username": "$INWX_USER"
},
"JOKER": {
"TYPE": "JOKER",
"domain": "$JOKER_DOMAIN",
"password": "$JOKER_PASSWORD",
"username": "$JOKER_USERNAME"
},
"LINODE": {
"TYPE": "LINODE",
"domain": "$LINODE_DOMAIN",
"token": "$LINODE_TOKEN"
},
"LOOPIA": {
"TYPE": "LOOPIA",
"domain": "$LOOPIA_DOMAIN",
"password": "$LOOPIA_PASSWORD",
"username": "$LOOPIA_USERNAME"
},
"LUADNS": {
"TYPE": "LUADNS",
"apikey": "$LUADNS_APIKEY",
"domain": "$LUADNS_DOMAIN",
"email": "$LUADNS_EMAIL"
},
"MYTHICBEASTS": {
"TYPE": "MYTHICBEASTS",
"domain": "$MYTHICBEASTS_DOMAIN",
"keyID": "$MYTHICBEASTS_KEYID",
"secret": "$MYTHICBEASTS_SECRET"
},
"NAMECHEAP": {
"BaseURL": "$NAMECHEAP_BASEURL",
"TYPE": "NAMECHEAP",
"apikey": "$NAMECHEAP_KEY",
"apiuser": "$NAMECHEAP_USER",
"domain": "$NAMECHEAP_DOMAIN"
},
"NAMEDOTCOM": {
"TYPE": "NAMEDOTCOM",
"apikey": "$NAMEDOTCOM_KEY",
"apiurl": "$NAMEDOTCOM_URL",
"apiuser": "$NAMEDOTCOM_USER",
"domain": "$NAMEDOTCOM_DOMAIN"
},
"NETCUP": {
"TYPE": "NETCUP",
"api-key": "$NETCUP_KEY",
"api-password": "$NETCUP_PASSWORD",
"customer-number": "$NETCUP_CUSTOMER_NUMBER",
"domain": "$NETCUP_DOMAIN"
},
"NETLIFY": {
"TYPE": "NETLIFY",
"domain": "$NETLIFY_DOMAIN",
"slug": "$NETLIFY_ACCOUNT_SLUG",
"token": "$NETLIFY_TOKEN"
},
"NS1": {
"TYPE": "NS1",
"api_token": "$NS1_TOKEN",
"domain": "$NS1_DOMAIN"
},
"ORACLE": {
"TYPE": "ORACLE",
"compartment": "$ORACLE_COMPARTMENT",
"domain": "$ORACLE_DOMAIN",
"fingerprint": "$ORACLE_FINGERPRINT",
"private_key": "$ORACLE_PRIVATE_KEY",
"region": "$ORACLE_REGION",
"tenancy_ocid": "$ORACLE_TENANCY_OCID",
"user_ocid": "$ORACLE_USER_OCID"
},
"OVH": {
"TYPE": "OVH",
"app-key": "$OVH_APP_KEY",
"app-secret-key": "$OVH_APP_SECRET_KEY",
"consumer-key": "$OVH_CONSUMER_KEY",
"domain": "$OVH_DOMAIN",
"endpoint": "$OVH_ENDPOINT"
},
"PACKETFRAME": {
"TYPE": "PACKETFRAME",
"domain": "$PACKETFRAME_DOMAIN",
"token": "$PACKETFRAME_TOKEN"
},
"PORKBUN": {
"TYPE": "PORKBUN",
"api_key": "$PORKBUN_API_KEY",
"domain": "$PORKBUN_DOMAIN",
"max_attempts": "$PORKBUN_MAX_ATTEMPTS",
"max_duration": "$PORKBUN_MAX_DURATION",
"secret_key": "$PORKBUN_SECRET_KEY"
},
"POWERDNS": {
"TYPE": "POWERDNS",
"apiKey": "$POWERDNS_APIKEY",
"apiUrl": "$POWERDNS_APIURL",
"domain": "$POWERDNS_DOMAIN",
"serverName": "$POWERDNS_SERVERNAME"
},
"REALTIMEREGISTER": {
"TYPE": "REALTIMEREGISTER",
"apikey": "$REALTIMEREGISTER_APIKEY",
"domain": "$REALTIMEREGISTER_DOMAIN",
"premium": "$REALTIMEREGISTER_PREMIUM",
"sandbox": "$REALTIMEREGISTER_SANDBOX"
},
"ROUTE53": {
"KeyId": "$ROUTE53_KEY_ID",
"SecretKey": "$ROUTE53_KEY",
"TYPE": "ROUTE53",
"domain": "$ROUTE53_DOMAIN"
},
"SAKURACLOUD": {
"TYPE": "SAKURACLOUD",
"access_token": "$SAKURACLOUD_ACCESS_TOKEN",
"access_token_secret": "$SAKURACLOUD_ACCESS_TOKEN_SECRET",
"domain": "$SAKURACLOUD_DOMAIN"
},
"SOFTLAYER": {
"TYPE": "SOFTLAYER",
"api_key": "$SL_API_KEY",
"domain": "$SL_DOMAIN",
"username": "$SL_USERNAME"
},
"TRANSIP": {
"AccessToken": "$TRANSIP_ACCESS_TOKEN",
"AccountName": "$TRANSIP_ACCOUNT_NAME",
"PrivateKey": "$TRANSIP_PRIVATE_KEY",
"TYPE": "TRANSIP",
"domain": "$TRANSIP_DOMAIN"
},
"VULTR": {
"TYPE": "VULTR",
"domain": "$VULTR_DOMAIN",
"token": "$VULTR_TOKEN"
}
}
Reference in a new issue View git blame Copy permalink