octodns.processor.ownership

Classes

OwnershipProcessor(name[, txt_name, ...])

class octodns.processor.ownership.OwnershipProcessor(name, txt_name='_owner', txt_value='*octodns*', txt_ttl=60, should_replace=False, **kwargs)

Bases: BaseProcessor

__init__(name, txt_name='_owner', txt_value='*octodns*', txt_ttl=60, should_replace=False, **kwargs)

Initialize the processor.

Parameters:

• name (str) – Unique identifier for this processor instance. Used in logging and configuration references.

• lenient (bool) – When True, the processor will operate in lenient mode. This value is combined with the per-call lenient parameter in process_* methods.

Note

The name parameter is deprecated and will be removed in version 2.0. Use id instead.

process_source_zone(desired, sources, lenient=False)

Process the desired zone after all sources have populated.

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

Parameters:

• desired (octodns.zone.Zone) – The desired zone state after all sources have populated. This zone will be used as the target state for planning.

• sources (list[octodns.provider.base.BaseProvider]) – List of source providers that populated the zone. May be empty for aliased zones.

• lenient (bool) – When True, relaxed validation rules should be applied when modifying zone records.

Returns:

The modified desired zone, typically the same object passed in.

Return type:

octodns.zone.Zone

Important

• 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.

• Implementations should combine self.lenient or lenient and pass the result to any record and zone calls that accept lenient as a parameter, e.g. zone.add_record(..., lenient=lenient).

_is_ownership(record)

process_plan(plan, sources, target, lenient=False)

Process the plan after it has been computed.

Called after the planning phase has completed. Provides an opportunity for the processor to modify the plan, thus changing the actions that will be displayed and potentially applied.

Parameters:

• plan (octodns.provider.plan.Plan or None) – The computed plan containing the changes to be applied. May be None if no changes were detected.

• sources (list[octodns.provider.base.BaseProvider]) – List of source providers for this zone. May be empty for aliased zones.

• target (octodns.provider.base.BaseProvider) – The target provider for which the plan was created.

• lenient (bool) – When True, relaxed validation rules should be applied when modifying zone records.

Returns:

The modified plan, which may be the same object passed in, a newly created Plan, or None if no changes are needed.

Return type:

octodns.provider.plan.Plan or None

Important

• plan may be None if no changes were detected; if so, a Plan may still be created and returned.

• May modify plan.changes directly or create a new Plan.

• Does not have to modify plan.desired and/or plan.existing to line up with any modifications made to plan.changes.

• Should copy over plan.exists, plan.update_pcent_threshold, and plan.delete_pcent_threshold when creating a new Plan.

• Must return a Plan which may be plan or can be a newly created one with plan.desired and plan.existing copied over as-is or modified.

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

• Implementations should combine self.lenient or lenient and pass the result to any record and zone calls that accept lenient as a parameter, e.g. zone.add_record(..., lenient=lenient).