Skip to content

[platform] fix deleting bundles - #809

Merged
klinch0 merged 1 commit into
mainfrom
(platform)--fix-deleting-bundles
Apr 14, 2025
Merged

klinch0 merged 1 commit into
mainfrom
(platform)--fix-deleting-bundles

Conversation

@klinch0

@klinch0 klinch0 commented Apr 14, 2025 •

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • New Features
    • Enhanced the container image with an additional YAML processing tool for improved configuration management.
    • Introduced new workflow commands that streamline deployment operations by reconciling resource changes and automating cleanup.
    • Enabled management of disabled components by automatically suspending and flagging inactive deployments for optimized system performance.

@coderabbitai

coderabbitai Bot commented Apr 14, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

The pull request introduces new steps to enhance deployment and resource management. In the Dockerfile, a command to install the yq tool is added without modifying existing steps. The Makefile is updated by enhancing the apply target with filtering, and by adding new delete and reconcile targets to manage HelmReleases. The HelmRelease YAML template now defines resources for disabled components with deletion and suspension annotations. Finally, the installer script is adjusted to invoke the new reconcile command instead of the former apply command.

Changes

File(s) Change Summary
packages/.../Dockerfile Added command to install the yq tool after helm and kubectl installation.
packages/.../Makefile Modified apply target with echo and filtering logic; added new delete and reconcile targets using yq for HelmRelease management.
packages/.../helmreleases.yaml Introduced a new template section that iterates over disabled components, creating HelmRelease resources with deletion annotations and suspension enabled.
scripts/installer.sh Replaced apply command with the reconcile command to manage Helm chart deployment.

Sequence Diagram(s)

sequenceDiagram
    participant S as Installer Script
    participant R as Reconcile (Makefile)
    participant A as Apply Target
    participant D as Delete Target
    S->>R: Run "make -C packages/core/platform reconcile"
    R->>A: Execute "apply" target (filter via yq)
    A-->>R: Return filtered HelmReleases
    R->>D: Execute "delete" target (remove marked releases)
    D-->>R: Return deletion results
    R-->>S: Complete reconciliation
Loading

Poem

I'm a happy bunny, hopping through the code,
New commands and tools lighten my humble abode.
With yq in play and targets that do mix,
Applying and deleting in clever new tricks.
I hop, I skip—today's changes are my delight!
(_/) 🥕

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@klinch0
klinch0 force-pushed the (platform)--fix-deleting-bundles branch from bb10773 to f90fc6f Compare April 14, 2025 10:22

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
packages/core/installer/images/cozystack/Dockerfile (1)

33-33: Added yq Installation Command
The new command installs the yq tool, which is essential for the new YAML filtering steps in the platform Makefile. To ensure consistent behavior across environments, consider pinning a specific version of yq if determinism is important.

packages/core/platform/Makefile (2)

10-14: Enhanced Apply Target with Filtering
The updated apply target now echoes a debug message and pipes the Helm templated output through yq to filter out resources marked for deletion. This approach is clear and practical. Just ensure that the filter expression reliably distinguishes resources you intend to manage.


15-20: New Delete Target Implementation
The delete target uses a similar pattern to identify and delete HelmReleases that have the annotation cozystack.io/marked-for-deletion set to "true". The inclusion of --ignore-not-found=true helps avoid errors if no resources match. Consider adding some logging or error handling if deletion fails unexpectedly.

packages/core/platform/templates/helmreleases.yaml (1)

83-101: New HelmRelease Resources for Disabled Components
This added section dynamically creates a HelmRelease for each disabled component by iterating over $disabledComponents. It correctly sets the annotation cozystack.io/marked-for-deletion: "true" and labels the resource appropriately, which integrates seamlessly with the Makefile's filtering logic.
A couple of points to consider:

  • Verify that the lookup for the namespace via index $dependencyNamespaces $name | default "cozy-system" always returns the desired value.
  • Adding an inline comment in the template explaining the purpose of this block could improve future maintainability.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8f3f2d and f90fc6f.

📒 Files selected for processing (4)
  • packages/core/installer/images/cozystack/Dockerfile (1 hunks)
  • packages/core/platform/Makefile (1 hunks)
  • packages/core/platform/templates/helmreleases.yaml (1 hunks)
  • scripts/installer.sh (2 hunks)
🔇 Additional comments (3)
scripts/installer.sh (2)

73-73: Replaced 'apply' with 'reconcile' for Platform Chart Installation
The command has been updated to use make -C packages/core/platform reconcile, ensuring that the deletion of marked HelmReleases is handled alongside applying active ones. This aligns well with the updated Makefile logic.


96-96: Reconcile Invocation in Continuous Loop
In the reconciliation loop, using make -C packages/core/platform reconcile instead of apply ensures both applying new changes and processing deletions. Please verify under load that the continuous reconciliation does not overwhelm the Kubernetes API.

packages/core/platform/Makefile (1)

21-21: Consolidated Reconcile Target
By combining the apply and delete targets into reconcile, the Makefile now provides a single command that both applies active changes and cleans up outdated/deleted resources. This consolidation simplifies resource management.

@klinch0
klinch0 merged commit 6a0d491 into main Apr 14, 2025
@klinch0
klinch0 deleted the (platform)--fix-deleting-bundles branch April 14, 2025 11:28
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.

3 participants