doc enhancement for waf addons and reconciliation

[oliviassss]

Issue

Description

Doc improvement for the controller's exact behavior regarding reconciliation and waf addons.
following up this PR.
Checked the rendering by make docs-preview

Checklist

• Added tests that cover your change (if possible)
• Added/modified documentation as required (such as the README.md, or the docs directory)
• Manually tested
• Made sure the title of the PR is a good description that can go into the release notes

BONUS POINTS checklist: complete for good vibes and maybe prizes?! 🤯

• Backfilled missing tests for code in same general area 🎉
• Refactored something and made the world a better place 🌟

[johngmyers]

A 10-hour resync period means that if someone does something to cause drift, the time the controller reverts it is almost guaranteed to be outside of office hours. This is much more dangerous.

[M00nF1sh]

A 10-hour resync period means that if someone does something to cause drift, the time the controller reverts it is almost guaranteed to be outside of office hours. This is much more dangerous.

Hi John, since this sync-period feature never worked before, it's not a regression no matter how large this sync-period value is.

The reason we want this to be a large value is due to we don't want to suddenly introduce a large amount of AWS APIs calls in a patch version. (we can consider change it to a smaller default in future versions if necessary).

Also, users shouldn't rely on this sync-period feature to override their custom made settings at all. IIRC, the sync-period exists in early days of Kubernetes when the informer mechanism wasn't reliable, so it uses re-sync to protect from missed events instead of as mechanism to do drift checks. Newer controllers in Kubernetes eco all have a large sync-period settings.

[M00nF1sh]

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: M00nF1sh, oliviassss

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [M00nF1sh]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[johngmyers]

I would have gone for something like 4-6 hours. It might push the revert out of business hours, but unlikely to go into sleep time.

Assuming things that cause the controller to do a reconciliation are more likely to happen during business hours, a 10-hour sync period s increases the probability of the reversion happening during sleep time. But I suppose a few stars would have to align.