Skip to content

Update Flux Operator - #681

Merged
Andrei Kvapil (kvaps) merged 1 commit into
cozystack:mainfrom
kingdonb:flux-oper-0.17
Mar 10, 2025
Merged

Update Flux Operator#681
Andrei Kvapil (kvaps) merged 1 commit into
cozystack:mainfrom
kingdonb:flux-oper-0.17

Conversation

@kingdonb

@kingdonb Kingdon Barrett (kingdonb) commented Mar 7, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • New Features

    • Upgraded system components to version 0.17.0.
    • Enabled flexible configuration for container image pull behavior with a new customizable option.
    • Introduced a setting to specify the provider for synchronization authentication, offering multiple backend choices.
  • Documentation

    • Updated version badges and configuration details to reflect the new release and added options.

Signed-off-by: Kingdon B <kingdon@urmanac.com>
@dosubot dosubot Bot added the size/M This PR changes 30-99 lines, ignoring generated files label Mar 7, 2025
@coderabbitai

coderabbitai Bot commented Mar 7, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request upgrades the Flux Operator and Flux Instance Helm charts from version 0.15.0 to 0.17.0. It updates the version fields in the Chart.yaml and README.md files, adds a new imagePullPolicy configuration for managing container image pulls in the flux-operator, and enhances the CRD by introducing a new provider property. In the flux-instance chart, the instance.sync configuration is updated with a new provider key and a corresponding conditional block in the template. Schema files and values files are updated accordingly.

Changes

Files Change Summary
packages/.../fluxcd-operator/charts/flux-operator/{Chart.yaml, README.md, templates/crds.yaml, templates/deployment.yaml, values.schema.json, values.yaml} - Updated appVersion and version to v0.17.0.
- README badge and image configuration now include imagePullPolicy.
- Added provider property in the CRD spec.
- Modified deployment template to use {{ .Values.image.imagePullPolicy }}.
- Updated schema and values with new imagePullPolicy option.
packages/.../fluxcd/charts/flux-instance/{Chart.yaml, README.md, templates/instance.yaml, values.schema.json, values.yaml} - Updated appVersion and version to v0.17.0.
- README modified to add a provider field in the instance.sync object.
- Added a conditional block in the instance template that includes provider when defined.
- Schema and values files updated with a new provider property in the sync configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Helm
    participant DeploymentTemplate
    participant KubernetesAPI
    User->>Helm: Provide values with imagePullPolicy
    Helm->>DeploymentTemplate: Render deployment using {{ .Values.image.imagePullPolicy }}
    DeploymentTemplate-->>Helm: Return rendered deployment manifest
    Helm->>KubernetesAPI: Deploy manifest
Loading
sequenceDiagram
    participant User
    participant Helm
    participant InstanceTemplate
    participant KubernetesAPI
    User->>Helm: Provide instance.sync values (with provider optionally set)
    Helm->>InstanceTemplate: Evaluate conditional for provider field
    alt Provider is defined
        InstanceTemplate-->>Helm: Include provider in manifest
    else Provider is not defined
        InstanceTemplate-->>Helm: Omit provider field
    end
    Helm->>KubernetesAPI: Deploy instance manifest
Loading

Possibly related PRs

Suggested labels

documentation, enhancement, lgtm

Suggested reviewers

  • kvaps

Poem

I'm a bunny in the code garden, hopping through each line,
Version hops from 0.15 to 0.17 with a joyful little sign.
New fields like provider and imagePullPolicy sprout with glee,
Conditional checks and dynamic values make the Helm charts carefree.
With whiskers twitching at this update, my rabbit heart does cheer—
Happy coding, crunchy carrots, and a hop of versioning gear!


📜 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 8267072 and b497394.

📒 Files selected for processing (11)
  • packages/system/fluxcd-operator/charts/flux-operator/Chart.yaml (2 hunks)
  • packages/system/fluxcd-operator/charts/flux-operator/README.md (2 hunks)
  • packages/system/fluxcd-operator/charts/flux-operator/templates/crds.yaml (1 hunks)
  • packages/system/fluxcd-operator/charts/flux-operator/templates/deployment.yaml (1 hunks)
  • packages/system/fluxcd-operator/charts/flux-operator/values.schema.json (1 hunks)
  • packages/system/fluxcd-operator/charts/flux-operator/values.yaml (1 hunks)
  • packages/system/fluxcd/charts/flux-instance/Chart.yaml (2 hunks)
  • packages/system/fluxcd/charts/flux-instance/README.md (2 hunks)
  • packages/system/fluxcd/charts/flux-instance/templates/instance.yaml (1 hunks)
  • packages/system/fluxcd/charts/flux-instance/values.schema.json (1 hunks)
  • packages/system/fluxcd/charts/flux-instance/values.yaml (1 hunks)
🔇 Additional comments (15)
packages/system/fluxcd/charts/flux-instance/values.yaml (1)

48-48: Add new provider field in the sync configuration.
The new provider: "" field is correctly added under instance.sync to support additional synchronization configuration. Ensure that downstream templates and documentation use and explain this field appropriately.

packages/system/fluxcd/charts/flux-instance/values.schema.json (1)

151-153: Add provider property to the sync schema.
The addition of the "provider": { "type": "string" } property in the sync object aligns with the changes in the values file. Confirm that the schema order and required validations remain as intended.

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

11-11: Update appVersion to v0.17.0.
The appVersion is updated from v0.15.0 to v0.17.0, which correctly reflects the upgrade. Verify that all documentation and badges are consistently updated to match this new version.


28-28: Update chart version to 0.17.0.
Updating the version field to 0.17.0 is in line with the upgrade objectives. Ensure consistency with the overall versioning across related charts and release notes.

packages/system/fluxcd-operator/charts/flux-operator/values.yaml (1)

26-26: Add new imagePullPolicy option under image settings.
The introduction of imagePullPolicy: IfNotPresent enhances configuration flexibility for container image pulls. Verify that the enumerated values (IfNotPresent, Always, Never) are properly enforced in schema and referenced in deployment templates and documentation.

packages/system/fluxcd-operator/charts/flux-operator/Chart.yaml (2)

11-11: Update appVersion to v0.17.0.
The update to appVersion reflects the new release of the Flux Operator. Confirm that corresponding documentation, version badges, and integration references are updated accordingly.


28-28: Update chart version to 0.17.0.
The version field update to 0.17.0 properly matches the overall upgrade target. Ensure consistency with release notes and related metadata across the repository.

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

50-52: New Provider Field Integration
The conditional block for the new provider field is correctly added to the sync section. This ensures that if .Values.instance.sync.provider is defined in the values file, it will be output in the rendered YAML. Please double-check that the associated default (an empty string or a valid provider) is properly specified in your values.yaml and documented in the README.

packages/system/fluxcd-operator/charts/flux-operator/templates/deployment.yaml (1)

83-83: Dynamic ImagePullPolicy Configuration
Replacing the hardcoded image pull policy with the dynamic reference ({{ .Values.image.imagePullPolicy }}) enhances flexibility. Verify that the corresponding default in values.yaml (typically "IfNotPresent") is correctly set so that deployments behave consistently in environments that do not explicitly override this value.

packages/system/fluxcd-operator/charts/flux-operator/README.md (2)

3-3: Version Badge Update
The new version badge now correctly indicates version 0.17.0. This visual indicator helps users confirm that they are using the updated release.


42-42: Updated Image Configuration Object Documentation
The image configuration now includes the new imagePullPolicy key with a default value of "IfNotPresent". This update is clearly documented in the table and aligns with the changes in the deployment template and JSON schema.

packages/system/fluxcd-operator/charts/flux-operator/values.schema.json (1)

97-104: Schema Update for Image Pull Policy
The addition of the imagePullPolicy property within the image object—with its enumeration of "IfNotPresent", "Always", and "Never"—ensures that user-provided values adhere to acceptable options. This helps prevent misconfigurations and is a well-implemented validation update in the schema.

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

304-316: CRD Enhancement: New Provider Property
The new provider field in the sync object of the FluxInstance CRD is clearly defined with a meaningful description and an enumeration of allowed values (generic, aws, azure, gcp, github). This update enhances source authentication configuration by explicitly restricting the inputs. Ensure that corresponding documentation (e.g., in the README and values files) is updated to reflect these options.

packages/system/fluxcd/charts/flux-instance/README.md (2)

3-3: Version Badge Updated
The version badge now correctly reflects the new version 0.17.0, which is in line with the release objectives specified in the PR. Please ensure that this change is consistent with any other version references in related documentation.


47-47: Updated Sync Configuration
The instance.sync object in the values table has been updated to include the new provider field, as required. This change aligns with the updated schema and enhances configuration flexibility for Flux instances. Please verify that the documentation link (https://fluxcd.control-plane.io/operator/fluxinstance/#sync-configuration) reflects this change if necessary.


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 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 kind/documentation Categorizes issue or PR as related to documentation label Mar 7, 2025

@kvaps Andrei Kvapil (kvaps) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

@kvaps
Andrei Kvapil (kvaps) merged commit e836b62 into cozystack:main Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation 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