octodns.processor.acme

class octodns.processor.acme.AcmeManagingProcessor(name)

Bases: BaseProcessor

log = <Logger AcmeManagingProcessor (WARNING)>

__init__(name)

Manage or ignore ACME records.

ACME records in the source:

Will be marked with metadata so octodns knows they are managed by octodns.

ACME records in the target:

If the octodns mark IS NOT found, they will be ignored. So ACME records in the target will not be updated or deleted.

If the octodns mark IS found, they will be treated like normal records.

Note

This filter processes records with names starting with: _acme-challenge, mostly used for the DNS-01 challenge.

For example: _acme-challenge.foo.domain.com

References

https://letsencrypt.org/docs/challenge-types/#dns-01-challenge

Example

processors:
    acme:
        class: octodns.processor.acme.AcmeManagingProcessor

zones:
    something.com.:
        sources:
            - x
        processors:
            - acme
        targets:
            - y

process_source_zone(desired, *args, **kwargs)

Called after all sources have completed populate. Provides an opportunity for the processor to modify the desired Zone that targets will receive.

• Will see desired after any modifications done by Provider._process_desired_zone and processors configured to run before this one.

• May modify desired directly.

• Must return desired which will normally be the desired param.

• Must not modify records directly, record.copy should be called, the results of which can be modified, and then Zone.add_record may be used with replace=True.

• May call Zone.remove_record to remove records from desired.

• Sources may be empty, as will be the case for aliased zones.

process_target_zone(existing, *args, **kwargs)

Called after a target has completed populate, before changes are computed between existing and desired. This provides an opportunity to modify the existing Zone.

• Will see existing after any modifications done by processors configured to run before this one.

• May modify existing directly.

• Must return existing which will normally be the existing param.

• Must not modify records directly, record.copy should be called, the results of which can be modified, and then Zone.add_record may be used with replace=True.

• May call Zone.remove_record to remove records from existing.

octodns.processor.acme.AcmeMangingProcessor

alias of AcmeManagingProcessor