Browse Source

Merge branch 'main' into fix-include-target

pull/1274/head
Ross McFarland 5 months ago
committed by GitHub
parent
commit
e55c35bd6f
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
4 changed files with 68 additions and 0 deletions
  1. +4
    -0
      .changelog/0d2c45a64fdc45268b8844c0d2439c6e.md
  2. +4
    -0
      .changelog/c4f025d1c23c40dd98380e6d3496364d.md
  3. +1
    -0
      README.md
  4. +59
    -0
      docs/processors.md

+ 4
- 0
.changelog/0d2c45a64fdc45268b8844c0d2439c6e.md View File

@ -0,0 +1,4 @@
---
type: none
---
New provider: Azion DNS

+ 4
- 0
.changelog/c4f025d1c23c40dd98380e6d3496364d.md View File

@ -0,0 +1,4 @@
---
type: none
---
Documentation for processors

+ 1
- 0
README.md View File

@ -273,6 +273,7 @@ The table below lists the providers octoDNS supports. They are maintained in the
| [Akamai Edge DNS](https://www.akamai.com/products/edge-dns) | [octodns_edgedns](https://github.com/octodns/octodns-edgedns/) | |
| [Amazon Route 53](https://aws.amazon.com/route53/) | [octodns_route53](https://github.com/octodns/octodns-route53) | |
| [AutoDNS](https://www.internetx.com/autodns/) | [octodns_autodns](https://github.com/octodns/octodns-autodns) | |
| [Azion DNS](https://www.azion.com/en/products/edge-dns/) | [octodns_azion](https://github.com/aziontech/octodns-azion/) | |
| [Azure DNS](https://azure.microsoft.com/en-us/services/dns/) | [octodns_azure](https://github.com/octodns/octodns-azure/) | |
| [BIND, AXFR, RFC-2136](https://www.isc.org/bind/) | [octodns_bind](https://github.com/octodns/octodns-bind/) | |
| [Bunny DNS](https://bunny.net/dns/) | [octodns_bunny](https://github.com/Relkian/octodns-bunny) | |


+ 59
- 0
docs/processors.md View File

@ -0,0 +1,59 @@
# octoDNS processors
## Available processors
These are listed in the main [`README`](../README.md#processors)
## Configuring processors
Configuring processors is done in the main config file.
### Defining a processor configuration
This is done under the top-level `processors` key in the octoDNS config file (for example `config.yaml`), as a sibling to the `manager` key.
The `processors` key contains YAML objects, where the key is the name of the processor, and the `class` value within that object refers to the processor name.
For example, to define a provider called `custom_meta` using the [`MetaProcessor`](../octodns/processor/meta.py) in order to extend the default `include_meta` behaviour:
```yaml
manager:
include_meta: false # disable default, basic `meta` records
processors:
custom_meta:
class: octodns.processor.meta.MetaProcessor
record_name: meta
include_time: true
include_uuid: true
include_provider: true
include_version: false
```
**NOTE:** the specific parameters for each processor are only documented within [the code](../octodns/processor/)
### Utilising the processor configuration
#### On **individual** domains
Each domain can utilise the processor independently by adding the name of the defined processor to a `processors` key beneath a `zone`:
```yaml
zones:
example.com.:
source:
- yaml_config
target:
- hetzner
processors:
- custom_meta
```
#### On **all** domains
To utilise the processor on **all** domains automatically, including new domains added to the `zones` config in future then you can add this to the `processors` key under the `manager` section of the configuration:
```yaml
manager:
processors:
- custom_meta
```

Loading…
Cancel
Save