Document --force requirements

[jaspermayone]

Hi,

I have browsed the docs for octodns and cannot seem to find what triggers a need for --force on a dns sync. We use octodns in production and need this info for creating workflows around running --force.

Thank you!

[ross]

There's a bit of info in the usage for the param:

octodns/octodns/cmds/sync.py

Lines 24 to 30 in ed13d2d

	parser.add_argument(
	'--force',
	action='store_true',
	default=False,
	help='Acknowledge that significant changes are being '
	'made and do them',
	)

Otherwise errors are thrown when situations are encountered that require careful human review before aknowleding the changes and --forceing them.

octodns/octodns/provider/plan.py

Lines 14 to 33 in ed13d2d

	class RootNsChange(UnsafePlan):
	def __init__(self):
	super().__init__('Root NS record change, force required')
	class TooMuchChange(UnsafePlan):
	def __init__(
	self,
	why,
	update_pcent,
	update_threshold,
	change_count,
	existing_count,
	name,
	):
	msg = (
	f'[{name}] {why}, {update_pcent:.2f}% is over {update_threshold:.2f}% '
	f'({change_count}/{existing_count}), force required'
	)
	super().__init__(msg)