CNTRLPLANE-2786: Extend controller architecture diagram with consumes relationship

[hypershift-jira-solve-ci]

What this PR does / why we need it:

The Mermaid diagram in controller-architecture.md lacked an explanation of how resources are consumed (read as input) versus actively reconciled. This made the architecture diagram incomplete for readers trying to understand the full picture of controller interactions.

Changes:

• Add legend entries distinguishing reconciles, creates, operates, and consumes relationship types
• Add a dotted "consumes" arrow from CAPI Provider to CAPIInfrastructureMachineTemplate, showing that the provider reads machine templates created by the HyperShift Operator without actively watching or reconciling them
• Remove the TODO comment that requested this clarification
• Regenerate aggregated docs

Which issue(s) this PR fixes:

Fixes https://redhat.atlassian.net/browse/CNTRLPLANE-2786

Special notes for your reviewer:

This is a documentation-only change to the Mermaid architecture diagram. No code changes.

Checklist:

• Subject and description added to both, commit and PR.
• Relevant issues have been referenced.
• This change includes docs.
• This change includes unit tests.

Always review AI generated responses prior to use.
Generated with Claude Code via /jira:solve [CNTRLPLANE-2786](https://redhat.atlassian.net/browse/CNTRLPLANE-2786)

---

Note: This PR was auto-generated by the jira-agent periodic CI job in response to CNTRLPLANE-2786. See the full report for token usage, cost breakdown, and detailed phase output.

Summary by CodeRabbit

• Documentation
  • Enhanced controller architecture documentation with clarified diagram legend entries defining relationship semantics
  • Updated resource dependency flowchart to illustrate consumption relationships between components

[hypershift-jira-solve-ci]

/auto-cc

[openshift-ci-robot]

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

[openshift-ci-robot]

@hypershift-jira-solve-ci[bot]: This pull request references CNTRLPLANE-2786 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

What this PR does / why we need it:

The Mermaid diagram in controller-architecture.md lacked an explanation of how resources are consumed (read as input) versus actively reconciled. This made the architecture diagram incomplete for readers trying to understand the full picture of controller interactions.

Changes:

• Add legend entries distinguishing reconciles, creates, operates, and consumes relationship types
• Add a dotted "consumes" arrow from CAPI Provider to CAPIInfrastructureMachineTemplate, showing that the provider reads machine templates created by the HyperShift Operator without actively watching or reconciling them
• Remove the TODO comment that requested this clarification
• Regenerate aggregated docs

Which issue(s) this PR fixes:

Fixes https://redhat.atlassian.net/browse/CNTRLPLANE-2786

Special notes for your reviewer:

This is a documentation-only change to the Mermaid architecture diagram. No code changes.

Checklist:

• Subject and description added to both, commit and PR.
• Relevant issues have been referenced.
• This change includes docs.
• This change includes unit tests.

Always review AI generated responses prior to use.
Generated with Claude Code via /jira:solve [CNTRLPLANE-2786](https://redhat.atlassian.net/browse/CNTRLPLANE-2786)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 9bb62b07-e52b-489f-b406-d0a3c1aac2df

📥 Commits

Reviewing files that changed from the base of the PR and between b17cf16 and 3d3a46a.

⛔ Files ignored due to path filters (1)

• docs/content/reference/aggregated-docs.md is excluded by !docs/content/reference/aggregated-docs.md

📒 Files selected for processing (1)

• docs/content/reference/controller-architecture.md

---

📝 Walkthrough

Walkthrough

The documentation file defining controller architecture diagrams has been updated to enhance clarity around relationship semantics. Four legend entries were added to explicitly define arrow types used in the diagrams. A new dotted consumes relationship type was introduced to represent resources used as inputs or lookups, distinct from resources that trigger reconciliation. The resource dependency flowchart was modified to include a consumes edge from capi-provider to capi-machine-template. A preceding TODO comment expressing uncertainty about representing such input relationships was removed.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[openshift-ci-robot]

@hypershift-jira-solve-ci[bot]: This pull request references CNTRLPLANE-2786 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

What this PR does / why we need it:

The Mermaid diagram in controller-architecture.md lacked an explanation of how resources are consumed (read as input) versus actively reconciled. This made the architecture diagram incomplete for readers trying to understand the full picture of controller interactions.

Changes:

• Add legend entries distinguishing reconciles, creates, operates, and consumes relationship types
• Add a dotted "consumes" arrow from CAPI Provider to CAPIInfrastructureMachineTemplate, showing that the provider reads machine templates created by the HyperShift Operator without actively watching or reconciling them
• Remove the TODO comment that requested this clarification
• Regenerate aggregated docs

Which issue(s) this PR fixes:

Fixes https://redhat.atlassian.net/browse/CNTRLPLANE-2786

Special notes for your reviewer:

This is a documentation-only change to the Mermaid architecture diagram. No code changes.

Checklist:

• Subject and description added to both, commit and PR.
• Relevant issues have been referenced.
• This change includes docs.
• This change includes unit tests.

Always review AI generated responses prior to use.
Generated with Claude Code via /jira:solve [CNTRLPLANE-2786](https://redhat.atlassian.net/browse/CNTRLPLANE-2786)

---

Note: This PR was auto-generated by the jira-agent periodic CI job in response to CNTRLPLANE-2786. See the full report for token usage, cost breakdown, and detailed phase output.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@hypershift-jira-solve-ci[bot]: This pull request references CNTRLPLANE-2786 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

What this PR does / why we need it:

The Mermaid diagram in controller-architecture.md lacked an explanation of how resources are consumed (read as input) versus actively reconciled. This made the architecture diagram incomplete for readers trying to understand the full picture of controller interactions.

Changes:

• Add legend entries distinguishing reconciles, creates, operates, and consumes relationship types
• Add a dotted "consumes" arrow from CAPI Provider to CAPIInfrastructureMachineTemplate, showing that the provider reads machine templates created by the HyperShift Operator without actively watching or reconciling them
• Remove the TODO comment that requested this clarification
• Regenerate aggregated docs

Which issue(s) this PR fixes:

Fixes https://redhat.atlassian.net/browse/CNTRLPLANE-2786

Special notes for your reviewer:

This is a documentation-only change to the Mermaid architecture diagram. No code changes.

Checklist:

• Subject and description added to both, commit and PR.
• Relevant issues have been referenced.
• This change includes docs.
• This change includes unit tests.

Always review AI generated responses prior to use.
Generated with Claude Code via /jira:solve [CNTRLPLANE-2786](https://redhat.atlassian.net/browse/CNTRLPLANE-2786)

---

Note: This PR was auto-generated by the jira-agent periodic CI job in response to CNTRLPLANE-2786. See the full report for token usage, cost breakdown, and detailed phase output.

Summary by CodeRabbit

• Documentation
• Enhanced controller architecture documentation with clarified diagram legend entries defining relationship semantics
• Updated resource dependency flowchart to illustrate consumption relationships between components

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[bryan-cox]

/approve

[openshift-ci-robot]

Scheduling required tests:
/test e2e-aks-cilium

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bryan-cox, hypershift-jira-solve-ci[bot]

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [bryan-cox]

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

[bryan-cox]

/lgtm cancel

[bryan-cox]

/verify bypass

docs only change

[bryan-cox]

/verified bypass

[openshift-ci-robot]

@bryan-cox: The verified label has been added.

Details

In response to this:

/verified bypass

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[enxebre]

/lgtm

[openshift-ci-robot]

Pipeline controller notification

No second-stage tests were triggered for this PR.

This can happen when:

• The changed files don't match any pipeline_run_if_changed patterns
• All files match pipeline_skip_if_only_changed patterns
• No pipeline-controlled jobs are defined for the main branch

Use /test ? to see all available tests.

[openshift-ci]

@hypershift-jira-solve-ci: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.