feat: upgrade migrations chart

[mikolajsobolewski]

Summary by CodeRabbit

• New Features

  • Introduced new options to control how many successful and failed migration jobs are retained.
  • Added support for Helm lifecycle hooks on migration jobs.

• Documentation

  • Updated documentation to reflect the new job retention settings and removal of the previous time-based cleanup option.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update modifies the Helm chart for migration jobs by replacing the time-based job cleanup (ttlSecondsAfterFinished) with count-based retention parameters (successfulJobsHistoryLimit and failedJobsHistoryLimit). It also introduces Helm hook annotations for job lifecycle events, updating the documentation and configuration accordingly.

Changes

File(s)	Change Summary
charts/migrations/README.md	Updated documentation to describe new job history retention parameters and remove TTL description.
charts/migrations/templates/job.yaml	Replaced TTL field with successfulJobsHistoryLimit and failedJobsHistoryLimit in Job spec.
charts/migrations/values.yaml	Removed TTL, added history limits, and introduced Helm hook annotations for migration job.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Helm
    participant Kubernetes

    User->>Helm: Install/Upgrade migration chart
    Helm->>Kubernetes: Create migration Job with history limits and hook annotations
    Kubernetes-->>Helm: Job status updates (success/failure)
    Helm-->>Kubernetes: Retain jobs per history limits (success: 3, failed: 2)

Loading

Possibly related PRs

• fix: annotations #22: Modifies the same Helm hook annotations and job lifecycle parameters, but in the opposite direction.
• feat: add migrations #20: Introduces the original migrations Helm chart with the TTL field, which is now being updated in this PR.

Poem

A chart for migrations, now tidy and neat,
With hooks for the journey, and limits to keep.
No more counting seconds, just jobs in a row—
Successes and failures, we track as we go.
Helm waves its wand, the jobs come and go,
A rabbit approves with a hop and a bow! 🐇✨

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 19eccdf and 22a03f8.

📒 Files selected for processing (3)

• charts/migrations/README.md (1 hunks)
• charts/migrations/templates/job.yaml (1 hunks)
• charts/migrations/values.yaml (2 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.