Skip to content

docs: Image Automation exclusions, OCI HelmRepository status, controller-runtime alerts - #2654

Open
RaviTharuma wants to merge 5 commits into
fluxcd:mainfrom
RaviTharuma:docs/operator-gaps-2640-2643-2644
Open

RaviTharuma wants to merge 5 commits into
fluxcd:mainfrom
RaviTharuma:docs/operator-gaps-2640-2643-2644

Conversation

@RaviTharuma

Copy link
Copy Markdown

Fixes #2644. Fixes #2643. Fixes #2640. Operator docs for Alert exclusionList, OCI HelmRepository empty status, and controller_runtime_reconcile_errors_total alerts.

Signed-off-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The troubleshooting cheatsheet change introduces a Markdown code-fence structure error that will break page rendering.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR updates Flux operator documentation to address common operational pain points: silencing transient Image Automation alert noise, clarifying OCI HelmRepository status/Ready column behavior, and providing Prometheus alerting examples based on controller-runtime error metrics.

Changes:

  • Add an example PrometheusRule using controller_runtime_reconcile_errors_total for high-signal controller error alerting.
  • Document Alert.spec.exclusionList patterns to exclude expected transient Image Automation errors (cold start / empty tag DB).
  • Add troubleshooting guidance for OCI HelmRepository blank Ready/status and for Alert/Provider objects lacking status conditions.
File summaries
File Description
content/en/flux/monitoring/metrics.md Adds a controller-runtime reconcile error alerting section with a PrometheusRule example.
content/en/flux/monitoring/alerts.md Adds Image Automation exclusionList examples and guidance to reduce noisy alerts.
content/en/flux/cheatsheets/troubleshooting.md Documents OCI HelmRepository blank Ready/status behavior and Alert/Provider status limitations, with verification commands.
Review details

Suppressed comments (1)

content/en/flux/cheatsheets/troubleshooting.md:79

  • There is an extra closing code fence (```) after the companion link which will break markdown rendering once the earlier code block is properly closed.
Companion: [notification-controller#1371](https://github.com/fluxcd/notification-controller/issues/1371).


- **Files reviewed:** 3/3 changed files
- **Comments generated:** 2
- **Review effort level:** Lite
</details>

---

💡 <a href="/fluxcd/website/new/main?filename=.github/skills/code-review/SKILL.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add a `code-review` agent skill</a> or configure MCP servers for context-aware, tailored reviews. <a href="https://docs.github.com/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review?tool=webui#mcp-servers-and-agent-skills" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn more in the docs.</a>

Comment thread content/en/flux/cheatsheets/troubleshooting.md
Comment thread content/en/flux/cheatsheets/troubleshooting.md Outdated
Comment thread content/en/flux/cheatsheets/troubleshooting.md Outdated
Comment thread content/en/flux/cheatsheets/troubleshooting.md Outdated
@RaviTharuma

Copy link
Copy Markdown
Author

@matheuscscp re-review requested: applied your OCI/Alert wording, closed the kubectl fence before the OCI heading, removed the stray fence after the Alert companion, and used --kind=Alert. 27ceea7

Signed-off-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
@RaviTharuma
RaviTharuma force-pushed the docs/operator-gaps-2640-2643-2644 branch from a267321 to e76e44c Compare September 2, 2026 15:09
@RaviTharuma

Copy link
Copy Markdown
Author

@matheuscscp DCO is now signed on both commits (de95800 and e76e44c); the unsigned merge-from-main was dropped. Ready for re-review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants