external-dns-infoblox-webhook

Infoblox provider based on in-tree provider for ExternalDNS. Supported records:

Record Type	Status
A	supported
AAAA	supported
CNAME	supported
TXT	supported
PTR	not tested

See docs/examples.md for worked examples of creating records with the DNSEndpoint CRD and with Service/Ingress annotations.

Quick start

To run the provider, you must provide the following Environment Variables:

Infoblox Environment Variables:

Environment Variable	Default value	Required
INFOBLOX_HOST	localhost	true
INFOBLOX_PORT	443	true
INFOBLOX_WAPI_USER		true
INFOBLOX_WAPI_PASSWORD		true
INFOBLOX_VERSION		true
INFOBLOX_SSL_VERIFY	true	false
INFOBLOX_DRY_RUN	false	false
INFOBLOX_VIEW	default	false
INFOBLOX_WAPI_BASE_PATH		false
INFOBLOX_MAX_RESULTS	1500	false
INFOBLOX_CREATE_PTR	false	false
INFOBLOX_DEFAULT_TTL	300	false
INFOBLOX_USE_TTL	true	false
INFOBLOX_EXTENSIBLE_ATTRIBUTES_JSON	{}	false

INFOBLOX_WAPI_BASE_PATH

By default all WAPI requests go to https://<host>:<port>/wapi/v<version>/.... If the grid is reached through a reverse proxy or an API gateway that serves NIOS under an additional path prefix, set INFOBLOX_WAPI_BASE_PATH to that prefix:

# requests become https://<host>:<port>/nios/wapi/v<version>/...
INFOBLOX_WAPI_BASE_PATH=nios

Nested prefixes are supported (INFOBLOX_WAPI_BASE_PATH=proxy/nios). Leading and trailing slashes are optional and are stripped. Leaving the variable unset (or setting it to / or an empty/blank value) keeps the default /wapi/v<version> paths unchanged.

INFOBLOX_CREATE_PTR

When infoblox INFOBLOX_CREATE_PTR is set to true, make shure that DOMAIN_FILTER contains the zone for reversed lookup.

DOMAIN_FILTER="cloud.example, 1.2.3.0/24"

PTR records are created for both A and AAAA records. IPv6 reverse zones use the nibble format under ip6.arpa, so the IPv6 network has to be part of the DOMAIN_FILTER in CIDR notation as well:

DOMAIN_FILTER="cloud.example, 1.2.3.0/24, 2001:db8::/64"

external-dns-infoblox-webhook Environment Variables:

Environment Variable	Default value	Required
SERVER_HOST	127.0.0.1	true
SERVER_PORT	8888	true
HEALTH_CHECK_PORT	8080	false
SERVER_READ_TIMEOUT		false
SERVER_WRITE_TIMEOUT		false
SERVER_READ_HEADER_TIMEOUT	5s	false
SERVER_IDLE_TIMEOUT	30s	false
SERVER_MAX_BODY_SIZE	33554432	false
DOMAIN_FILTER		false
EXCLUDE_DOMAIN_FILTER		false
REGEXP_DOMAIN_FILTER		false
REGEXP_DOMAIN_FILTER_EXCLUSION		false
REGEXP_NAME_FILTER		false

SERVER_READ_HEADER_TIMEOUT and SERVER_IDLE_TIMEOUT accept Go duration values (for example, 5s or 1m). The read-header timeout limits how long the server waits to read request headers; the idle timeout limits how long an idle keep-alive connection remains open. SERVER_MAX_BODY_SIZE sets the maximum request body size in bytes (32 MiB by default).

Contribution

All PRs are welcome, but before you create a PR, make sure your changes pass the linters and the apache2 license is injected into the newly added files. The make lint command will do this for you.

Another point is the tests. If you create/change functionality, make sure the tests are running, updated or necessary ones are added. The make test command is used to run the tests.

All commits MUST be SIGNED before merge into main branch.

Running locally

To run provider in a local environment, you must provide all required settings through environment variables. To run locally, set SERVER_HOST to localhost, otherwise leave it at 0.0.0.0. Infoblox Provider is a simple web server with several clearly defined routers:

Route	Method
/healthz	GET
/records	GET
/records	POST
/adjustendpoints	POST

Reading Data

Read data by HTTP GET to /records, see:

curl -H 'Accept: application/external.dns.webhook+json;version=1' localhost:8888/records

If you set DOMAIN_FILTER, DNS will return all records from this domain(s). Because the returned data for a given domain can be large - in some cases tens of thousands of records, it is advisable to use filters to reduce the data to the desired result. Filters are specified via environment variables: DOMAIN_FILTER,EXCLUDE_DOMAIN_FILTER, REGEXP_DOMAIN_FILTER,REGEXP_DOMAIN_FILTER_EXCLUSION,REGEXP_NAME_FILTER.

The following example demonstrates the use of a filter:

# We are looking for all records in these two domains. 
# Unfortunately, they may contain tens of thousands of records.
DOMAIN_FILTER=org.eu.cloud.example.com,org-hq.us.cloud.example.com

# If DOMAIN_FILTER is not enough, you can use regex. Once you use REGEXP_DOMAIN_FILTER, DOMAIN_FILTER will be ignored.
# In following example we restrict zones to *.eu.cloud.example.com or *.org-hq.us.cloud.example.com.
REGEXP_DOMAIN_FILTER=(eu.cloud|org-hq.us).cloud.example.com

# Finally, we filter only those records that have `my-project.org-hq` or `.us.cloud` in the name
REGEXP_NAME_FILTER=(my-project.org-hq|.us.cloud)

Writing Data

Here are the updating rules according to which the data in the DNS server will be updated:

• if updateNew is not part of Update Old , object should be created
• if updateOld is not part of Update New , object should be deleted
• if information is not present (TTL might change) , object should be updated
• if we rename the object, object should be deleted and created

Based on the rules I am providing some examples of data.json creating, changing and deleting records in DNS.

curl -X POST -H 'Accept: application/external.dns.webhook+json;version=1;' -H 'Content-Type: application/external.dns.webhook+json;version=1' -d @data.json localhost:8888/records

Create test.cloud.example.com

{"Create":null,"UpdateOld":null,"UpdateNew":[{"dnsName":"test.cloud.example.com","targets":["1.3.2.1"],"recordType":"A","recordTTL":300}],"Delete":null}

Update test.cloud.example.com (DELETE one record test.cloud.example.com and CREATE two records new-test.cloud.example.com)

{"Create":null,"UpdateOld":[{"dnsName":"test.cloud.example.com","targets":["1.3.2.1"],"recordType":"A","recordTTL":300}],"UpdateNew":[{"dnsName":"new-test.cloud.example.com","targets":["1.2.3.4","4.3.2.1"],"recordType":"A","recordTTL":300}],"Delete":null}

Delete test-new.cloud.example.com

{"Create":null,"UpdateOld":[{"dnsName":"new-test.cloud.example.","targets":["1.2.3.4","4.3.2.1"],"recordType":"A","recordTTL":300}],"UpdateNew":null,"Delete":null}