GreptimeTeam / greptimedb-operator

Run GreptimeDB on Kubernetes.
Apache License 2.0
37 stars 2 forks source link

fix: compoents don't updated by modifying the fields of `cluster.base` #192

Closed zyy17 closed 1 month ago

zyy17 commented 1 month ago

What's changed

In the original logic, we modify template and logging of ComponentSpec in SetDefaults(). It's hard to distinguish whether the user sets the field of ComponentSpec of individual components or uses the base config.

In this PR, I move the MergeTemplate() and MergeLogging() from SetDefaults() to Reconcile():

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces significant modifications to the GreptimeDBCluster struct within the defaulting.go file, including the removal of the mergeTemplate and mergeLogging methods, replaced by new methods MergeTemplate and MergeLogging. The expect.yaml files for the GreptimeDBCluster resource have been simplified, removing detailed configurations in favor of minimalistic empty objects. Additionally, the GreptimeDBClusterSpec structure has been updated to make several component specifications optional, enhancing flexibility in configuration.

Changes

File Path Change Summary
apis/v1alpha1/defaulting.go - Added: MergeTemplate() method
- Added: MergeLogging() method
- Removed: mergeTemplate() method
- Removed: mergeLogging() method
apis/v1alpha1/testdata/defaulting/greptimedbcluster/test00/expect.yaml - Updated: logging and template fields in frontend, meta, and datanode sections to {}
apis/v1alpha1/testdata/defaulting/greptimedbcluster/test01/expect.yaml - Updated: Similar changes as above
apis/v1alpha1/testdata/defaulting/greptimedbcluster/test02/expect.yaml - Updated: Similar changes as above
apis/v1alpha1/testdata/defaulting/greptimedbcluster/test03/expect.yaml - Updated: metadata.name field from test02 to test03
apis/v1alpha1/greptimedbcluster_types.go - Updated: Made Frontend, Meta, and Datanode fields optional with omitempty tag in GreptimeDBClusterSpec
apis/v1alpha1/defaulting_test.go - Added: TestClusterMerge() method to validate merging functionality for GreptimeDBCluster
config/crd/resources/greptime.io_greptimedbclusters.yaml - Updated: CRD for greptimedbclusters with new properties and restructuring of existing ones
manifests/bundle.yaml - Added: Namespace, CRDs, Service Account, Roles, RoleBindings, ClusterRoleBindings, and Deployment for the GreptimeDB operator

Possibly related PRs

Suggested reviewers

Poem

🐇 In the fields where the clusters grow,
Merging templates, a new flow!
Logging now in a simpler way,
Empty objects come out to play.
With each change, a hop and a cheer,
A clearer path as we draw near! 🌼


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.