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 to v0.1.3-alpha.1 #180

Merged
merged 1 commit into from
Oct 27, 2024

Conversation

zyy17
Copy link
Collaborator

@zyy17 zyy17 commented Oct 26, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced startupProbe and slowQuery configurations in the GreptimeDBCluster and GreptimeDBStandalone resources for improved health checks and logging capabilities.
  • Version Updates

    • Updated the application version to 0.1.3-alpha.1 and the Helm chart version to 0.2.9.
  • Documentation

    • Revised version numbers in the README to reflect the latest updates.

@zyy17 zyy17 requested a review from daviderli614 October 26, 2024 16:40
Copy link
Contributor

coderabbitai bot commented Oct 26, 2024

Walkthrough

The pull request includes updates to the greptimedb-operator Helm chart, specifically modifying the Chart.yaml, README.md, values.yaml, and CRD files. The appVersion and version fields have been incremented to reflect a new pre-release version. Additionally, new properties for startupProbe and slowQuery have been introduced in the CRDs to enhance health checks and logging capabilities. The changes maintain backward compatibility while extending the functionality of the operator.

Changes

File Path Change Summary
charts/greptimedb-operator/Chart.yaml Updated appVersion from 0.1.2 to 0.1.3-alpha.1; updated version from 0.2.8 to 0.2.9.
charts/greptimedb-operator/README.md Updated version and appVersion to 0.2.9 and 0.1.3-alpha.1, respectively; image tag updated.
charts/greptimedb-operator/templates/crds/crd-greptimedbcluster.yaml Added startupProbe and slowQuery properties to GreptimeDBCluster CRD.
charts/greptimedb-operator/templates/crds/crd-greptimedbstandalone.yaml Added startupProbe and slowQuery properties to GreptimeDBStandalone CRD.
charts/greptimedb-operator/values.yaml Updated image tag from v0.1.2 to v0.1.3-alpha.1.

Possibly related PRs

Suggested reviewers

  • daviderli614

Poem

🐇 In the meadow where the code does play,
New versions hop in a bright array.
With probes for health and queries slow,
Our greptimedb's ready, watch it grow!
A chart updated, a leap we take,
In the world of Helm, new paths we make! 🌼


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

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

5-5: Note: This is a pre-release alpha version.

The alpha designation indicates this version may include experimental features and is not recommended for production use. Users should exercise caution when upgrading.

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

2931-2943: Consider adding default values for slowQuery configuration

While the schema validation is solid, consider documenting or providing default values for:

  • sampleRatio (e.g., 0.1 for 10% sampling)
  • threshold (e.g., "1s" for 1 second)

This would help users get started with slow query logging without having to determine appropriate values themselves.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2ab0e48 and fba66cf.

📒 Files selected for processing (5)
  • charts/greptimedb-operator/Chart.yaml (1 hunks)
  • charts/greptimedb-operator/README.md (2 hunks)
  • charts/greptimedb-operator/templates/crds/crd-greptimedbcluster.yaml (12 hunks)
  • charts/greptimedb-operator/templates/crds/crd-greptimedbstandalone.yaml (2 hunks)
  • charts/greptimedb-operator/values.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • charts/greptimedb-operator/README.md
🔇 Additional comments (6)
charts/greptimedb-operator/Chart.yaml (1)

5-6: LGTM! Version updates look correct.

The version bumps follow semantic versioning conventions:

  • appVersion: 0.1.3-alpha.1 (pre-release version)
  • Chart version: 0.2.9

Let's verify the version consistency across related files:

✅ Verification successful

Version updates are consistent across all chart files

The version references are correctly synchronized in all relevant files:

  • Chart.yaml: appVersion: 0.1.3-alpha.1, version: 0.2.9
  • values.yaml: image.tag: v0.1.3-alpha.1
  • README.md: Both versions correctly reflected in badges and configuration table
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify version consistency across chart files
echo "Checking version references in README.md and values.yaml..."
rg -A 1 "0\.1\.3-alpha\.1|0\.2\.9" charts/greptimedb-operator/

Length of output: 1111

charts/greptimedb-operator/values.yaml (1)

11-11: Version bump looks correct, but please note this is an alpha release.

The version bump from v0.1.2 to v0.1.3-alpha.1 is consistent with the changes in Chart.yaml. However, as this is an alpha release, users should be aware that it may contain unstable features.

Let's verify version consistency across related files:

✅ Verification successful

Version consistency verified across Helm chart files

The version v0.1.3-alpha.1 is consistently referenced across:

  • values.yaml: tag: v0.1.3-alpha.1
  • Chart.yaml: appVersion: 0.1.3-alpha.1
  • README.md: image.tag | string | "v0.1.3-alpha.1"
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify version consistency across Helm chart files
echo "Checking version references in Chart.yaml and README.md..."
rg -A 1 "version:|appVersion:" charts/greptimedb-operator/Chart.yaml
rg "v0.1.3-alpha.1" charts/greptimedb-operator/README.md

Length of output: 373

charts/greptimedb-operator/templates/crds/crd-greptimedbstandalone.yaml (2)

2048-2125: LGTM! Well-structured startup probe configuration.

The addition of startupProbe follows Kubernetes API conventions and includes all necessary probe configurations (exec, http, tcp, grpc) with proper type definitions and validations. This is a valuable addition that will help handle slow-starting containers better than just relying on liveness and readiness probes.


2944-2956: LGTM! Well-defined slow query logging configuration.

The slowQuery configuration under logging section is well-structured with:

  • Clear boolean toggle with enabled field
  • Precise pattern validation for sampleRatio (0-1)
  • Proper time duration format validation for threshold

This addition will help in monitoring and debugging query performance issues.

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

2060-2137: LGTM: Well-structured startupProbe schema additions

The startupProbe schema follows Kubernetes probe schema conventions and includes all standard probe fields:

  • exec, httpGet, tcpSocket, and gRPC handlers
  • Common timing fields (initialDelaySeconds, periodSeconds, etc.)
  • Proper type definitions and validation

Also applies to: 4974-5051, 7862-7939, 10780-10857


2931-2943: LGTM: Well-defined slowQuery schema additions

The slowQuery schema is consistently defined across datanode, flownode, and frontend sections with:

  • Required enabled boolean field
  • Optional sampleRatio field with proper regex pattern validation ^(0?\.\d+|1(\.0+)?)$ for decimal values between 0 and 1
  • Optional threshold field with proper regex pattern validation ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$ for duration values

Also applies to: 5841-5853, 8734-8746

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