DNS - Cloudflare - Humanitec Documentation

Search…
DNS - Cloudflare
Reference for the humanitec/dns-cloudflare driver
This driver generates a new subdomain for a domain that is managed in a Cloudflare Zone.
Property
Description
Resource Type
​dns​
Account Type
cloudflare
Inputs
Values
Name
Type
Description
zone_id
string
The ID of the Cloudflare zone the record is in.
domain
string
The domain under which to specify the subdomain. E.g. staging.example.com
proxied
boolean
[Optional] A boolean value specifying whether Cloudflare proxies this subdomain. Defaults to false.
ttl
integer
[Optional] An integer number of seconds that the DNS name should live for. Defaults to 1 which means "Default" in Cloudflare.
Secrets
Name
Type
Description
tls
object
A TLS certificate in Kubernetes certificate format. E.g. {"tls.crt": "...", "tls.key": "..."}
The TLS certificate must be a wildcard certificate valid for subdomains of the domain value. E.g. for staging.example.com, the certificate must include *.staging.example.com as an CN or SAN.
Notes
Zone Identifier
Cloudflare organises resources into "Zones". You can find the Zone Identifier on the main dash page for the domain. It is at the bottom right under the heading Zone ID.
API Token
The driver uses a Cloudflare API Token to add, update and remove DNS records. The token must have Zone.DNS edit permissions on the zone the subdomain should be set up in.
The token should be added as an account of type cloudflare.
Example
In this example, we use the humantec/dns-cloudflare driver to provision new subdomains under staging.cf-hosted-domain.com for an app called cloudflare-dns-example-app.
First, the Resource Account containing the Cloudflare API Token must be created:
1
curl https://api.humanitec.io/orgs/my-org/resources/accounts \
2
  -X POST \
3
  -H "Authorization: Bearer $HUMANITEC_TOKEN" \
4
  -H "Content-Type: application/json" \
5
  --data-binary '{
6
    "id": "cloudflare-example-account",
7
    "name": "Cloudflare Example Account",
8
    "type": "cloudflare",
9
    "credentials": {
10
      "token": "kji2b0masdlkfjbaslf-b28n"
11
    }
12
  }'
Copied!
Then following Dynamic Resource Definition should be added:
1
curl https://api.humanitec.io/orgs/my-org/resources/dynic \
2
  -X POST \
3
  -H "Authorization: Bearer $HUMANITEC_TOKEN" \
4
  -H "Content-Type: application/json" \
5
  --data-binary '{
6
  "id": "dynamic-dns-cloudflare",
7
  "name": "Dynamic DNS via Cloudflare",
8
  "type": "dns",
9
  "criteria": [
10
    {
11
      "app_id": "cloudflare-dns-example-app"
12
    }
13
  ],
14
  "account_id": "cloudflare-example-account",
15
  "driver_type": "humanitec/dns-cloudflare",
16
  "driver_params": {
17
    "values": {
18
      "zone_id": "1ef520391d97ed73c38bc35dd8b570d0",
19
      "domain": "staging.cf-hosted-domain.com",
20
      "ttl": 1,
21
      "proxied": false
22
    },
23
    "secrets": {
24
      "tls": {
25
        "tls.crt": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n",
26
        "tls.key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"
27
      }
28
    }
29
  }
30
}'
Copied!
​
DNS - Wildcard
Ingress
Last modified 2mo ago
Copy link
Contents