Skip to content

Commit aa2c32d

Browse files
README - Example of filter usage in the documentation (#15)
* README - Example of filter usage in the documentation * Update README.md Co-authored-by: Donovan Muller <[email protected]> --------- Co-authored-by: Donovan Muller <[email protected]>
1 parent 534beb4 commit aa2c32d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,27 @@ Infoblox Provider is a simple web server with several clearly defined routers:
6969
| /adjustendpoints | POST |
7070

7171
#### Reading Data
72+
Read data by HTTP GET to `/records`, see:
7273
```shell
7374
curl -H 'Accept: application/external.dns.webhook+json;version=1' localhost:8888/records
7475
```
76+
If you set DOMAIN_FILTER, DNS will return all records from this domain(s). Because the returned data for a given
77+
domain can be large - in some cases tens of thousands of records, it is advisable to use filters to reduce the
78+
data to the desired result. Filters are specified via environment variables: `DOMAIN_FILTER`,`EXCLUDE_DOMAIN_FILTER`,
79+
`REGEXP_DOMAIN_FILTER`,`REGEXP_DOMAIN_FILTER_EXCLUSION`,`REGEXP_NAME_FILTER`.
80+
81+
The following example demonstrates the use of a filter:
82+
```shell
83+
# We are looking for all records in these two domains.
84+
# Unfortunately, they may contain tens of thousands of records.
85+
DOMAIN_FILTER=org.eu.cloud.example.com,org-hq.us.cloud.example.com
86+
87+
# Using regex, we further restrict the domains to org.eu.cloud.example.comorg-hq.us.cloud.example.com
88+
REGEXP_DOMAIN_FILTER=(eu.cloud|org-hq.us).cloud.example.com
89+
90+
# Finally, we filter only those records that have `my-project.org-hq` or `.us.cloud` in the name
91+
REGEXP_NAME_FILTER=(my-project.org-hq|.us.cloud)
92+
```
7593

7694
#### Writing Data
7795

0 commit comments

Comments
 (0)