search

GreptimeTeam / greptimedb-operator

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

refactor: move `config/samples/` to `examples/` and add docs #177

Closed zyy17 closed 2 months ago

zyy17 commented 2 months ago

What's changed

  1. Move config/samples to examples and refine the naming of the directory;
  2. Don't specify namespace field in the examples(let the users decide the namespace);
  3. Remove unnecessary license header;
  4. Add README.md for examples/;

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve the removal of multiple configuration files related to the deployment of GreptimeDB clusters and standalone instances across various storage options, including AWS, GCS, OSS, and S3. Additionally, new files have been introduced to provide examples of deploying GreptimeDB with specific configurations. The updates include modifications to existing files to enhance clarity and adjust settings for components like etcd endpoints and replica counts.

Changes

Files Change Summary
config/samples/cluster/.../cluster.yaml, config/samples/standalone/.../standalone.yaml Removed various configuration files for GreptimeDB clusters and standalone instances, eliminating support for specific deployment setups with AWS NLB, GCS, OSS, S3, and TLS.
examples/README.md Added a new README file providing a guide for using the GreptimeDB Operator, detailing various deployment examples for clusters and standalone instances.
examples/cluster/add-custom-config/cluster.yaml Modified the namespace, updated etcd endpoints, and reduced datanode replicas from 3 to 1.
examples/cluster/aws-nlb/cluster.yaml, examples/cluster/basic/cluster.yaml, examples/cluster/flownode/cluster.yaml, examples/cluster/gcs/cluster.yaml, examples/cluster/oss/cluster.yaml, examples/cluster/s3/cluster.yaml, examples/cluster/tls-service/cluster.yaml, examples/cluster/prometheus-monitor/cluster.yaml Added new configuration files for deploying GreptimeDB clusters with various features and storage options, specifying components and settings for each deployment scenario.
examples/cluster/gcs/gcs-credentials.yaml, examples/cluster/oss/oss-credentials.yaml, examples/cluster/s3/s3-credentials.yaml Introduced new Secret resources for securely storing credentials for GCS, OSS, and S3, enhancing security in accessing these services.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GreptimeDBOperator
    participant Kubernetes

    User->>GreptimeDBOperator: Request to deploy GreptimeDB
    GreptimeDBOperator->>Kubernetes: Create GreptimeDBCluster resource
    Kubernetes->>GreptimeDBOperator: Acknowledge resource creation
    GreptimeDBOperator->>Kubernetes: Deploy components (frontend, datanode, etc.)
    Kubernetes->>User: Deployment successful

🐇 In the meadow, changes bloom,
New clusters rise, dispelling gloom.
With secrets safe, our data's bright,
GreptimeDB shines, a wondrous sight!
Deploy with ease, let joy take flight! 🌼

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 .` - `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 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.