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

chore: bump operator version #173

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

zyy17
Copy link
Collaborator

@zyy17 zyy17 commented Oct 18, 2024

Summary by CodeRabbit

  • New Features

    • Updated version numbers for both greptimedb-cluster and greptimedb-operator Helm charts.
    • Enhanced resource management capabilities in the GreptimeDBCluster Custom Resource Definition (CRD).
  • Bug Fixes

    • Corrected naming inconsistencies in configuration fields for monitoring vector resources.
  • Documentation

    • Updated README files to reflect new version numbers and changes in configuration.

@zyy17 zyy17 requested a review from daviderli614 October 18, 2024 04:43
Copy link
Contributor

coderabbitai bot commented Oct 18, 2024

Walkthrough

This pull request includes updates to the Chart.yaml, README.md, cluster.yaml, and values.yaml files for both the greptimedb-cluster and greptimedb-operator Helm charts. Key changes involve incrementing version numbers, updating image tags, and renaming configuration fields for consistency. Specifically, the resource field has been renamed to resources in several files to enhance clarity and standardization.

Changes

File Path Change Summary
charts/greptimedb-cluster/Chart.yaml Version updated: 0.2.180.2.19
charts/greptimedb-cluster/README.md Version badge updated: 0.2.180.2.19, Initializer image tag updated: v0.1.1v0.1.2, Key renamed: resourceresources
charts/greptimedb-cluster/templates/cluster.yaml Field renamed: resourceresources in monitoring.vector
charts/greptimedb-cluster/values.yaml Initializer image tag updated: v0.1.1v0.1.2, Key renamed: resourceresources
charts/greptimedb-operator/Chart.yaml appVersion updated: 0.1.10.1.2, Version updated: 0.2.60.2.7
charts/greptimedb-operator/README.md Version updated: 0.2.60.2.7, appVersion updated: 0.1.10.1.2
charts/greptimedb-operator/templates/crds/crd-greptimedbcluster.yaml Field renamed: resourceresources in vector, New field resources added with properties claims, limits, requests

Possibly related PRs

Suggested reviewers

  • daviderli614

🐰 In the meadow, changes bloom,
Versions rise, dispelling gloom.
Resources shift to clearer names,
Helm charts dance in update games.
With each tag, we hop along,
Celebrating progress, bright and strong! 🌼


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 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: 1

🧹 Outside diff range and nitpick comments (2)
charts/greptimedb-cluster/values.yaml (1)

Line range hint 1-638: Overall LGTM. Consider updating related documentation.

The changes in this file are minor but improve consistency and potentially fix issues:

  1. The initializer image tag has been updated to v0.1.2.
  2. The resource key in the vector configuration has been renamed to resources and its indentation corrected.

Consider updating any related documentation or README files to reflect these changes, especially the new initializer version and the corrected resource configuration structure.

charts/greptimedb-operator/templates/crds/crd-greptimedbcluster.yaml (1)

Line range hint 17119-17150: Fix indentation for better readability

There's a minor indentation issue with the resources field. It appears to be indented one space too far compared to its sibling properties. To maintain consistency and improve readability, please adjust the indentation as follows:

      vector:
        properties:
          image:
            type: string
-         resources:
-           properties:
-             claims:
-               items:
-                 properties:
-                   name:
-                     type: string
-                 required:
-                   - name
-                 type: object
-               type: array
-               x-kubernetes-list-map-keys:
-                 - name
-               x-kubernetes-list-type: map
-             limits:
-               additionalProperties:
-                 anyOf:
-                   - type: integer
-                   - type: string
-                 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
-                 x-kubernetes-int-or-string: true
-               type: object
-             requests:
-               additionalProperties:
-                 anyOf:
-                   - type: integer
-                   - type: string
-                 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
-                 x-kubernetes-int-or-string: true
-               type: object
-           type: object
+        resources:
+          properties:
+            claims:
+              items:
+                properties:
+                  name:
+                    type: string
+                required:
+                  - name
+                type: object
+              type: array
+              x-kubernetes-list-map-keys:
+                - name
+              x-kubernetes-list-type: map
+            limits:
+              additionalProperties:
+                anyOf:
+                  - type: integer
+                  - type: string
+                pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                x-kubernetes-int-or-string: true
+              type: object
+            requests:
+              additionalProperties:
+                anyOf:
+                  - type: integer
+                  - type: string
+                pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                x-kubernetes-int-or-string: true
+              type: object
+          type: object
        type: object

This adjustment will align the resources field with its sibling image property, maintaining consistent indentation throughout the file.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b5c7f0f and 409c6bd.

📒 Files selected for processing (7)
  • charts/greptimedb-cluster/Chart.yaml (1 hunks)
  • charts/greptimedb-cluster/README.md (3 hunks)
  • charts/greptimedb-cluster/templates/cluster.yaml (1 hunks)
  • charts/greptimedb-cluster/values.yaml (2 hunks)
  • charts/greptimedb-operator/Chart.yaml (1 hunks)
  • charts/greptimedb-operator/README.md (1 hunks)
  • charts/greptimedb-operator/templates/crds/crd-greptimedbcluster.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • charts/greptimedb-cluster/Chart.yaml
  • charts/greptimedb-operator/Chart.yaml
  • charts/greptimedb-operator/README.md
🧰 Additional context used
🪛 LanguageTool
charts/greptimedb-cluster/README.md

[uncategorized] ~217-~217: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...is key prefix | | monitoring | object | {"enabled":false,"logsCollection":{"pipeline":{"data":""}},"standalone":{},"vector":{"registry":"docker.io","repository":"timberio/vector","resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"50m","memory":"64Mi"}},"tag":"nightly-alpine"}} | The monitoring bootstrap configur...

(HYPHENATED_LY_ADVERB_ADJECTIVE)


[uncategorized] ~222-~222: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...g data | | monitoring.vector | object | {"registry":"docker.io","repository":"timberio/vector","resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"50m","memory":"64Mi"}},"tag":"nightly-alpine"} | Configure vector for logs and metr...

(HYPHENATED_LY_ADVERB_ADJECTIVE)

🔇 Additional comments (8)
charts/greptimedb-cluster/values.yaml (2)

Line range hint 630-638: LGTM. Verify impact on existing configurations.

The resource key has been correctly renamed to resources and the indentation has been fixed. This change improves consistency with Kubernetes resource naming conventions and ensures proper YAML syntax.

Please ensure this change doesn't break any existing configurations or scripts that might be relying on the old structure. You can run the following script to check for any other occurrences of the old key:

#!/bin/bash
# Description: Check for any remaining occurrences of the old resource key

# Test: Search for the old key in yaml files. Expect: No results in vector configurations.
rg "resource:" --type yaml -C 5

17-17: LGTM. Verify compatibility with other components.

The initializer image tag has been updated from v0.1.1 to v0.1.2. This minor version bump likely includes bug fixes or small improvements.

Please ensure this version is compatible with other components in the system. You can run the following script to check for any other occurrences of the old version:

✅ Verification successful

Verification Passed.
No remaining instances of v0.1.1 were found. The initializer tag has been successfully updated to v0.1.2.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining occurrences of the old initializer version

# Test: Search for the old version. Expect: No results.
rg "v0.1.1" --type yaml

Length of output: 54384

charts/greptimedb-cluster/README.md (5)

5-5: Version bump looks good.

The version has been correctly updated from 0.2.18 to 0.2.19 in the badge. This minor version increment suggests backward-compatible changes or bug fixes.


184-184: Initializer image tag update is correct.

The initializer image tag has been properly updated from v0.1.1 to v0.1.2. This patch version increment likely indicates bug fixes or minor improvements to the initializer.


217-225: Monitoring vector configuration update improves consistency.

The 'resource' key has been correctly renamed to 'resources' in the monitoring vector configuration. This change aligns with Kubernetes conventions for specifying container resources, enhancing clarity and consistency in the configuration.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~217-~217: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...is key prefix | | monitoring | object | {"enabled":false,"logsCollection":{"pipeline":{"data":""}},"standalone":{},"vector":{"registry":"docker.io","repository":"timberio/vector","resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"50m","memory":"64Mi"}},"tag":"nightly-alpine"}} | The monitoring bootstrap configur...

(HYPHENATED_LY_ADVERB_ADJECTIVE)


[uncategorized] ~222-~222: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...g data | | monitoring.vector | object | {"registry":"docker.io","repository":"timberio/vector","resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"50m","memory":"64Mi"}},"tag":"nightly-alpine"} | Configure vector for logs and metr...

(HYPHENATED_LY_ADVERB_ADJECTIVE)


217-225: Static analysis hints can be safely ignored.

The static analysis tool flagged the hyphenation in "nightly-alpine" as potentially unnecessary. However, this is a specific image tag name and should not be modified. Changing the hyphenation could lead to errors in pulling the correct image.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~217-~217: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...is key prefix | | monitoring | object | {"enabled":false,"logsCollection":{"pipeline":{"data":""}},"standalone":{},"vector":{"registry":"docker.io","repository":"timberio/vector","resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"50m","memory":"64Mi"}},"tag":"nightly-alpine"}} | The monitoring bootstrap configur...

(HYPHENATED_LY_ADVERB_ADJECTIVE)


[uncategorized] ~222-~222: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...g data | | monitoring.vector | object | {"registry":"docker.io","repository":"timberio/vector","resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"50m","memory":"64Mi"}},"tag":"nightly-alpine"} | Configure vector for logs and metr...

(HYPHENATED_LY_ADVERB_ADJECTIVE)


Line range hint 5-225: Summary of changes: Version updates and configuration improvements

This update includes:

  1. Bumping the chart version from 0.2.18 to 0.2.19
  2. Updating the initializer image tag from v0.1.1 to v0.1.2
  3. Renaming the 'resource' key to 'resources' in the monitoring vector configuration

These changes improve version consistency and align the configuration with Kubernetes conventions. The updates are minor and should not introduce any breaking changes.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~217-~217: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...is key prefix | | monitoring | object | {"enabled":false,"logsCollection":{"pipeline":{"data":""}},"standalone":{},"vector":{"registry":"docker.io","repository":"timberio/vector","resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"50m","memory":"64Mi"}},"tag":"nightly-alpine"}} | The monitoring bootstrap configur...

(HYPHENATED_LY_ADVERB_ADJECTIVE)


[uncategorized] ~222-~222: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...g data | | monitoring.vector | object | {"registry":"docker.io","repository":"timberio/vector","resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"50m","memory":"64Mi"}},"tag":"nightly-alpine"} | Configure vector for logs and metr...

(HYPHENATED_LY_ADVERB_ADJECTIVE)


[uncategorized] ~226-~226: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...ce | | monitoring.vector.tag | string | "nightly-alpine" | vector image tag | | mysqlServicePo...

(HYPHENATED_LY_ADVERB_ADJECTIVE)

charts/greptimedb-operator/templates/crds/crd-greptimedbcluster.yaml (1)

Line range hint 17119-17150: Approve: Enhanced resource management for vector component

The addition of the resources field under the vector section is a positive change. This enhancement allows for more granular control over resource allocation for the vector component, following Kubernetes best practices. The structure includes:

  1. claims: For specifying resource claims
  2. limits: For setting maximum resource usage
  3. requests: For defining minimum resource requirements

This change improves the overall flexibility and manageability of the GreptimeDBCluster custom resource.

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.

2 participants