Skip to content

refactor: improve Helm file structure#9

Merged
linoyaslan merged 1 commit intorh-ecosystem-edge:mainfrom
linoyaslan:helm_refactoring
Jan 22, 2026
Merged

refactor: improve Helm file structure#9
linoyaslan merged 1 commit intorh-ecosystem-edge:mainfrom
linoyaslan:helm_refactoring

Conversation

@linoyaslan
Copy link
Copy Markdown
Collaborator

@linoyaslan linoyaslan commented Jan 22, 2026

Summary by CodeRabbit

  • Documentation

    • Expanded and reorganized the README with clearer installation, configuration, usage, and troubleshooting guides.
    • Added new chart structure documentation.
    • Removed legacy deployment/chart summary, changelog, and quick-install docs to consolidate guidance.
  • Chores / Configuration

    • Chart version set to 0.1.0 and maintainer contact removed.
    • Image pull policy changed to Always.
    • Service account naming now auto-generated from the release name; chart no longer auto-creates a Namespace.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 22, 2026

Caution

Review failed

The pull request is closed.

Walkthrough

Removed multiple Helm documentation artifacts, deleted the Namespace template, updated chart metadata and defaults, and expanded/reorganized the chart README plus added STRUCTURE.md; values.yaml pullPolicy and serviceAccount.name were adjusted.

Changes

Cohort / File(s) Summary
Documentation removals
helm/DEPLOYMENT_SUMMARY.md, helm/HELM_CHART_SUMMARY.md, helm/dpf-hcp-bridge-operator/CHANGELOG.md, helm/dpf-hcp-bridge-operator/INSTALL.md
Deleted comprehensive deployment, chart summary, changelog, and install docs.
README overhaul
helm/dpf-hcp-bridge-operator/README.md
Large rewrite: OCI-based install/examples, new placement.target model, expanded Configuration, BlueField image mappings, Usage, Troubleshooting, Development, Upgrade/Uninstall sections; many examples converted to OCI references.
New structure doc
helm/dpf-hcp-bridge-operator/STRUCTURE.md
Added chart layout, templates/CRD explanation, naming conventions, rendering guidance, and resource summaries.
Chart metadata
helm/dpf-hcp-bridge-operator/Chart.yaml
Version changed from 0.1.1 → 0.1.0 and maintainer email removed.
Values changes
helm/dpf-hcp-bridge-operator/values.yaml
image.pullPolicy set to Always; serviceAccount.name changed from fixed name to "" (auto-generated from release); removed namespaceLabels block.
Template removal
helm/dpf-hcp-bridge-operator/templates/namespace.yaml
Deleted Namespace manifest (namespace creation via chart templates removed).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'refactor: improve Helm file structure' is vague and overly broad, using non-specific language that doesn't clearly convey what specific structural improvements were made to the Helm files. Consider a more specific title that describes the actual changes, such as 'refactor: consolidate Helm documentation and update chart version' or 'refactor: reorganize Helm chart documentation and versioning'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@helm/dpf-hcp-bridge-operator/README.md`:
- Around line 612-617: The README entry under the "values-production.yaml"
section incorrectly states "Higher resource limits (200m CPU, 256Mi memory)";
update that text to state the actual production resource limits are "1000m CPU
limit and 1Gi memory limit" and clarify that the 200m CPU and 256Mi memory
values are the resource requests, matching STRUCTURE.md and
values-production.yaml.
🧹 Nitpick comments (2)
helm/dpf-hcp-bridge-operator/STRUCTURE.md (1)

7-33: Add language identifier to fenced code block.

The directory tree code block is missing a language identifier. While this is a minor documentation nit, adding text or plaintext improves consistency and satisfies linting rules.

📝 Suggested fix
-```
+```text
 helm/dpf-hcp-bridge-operator/
 ├── Chart.yaml                      # Chart metadata
helm/dpf-hcp-bridge-operator/README.md (1)

52-55: Add language identifier to expected output code block.

The expected output code block is missing a language identifier. Adding text or plaintext improves consistency with linting rules.

📝 Suggested fix
 Expected output:
-```
+```text
 NAME                                           READY   STATUS    RESTARTS   AGE
 dpf-hcp-bridge-operator-xxxxxxxxxx-xxxxx       1/1     Running   0          30s
</details>

</blockquote></details>

</blockquote></details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Comment on lines +612 to +617
**values-production.yaml**:
- Image tag: `v0.1.0` (specific version)
- Pull policy: `IfNotPresent`
- Log level: `info`
- Higher resource limits (200m CPU, 256Mi memory)
- 2 replicas with zone anti-affinity
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

fd -t f "values-production.yaml" helm/dpf-hcp-bridge-operator/ --exec cat {}

Repository: rh-ecosystem-edge/dpf-hcp-bridge-operator

Length of output: 2690


🏁 Script executed:

fd -t f "STRUCTURE.md" helm/dpf-hcp-bridge-operator/ --exec sed -n '110,120p' {}

Repository: rh-ecosystem-edge/dpf-hcp-bridge-operator

Length of output: 536


🏁 Script executed:

fd -t f "README.md" helm/dpf-hcp-bridge-operator/ --exec sed -n '612,617p' {}

Repository: rh-ecosystem-edge/dpf-hcp-bridge-operator

Length of output: 290


Update production resource limit values in the README.

The README states "Higher resource limits (200m CPU, 256Mi memory)" but these are actually the request values. The actual production resource limits are 1000m CPU and 1Gi memory, as documented in STRUCTURE.md and the values-production.yaml file. Update lines 612-617 to accurately reflect the limits: 1000m CPU limit and 1Gi memory limit.

🤖 Prompt for AI Agents
In `@helm/dpf-hcp-bridge-operator/README.md` around lines 612 - 617, The README
entry under the "values-production.yaml" section incorrectly states "Higher
resource limits (200m CPU, 256Mi memory)"; update that text to state the actual
production resource limits are "1000m CPU limit and 1Gi memory limit" and
clarify that the 200m CPU and 256Mi memory values are the resource requests,
matching STRUCTURE.md and values-production.yaml.

@linoyaslan linoyaslan merged commit f520d8c into rh-ecosystem-edge:main Jan 22, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant