Merge remote-tracking branch 'origin/master' into idna-internally

CHANGELOG.md

@@ -1,8 +1,8 @@
-## v0.9.18 - 2022-09-14 - Subzone handling
+## v0.9.18 - 2022-08-14 - Subzone handling
 
 * Fixed issue with sub-zone handling introduced in 0.9.18
 
-## v0.9.18 - 2022-09-09 - Internationalization
+## v0.9.18 - 2022-08-09 - Internationalization
 
 * Added octodns.idna idna_encode/idna_decode helpers, providers will need to
   individually add support via these helpers though :-/

octodns/processor/filter.py

@@ -13,6 +13,27 @@ from .base import BaseProcessor
 
 
 class TypeAllowlistFilter(BaseProcessor):
+    '''Only manage records of the specified type(s).
+
+    Example usage:
+
+    processors:
+      only-a-and-aaaa:
+        class: octodns.processor.filter.TypeRejectlistFilter
+        rejectlist:
+          - A
+          - AAAA
+
+    zones:
+      exxampled.com.:
+        sources:
+          - config
+        processors:
+          - only-a-and-aaaa
+        targets:
+          - ns1
+    '''
+
     def __init__(self, name, allowlist):
         super(TypeAllowlistFilter, self).__init__(name)
         self.allowlist = set(allowlist)
@@ -29,6 +50,26 @@ class TypeAllowlistFilter(BaseProcessor):
 
 
 class TypeRejectlistFilter(BaseProcessor):
+    '''Ignore records of the specified type(s).
+
+    Example usage:
+
+    processors:
+      ignore-cnames:
+        class: octodns.processor.filter.TypeRejectlistFilter
+        rejectlist:
+          - CNAME
+
+    zones:
+      exxampled.com.:
+        sources:
+          - config
+        processors:
+          - ignore-cnames
+        targets:
+          - route53
+    '''
+
     def __init__(self, name, rejectlist):
         super(TypeRejectlistFilter, self).__init__(name)
         self.rejectlist = set(rejectlist)