1
0
mirror of https://github.com/github/octodns.git synced 2024-05-11 05:55:00 +00:00

doc new include_target filter prarams

This commit is contained in:
Ross McFarland
2023-11-10 17:00:24 -08:00
parent 6cd933a834
commit be5d28dc56

View File

@@ -65,6 +65,10 @@ class TypeAllowlistFilter(_TypeBaseFilter, AllowsMixin):
allowlist: allowlist:
- A - A
- AAAA - AAAA
# Optional param that can be set to False to leave the target zone
# alone, thus allowing deletion of existing records
# (default: true)
# include_target: True
zones: zones:
exxampled.com.: exxampled.com.:
@@ -90,6 +94,10 @@ class TypeRejectlistFilter(_TypeBaseFilter, RejectsMixin):
class: octodns.processor.filter.TypeRejectlistFilter class: octodns.processor.filter.TypeRejectlistFilter
rejectlist: rejectlist:
- CNAME - CNAME
# Optional param that can be set to False to leave the target zone
# alone, thus allowing deletion of existing records
# (default: true)
# include_target: True
zones: zones:
exxampled.com.: exxampled.com.:
@@ -150,6 +158,10 @@ class NameAllowlistFilter(_NameBaseFilter, AllowsMixin):
- /some-pattern-\\d\\+/ - /some-pattern-\\d\\+/
# regex - anchored so has to match start to end # regex - anchored so has to match start to end
- /^start-.+-end$/ - /^start-.+-end$/
# Optional param that can be set to False to leave the target zone
# alone, thus allowing deletion of existing records
# (default: true)
# include_target: True
zones: zones:
exxampled.com.: exxampled.com.:
@@ -182,6 +194,10 @@ class NameRejectlistFilter(_NameBaseFilter, RejectsMixin):
- /some-pattern-\\d\\+/ - /some-pattern-\\d\\+/
# regex - anchored so has to match start to end # regex - anchored so has to match start to end
- /^start-.+-end$/ - /^start-.+-end$/
# Optional param that can be set to False to leave the target zone
# alone, thus allowing deletion of existing records
# (default: true)
# include_target: True
zones: zones:
exxampled.com.: exxampled.com.:
@@ -288,6 +304,10 @@ class ZoneNameFilter(_FilterProcessor):
# If true a ValidationError will be throw when such records are # If true a ValidationError will be throw when such records are
# encouterd, if false the records will just be ignored/omitted. # encouterd, if false the records will just be ignored/omitted.
# (default: true) # (default: true)
# Optional param that can be set to False to leave the target zone
# alone, thus allowing deletion of existing records
# (default: true)
# include_target: True
zones: zones:
exxampled.com.: exxampled.com.: