IGNORE_*: Warn about fragility (#1108)

This commit is contained in:
Tom Limoncelli 2021-03-28 15:17:47 -04:00 committed by GitHub
parent ef2a109207
commit 8c7ce22bf7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 2 deletions

View file

@ -1,7 +1,13 @@
---
name: IGNORE_NAME
parameters:
- pattern
---
WARNING: The `IGNORE_*` family of functions is risky to use. The code
is brittle and has subtle bugs. Use at your own risk. Do not use these
commands with `D_EXTEND()` or use it at the domain apex.
IGNORE_NAME can be used to ignore some records present in zone.
All records (independently of their type) of that name will be completely ignored.
@ -37,4 +43,4 @@ not match `.`
* `IGNORE_NAME("{bar,[fz]oo}")` will ignore `bar`, `foo` and `zoo`.
* `IGNORE_NAME("\\*.foo")` will ignore the literal record `*.foo`.
It is considered as an error to try to manage an ignored record.
It is considered as an error to try to manage an ignored record.

View file

@ -5,6 +5,10 @@ parameters:
- rType
---
WARNING: The `IGNORE_*` family of functions is risky to use. The code
is brittle and has subtle bugs. Use at your own risk. Do not use these
commands with `D_EXTEND()` or use it at the domain apex.
IGNORE_TARGET can be used to ignore some records present in zone based on the record's target and type. IGNORE_TARGET currently only supports CNAME record types.
IGNORE_TARGET is like NO_PURGE except it acts only on some specific records instead of the whole zone.
@ -31,4 +35,4 @@ IGNORE_TARGET also supports glob patterns in the style of the [gobwas/glob](http
* `IGNORE_TARGET("**.bar", "CNAME")` will ignore all CNAME records with target subdomains of `bar`, including double subdomains such as `www.foo.bar`.
* `IGNORE_TARGET("dev.*.foo", "CNAME")` will ignore all CNAME records with targets in the style of `dev.bar.foo`, but will not ignore records with targets using a double subdomain, such as `dev.foo.bar.foo`.
It is considered as an error to try to manage an ignored record.
It is considered as an error to try to manage an ignored record.