Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Flux Operator #567

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Update Flux Operator #567

merged 1 commit into from
Jan 9, 2025

Conversation

kingdonb
Copy link
Contributor

@kingdonb kingdonb commented Jan 9, 2025

See Releases for details

Summary by CodeRabbit

  • New Features

    • Enhanced Flux Operator CustomResourceDefinition (CRD) with new metadata handling capabilities
    • Added support for common metadata annotations and labels
    • Introduced new resource naming and artifact revision tracking
  • Version Updates

    • Flux Operator upgraded from v0.10.0 to v0.12.0
    • Flux Instance chart updated from v0.9.0 to v0.12.0

Signed-off-by: Kingdon B <kingdon@urmanac.com>
@kingdonb kingdonb requested a review from kvaps as a code owner January 9, 2025 13:53
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jan 9, 2025
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

This pull request involves version updates for the Flux Operator and Flux Instance Helm charts, upgrading from versions 0.10.0/0.9.0 to 0.12.0. The changes include updating version and app version fields in Chart.yaml and README.md files for both charts. Additionally, the CustomResourceDefinition (CRD) for the Flux Operator has been enhanced with new properties like commonMetadata, name in the sync section, and a new lastArtifactRevision status field.

Changes

File Change Summary
packages/system/fluxcd-operator/charts/flux-operator/Chart.yaml Updated appVersion and version from 0.10.0 to 0.12.0
packages/system/fluxcd-operator/charts/flux-operator/README.md Updated version badges from 0.10.0 to 0.12.0
packages/system/fluxcd-operator/charts/flux-operator/templates/crds.yaml Added new properties:
- commonMetadata in spec
- name in sync section
- lastArtifactRevision in status
packages/system/fluxcd/charts/flux-instance/Chart.yaml Updated appVersion and version from 0.9.0 to 0.12.0
packages/system/fluxcd/charts/flux-instance/README.md Updated version badges from 0.9.0 to 0.12.0

Possibly Related PRs

Suggested Labels

enhancement, size:L

Poem

🐰 Flux charts dancing with glee,
Version bumps from 0.9 to 0.12, you see!
CRDs bloom with metadata's might,
Sync and status now shining bright,
A rabbit's update, precise and free! 🚀


📜 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 38a993b and ae50c68.

📒 Files selected for processing (5)
  • packages/system/fluxcd-operator/charts/flux-operator/Chart.yaml (2 hunks)
  • packages/system/fluxcd-operator/charts/flux-operator/README.md (1 hunks)
  • packages/system/fluxcd-operator/charts/flux-operator/templates/crds.yaml (3 hunks)
  • packages/system/fluxcd/charts/flux-instance/Chart.yaml (2 hunks)
  • packages/system/fluxcd/charts/flux-instance/README.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • packages/system/fluxcd/charts/flux-instance/README.md
  • packages/system/fluxcd-operator/charts/flux-operator/README.md
🔇 Additional comments (6)
packages/system/fluxcd-operator/charts/flux-operator/Chart.yaml (1)

11-11: Version updates look good!

The version updates are consistent, updating both appVersion and version fields to 0.12.0.

Also applies to: 28-28

packages/system/fluxcd/charts/flux-instance/Chart.yaml (1)

11-11: Version updates look good!

The version updates are consistent with the flux-operator chart, updating both appVersion and version fields to 0.12.0.

Also applies to: 28-28

packages/system/fluxcd-operator/charts/flux-operator/templates/crds.yaml (4)

102-118: LGTM! Well-structured commonMetadata property.

The new commonMetadata property follows Kubernetes patterns and provides a clean way to apply common labels and annotations across resources.


285-293: LGTM! Well-defined name property with proper validations.

The new name property in the sync section includes:

  • Clear description with fallback behavior
  • Appropriate max length constraint
  • Important immutability validation

451-455: LGTM! Clear status field addition.

The new lastArtifactRevision status field is well-documented and appropriately placed in the status section.


Line range hint 102-455: Verify impact on existing FluxInstance resources.

The CRD changes add new optional fields that shouldn't break existing resources. However, let's verify if there are any existing FluxInstance resources that might need updates.

✅ Verification successful

CRD changes are backward compatible

The new fields commonMetadata and lastArtifactRevision are optional and don't impact existing FluxInstance resources. No migration is required as existing resources will continue to work without modification.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for existing FluxInstance resources that might be affected

# Search for existing FluxInstance resources in the codebase
rg -l "kind:\s+FluxInstance" 

# Search for any existing usage of the new fields
rg "commonMetadata:|lastArtifactRevision:"

Length of output: 428


Script:

#!/bin/bash
# Check the content of the instance template
cat packages/system/fluxcd/charts/flux-instance/templates/instance.yaml

# Verify if the new fields are marked as required in the CRD
rg -A 5 "required:" packages/system/fluxcd-operator/charts/flux-operator/templates/crds.yaml

Length of output: 4914

Finishing Touches

  • 📝 Generate Docstrings

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
  • @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.

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Jan 9, 2025
Copy link
Member

@kvaps kvaps left a comment

Choose a reason for hiding this comment

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

Thank you @kingdonb, LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 9, 2025
@kvaps kvaps merged commit c3d55e2 into aenix-io:main Jan 9, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants