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

Revert kamaji edge-24.12.1 #610

Merged
merged 1 commit into from
Jan 29, 2025
Merged

Revert kamaji edge-24.12.1 #610

merged 1 commit into from
Jan 29, 2025

Conversation

kvaps
Copy link
Member

@kvaps kvaps commented Jan 29, 2025

Due to upstream issue: clastix/kamaji#679

Summary by CodeRabbit

  • New Features

    • Updated Kamaji application version to v1.0.0
    • Modified dependency version constraints for kamaji-etcd
  • Documentation

    • Updated README with new version information
    • Clarified configuration descriptions for DataStore and network profiles
  • Chores

    • Updated Chart version to 2.0.0
    • Simplified configuration management in deployment templates
    • Updated Dockerfile to use a different source code version

Signed-off-by: Andrei Kvapil <[email protected]>
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jan 29, 2025
Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

This pull request introduces significant updates to the Kamaji project's configuration and documentation. The changes primarily focus on version updates across multiple files, including Chart.yaml, README.md, and Dockerfile. The modifications involve updating application and chart versions, adjusting dependency version constraints, and clarifying configuration descriptions. The changes streamline the configuration options for DataStores and network profiles, and enforce stricter requirements for deployment configuration.

Changes

File Change Summary
charts/kamaji/Chart.yaml - Updated appVersion from v0.0.0 to v1.0.0
- Updated version from 0.0.0 to 2.0.0
- Modified kamaji-etcd dependency version constraint from ">=0.8.1" to ">=0.7.0"
charts/kamaji/README.md - Updated version badge from 0.0.0 to 2.0.0
- Updated application version from v0.0.0 to v1.0.0
- Modified kamaji-etcd dependency version constraint
charts/kamaji/crds/kamaji.clastix.io_tenantcontrolplanes.yaml - Updated dataStore field description
- Removed dataStoreSchema field
- Refined descriptions for network profile fields
charts/kamaji/templates/controller.yaml - Modified --datastore argument handling using required function
charts/kamaji/values.yaml - Updated comment for defaultDatastoreName
images/kamaji/Dockerfile - Changed VERSION from edge-24.12.1 to edge-24.9.2

Possibly related PRs

Suggested Labels

lgtm, documentation

Poem

🐰 Hop, hop, version's new dance!
Kamaji charts take a brave stance
DataStores refined with care
Network profiles now more fair
Version numbers leap and prance! 🚀


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.

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
packages/system/kamaji/charts/kamaji/README.md (1)

25-25: Consider using formatted link for URL.

Replace the bare URL with a formatted Markdown link.

