refactor!: remove original `config` usage and add `configFile` and `configData` field #152

zyy17 · 2024-08-06T07:19:47Z

What's changed

Support to add extra toml by using file and raw string data.

Summary by CodeRabbit

New Features
- Incremented version number to 0.2.6 for the GreptimeDB cluster Helm chart.
- Introduced new configuration options for datanode, flownode, frontend, and meta components, allowing users to specify either configuration files or inline data for greater flexibility.
Documentation
- Updated README.md to reflect new configuration structures while ensuring backward compatibility.
Chores
- Enhanced title validation for pull requests to accommodate breaking changes indicators.

coderabbitai · 2024-08-06T07:19:56Z

Walkthrough

The updates to the GreptimeDB cluster Helm chart introduce greater configuration flexibility by adding new fields for key components. The version number has been incremented to 0.2.6, signaling a new release. Users can now choose between providing raw TOML data or specifying external configuration files, improving usability and clarity for cluster deployment.

Changes

Files	Change Summary
`charts/greptimedb-cluster/Chart.yaml`	Version updated from `0.2.5` to `0.2.6`.
`charts/greptimedb-cluster/README.md`, `charts/greptimedb-cluster/values.yaml`	Version updated; new fields `configFile` and `configData` introduced for `datanode`, `flownode`, `frontend`, and `meta`.
`charts/greptimedb-cluster/templates/cluster.yaml`	Logic updated to accommodate both `configFile` and `configData`, enhancing configurability.
`.github/pr-title-checker-config.json`	Regular expression modified to include `!` for validating breaking changes in PR titles.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HelmChart
    participant Component

    User->>HelmChart: Deploy cluster with configFile or configData
    HelmChart->>Component: Render configuration
    alt If configFile is provided
        Component-->>HelmChart: Load config from file
    else If configData is provided
        Component-->>HelmChart: Use inline config data
    end
    HelmChart-->>User: Cluster deployed with configuration

Poem

In the meadow where the data flows,
A rabbit hops where the TOML grows.
With config files and data anew,
Deployments sprout, a vibrant view.
Hopping high with joy, oh what a cheer,
For the GreptimeDB, the future is clear! 🐇🌼

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (8)

charts/greptimedb-cluster/values.yaml (4)

75-79: Add validation or example values for configFile and configData.

The new fields configFile and configData are added, but it would be helpful to provide example values or validation rules to guide users.

155-159: Add validation or example values for configFile and configData.

The new fields configFile and configData are added, but it would be helpful to provide example values or validation rules to guide users.

237-241: Add validation or example values for configFile and configData.

The new fields configFile and configData are added, but it would be helpful to provide example values or validation rules to guide users.

325-329: Add validation or example values for configFile and configData.

The new fields configFile and configData are added, but it would be helpful to provide example values or validation rules to guide users.

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

90-92: Document configFile and configData fields.

The new fields configFile and configData are added, but ensure they are clearly documented with examples or usage guidelines.

117-119: Document configFile and configData fields.

The new fields configFile and configData are added, but ensure they are clearly documented with examples or usage guidelines.

140-142: Document configFile and configData fields.

The new fields configFile and configData are added, but ensure they are clearly documented with examples or usage guidelines.

173-175: Document configFile and configData fields.

The new fields configFile and configData are added, but ensure they are clearly documented with examples or usage guidelines.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b7574f9 and b8bd9cf.

Files selected for processing (4)

charts/greptimedb-cluster/Chart.yaml (1 hunks)
charts/greptimedb-cluster/README.md (5 hunks)
charts/greptimedb-cluster/templates/cluster.yaml (4 hunks)
charts/greptimedb-cluster/values.yaml (4 hunks)

Files skipped from review due to trivial changes (1)

charts/greptimedb-cluster/Chart.yaml

Additional comments not posted (5)

charts/greptimedb-cluster/templates/cluster.yaml (4)

51-58: Ensure proper handling of both configFile and configData.

The logic correctly handles either configFile or configData, but ensure that both fields are mutually exclusive and properly validated.

112-119: Ensure proper handling of both configFile and configData.

The logic correctly handles either configFile or configData, but ensure that both fields are mutually exclusive and properly validated.

176-183: Ensure proper handling of both configFile and configData.

The logic correctly handles either configFile or configData, but ensure that both fields are mutually exclusive and properly validated.

237-244: Ensure proper handling of both configFile and configData.

The logic correctly handles either configFile or configData, but ensure that both fields are mutually exclusive and properly validated.

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

5-5: Version number correctly updated.

The version number has been updated to 0.2.6, indicating a new release.

daviderli614 · 2024-08-06T09:27:46Z

Seem breaking change in our cloud ? We use .Values.${component_name}.config inject to this configuration.

zyy17 · 2024-08-06T12:22:48Z

Seem breaking change in our cloud ? We use .Values.${component_name}.config inject to this configuration.

You are right. It's a breaking change. Let me change to title to make it clear.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b8bd9cf and 2645d3e.

Files selected for processing (1)

.github/pr-title-checker-config.json (1 hunks)

Additional comments not posted (1)

.github/pr-title-checker-config.json (1)

7-7: LGTM! The regular expression change is appropriate.

The modification to include an optional exclamation mark (!) after the keywords in the regular expression aligns with the PR objectives of indicating breaking changes.

zyy17 · 2024-08-06T12:54:31Z

Wait for #153 to resolve title checking error.

daviderli614

LGTM

Signed-off-by: zyy17 <[email protected]>

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2645d3e and 9f96175.

Files selected for processing (4)

charts/greptimedb-cluster/Chart.yaml (1 hunks)
charts/greptimedb-cluster/README.md (5 hunks)
charts/greptimedb-cluster/templates/cluster.yaml (4 hunks)
charts/greptimedb-cluster/values.yaml (4 hunks)

Files skipped from review due to trivial changes (2)

charts/greptimedb-cluster/Chart.yaml
charts/greptimedb-cluster/README.md

Files skipped from review as they are similar to previous changes (2)

charts/greptimedb-cluster/templates/cluster.yaml
charts/greptimedb-cluster/values.yaml

zyy17 force-pushed the refactor/add-config-fields branch 2 times, most recently from 5618846 to b8bd9cf Compare August 6, 2024 07:22

zyy17 requested a review from daviderli614 August 6, 2024 07:22

coderabbitai bot reviewed Aug 6, 2024

View reviewed changes

zyy17 changed the title ~~refactor: add configFile and configData field~~ refactor!: remove original config usage and add configFile and configData field Aug 6, 2024

github-actions bot added the Invalid PR Title label Aug 6, 2024

coderabbitai bot reviewed Aug 6, 2024

View reviewed changes

zyy17 force-pushed the refactor/add-config-fields branch 2 times, most recently from 164458e to f23b880 Compare August 6, 2024 12:39

daviderli614 approved these changes Aug 6, 2024

View reviewed changes

refactor: add configFile and configData field

9f96175

Signed-off-by: zyy17 <[email protected]>

zyy17 force-pushed the refactor/add-config-fields branch from f23b880 to 9f96175 Compare August 6, 2024 13:09

github-actions bot removed the Invalid PR Title label Aug 6, 2024

coderabbitai bot reviewed Aug 6, 2024

View reviewed changes

zyy17 merged commit 478c631 into GreptimeTeam:main Aug 6, 2024
3 checks passed

zyy17 deleted the refactor/add-config-fields branch August 6, 2024 13:49

WenyXu mentioned this pull request Aug 7, 2024

chore: use configData GreptimeTeam/greptimedb#4522

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor!: remove original `config` usage and add `configFile` and `configData` field #152

refactor!: remove original `config` usage and add `configFile` and `configData` field #152

zyy17 commented Aug 6, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 6, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

daviderli614 commented Aug 6, 2024

zyy17 commented Aug 6, 2024

coderabbitai bot left a comment

zyy17 commented Aug 6, 2024

daviderli614 left a comment

coderabbitai bot left a comment

refactor!: remove original config usage and add configFile and configData field #152

refactor!: remove original config usage and add configFile and configData field #152

Conversation

zyy17 commented Aug 6, 2024 • edited by coderabbitai bot Loading

What's changed

Summary by CodeRabbit

coderabbitai bot commented Aug 6, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

daviderli614 commented Aug 6, 2024

zyy17 commented Aug 6, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

zyy17 commented Aug 6, 2024

daviderli614 left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

refactor!: remove original `config` usage and add `configFile` and `configData` field #152

refactor!: remove original `config` usage and add `configFile` and `configData` field #152

zyy17 commented Aug 6, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 6, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)