-| https://clastix.github.io/charts | kamaji-etcd | >=0.7.0 |
+| [https://clastix.github.io/charts](https://clastix.github.io/charts) | kamaji-etcd | >=0.7.0 |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

25-25: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0ab39f2 and 1c0f8eb.

⛔ Files ignored due to path filters (1)
  • packages/system/kamaji/charts/kamaji/Chart.lock is excluded by !**/*.lock
📒 Files selected for processing (6)
  • packages/system/kamaji/charts/kamaji/Chart.yaml (2 hunks)
  • packages/system/kamaji/charts/kamaji/README.md (3 hunks)
  • packages/system/kamaji/charts/kamaji/crds/kamaji.clastix.io_tenantcontrolplanes.yaml (4 hunks)
  • packages/system/kamaji/charts/kamaji/templates/controller.yaml (1 hunks)
  • packages/system/kamaji/charts/kamaji/values.yaml (1 hunks)
  • packages/system/kamaji/images/kamaji/Dockerfile (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/system/kamaji/charts/kamaji/values.yaml
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
packages/system/kamaji/charts/kamaji/README.md

25-25: Bare URL used
null

(MD034, no-bare-urls)

🔇 Additional comments (7)
packages/system/kamaji/charts/kamaji/crds/kamaji.clastix.io_tenantcontrolplanes.yaml (2)

6416-6418: LGTM! Clear documentation improvement for the dataStore field.

The updated description provides better clarity about:

  • The optional nature of the field
  • Its purpose as an override for the default DataStore
  • Important warning about migration limitations

6543-6544: Verify the default CIDR values align with Kubernetes best practices.

The default values for network CIDRs need verification:

  • dnsServiceIPs: 10.96.0.10
  • podCidr: 10.244.0.0/16
  • serviceCidr: 10.96.0.0/16

Also applies to: 6550-6550, 6558-6559

✅ Verification successful

Default CIDR values are correctly aligned with Kubernetes best practices

The specified CIDR values match the standard Kubernetes defaults and follow networking best practices:

  • Service CIDR (10.96.0.0/16) matches kubeadm's default
  • Pod CIDR (10.244.0.0/16) is the common default for CNI plugins
  • DNS Service IP (10.96.0.10) is appropriately positioned within the service CIDR range
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the CIDR values align with Kubernetes documentation and common practices

# Search for any existing CIDR configurations in the codebase
echo "Searching for existing CIDR configurations..."
rg --type yaml "podCIDR|serviceCIDR|clusterCIDR" -A 2 -B 2

# Search for any documentation about CIDR ranges
echo "Searching for CIDR documentation..."
fd -t f "README.md" -X grep -l "CIDR"

Length of output: 3320

packages/system/kamaji/charts/kamaji/templates/controller.yaml (1)

36-37: Breaking change: Verify the impact of making defaultDatastoreName required.

While using the required function improves robustness by ensuring the datastore is explicitly configured, this is a breaking change that could affect existing deployments that don't specify .Values.defaultDatastoreName. Since this is part of a revert PR, please clarify:

  1. What issues led to this revert?
  2. How should users handle the migration?
  3. Should this be documented in the upgrade notes?

Let's check for potential impact on existing deployments:

✅ Verification successful

Not a breaking change: defaultDatastoreName has a default value

The change to make .Values.defaultDatastoreName required is safe because:

  1. The values.yaml provides a default value: defaultDatastoreName: default
  2. The kamaji-etcd subchart is pre-configured to use this default value
  3. The required function only triggers if someone explicitly nullifies or removes the value

The change actually improves robustness by preventing accidental nullification while maintaining backward compatibility through the default value.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for Helm value files or examples that might be affected
echo "Searching for Helm value files..."
fd -e yaml -e yml | while read -r file; do
  if grep -l "defaultDatastoreName" "$file" > /dev/null; then
    echo "Found in $file:"
    grep -A 5 "defaultDatastoreName" "$file"
  fi
done

Length of output: 65572


Script:

#!/bin/bash
# Search for defaultDatastoreName in kamaji-related files and show content
echo "=== Checking values.yaml in kamaji chart ==="
if [ -f "packages/system/kamaji/charts/kamaji/values.yaml" ]; then
    echo "Content of values.yaml:"
    cat "packages/system/kamaji/charts/kamaji/values.yaml"
fi

echo -e "\n=== Checking for example configurations ==="
find . -type f -name "*.yaml" -o -name "*.md" | while read -r file; do
    if grep -l "defaultDatastoreName" "$file" > /dev/null; then
        echo -e "\nFile: $file"
        grep -A 5 -B 5 "defaultDatastoreName" "$file"
    fi
done

Length of output: 68691

packages/system/kamaji/images/kamaji/Dockerfile (2)

4-4: Version downgrade aligns with revert intention.

The VERSION downgrade from edge-24.12.1 to edge-24.9.2 matches the PR's revert purpose.


1-1: ⚠️ Potential issue

Invalid Go version specified.

The base image golang:1.23 doesn't exist. The latest stable version is 1.21.

Apply this diff to fix the Go version:

-FROM golang:1.23 as builder
+FROM golang:1.21 as builder

Likely invalid or redundant comment.

packages/system/kamaji/charts/kamaji/Chart.yaml (1)

2-2: Version changes inconsistent with revert PR.

The version upgrades (appVersion to v1.0.0, version to 2.0.0, and relaxed etcd dependency) seem inconsistent with the PR's intention to revert "kamaji edge-24.12.1". Please verify if these version changes should also be reverted.

Let's verify the previous versions:

Also applies to: 20-20, 24-24

packages/system/kamaji/charts/kamaji/README.md (1)

3-3: Version badges inconsistent with revert PR.

The version badges (Version: 2.0.0, AppVersion: v1.0.0) match Chart.yaml but seem inconsistent with the PR's intention to revert "kamaji edge-24.12.1". Please verify if these should also be reverted.

@kvaps kvaps merged commit d6e9765 into main Jan 29, 2025
0 of 2 checks passed
@kvaps kvaps deleted the revert-kamaji branch January 29, 2025 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant