docs: update readme

[zyy17]

Summary by CodeRabbit

• New Features

  • Added a section for utilizing OCI artifacts, simplifying deployment without needing a chart repository.
  • Enhanced documentation on service exposure options for greater flexibility.
  • Introduced clear instructions on uninstalling the greptimedb-operator without deleting CRDs by default.

• Documentation

  • Improved clarity and organization of CRD management instructions.
  • Updated version information and section titles for better navigation and understanding.

[coderabbitai]

Walkthrough

The recent updates enhance the deployment documentation for the GreptimeDB cluster, particularly regarding OCI artifacts and CRD management. New sections clarify usage, improve accessibility through updated commands, and emphasize data safety during uninstallation. A minor Helm chart version bump indicates ongoing improvements while maintaining backward compatibility, ensuring users benefit from clearer instructions and better functionality.

Changes

Files	Change Summary
README.md, charts/greptimedb-operator/README.md, charts/greptimedb-operator/README.md.gotmpl	Added and reorganized sections on OCI artifacts and CRD management, clarifying installation, upgrade, and uninstallation processes. Improved command examples for ease of use.
charts/greptimedb-operator/Chart.yaml	Incremented version from 0.2.2 to 0.2.3, indicating bug fixes or new features while ensuring backward compatibility.

Poem

🐰 In the meadow where changes bloom,
The GreptimeDB saga finds more room.
With OCI artifacts, oh so bright,
CRDs managed, what a delight!
A hop, a skip, to upgrade with glee,
Data safe, come dance with me! 🌼

---

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
• Mastodon
• Reddit
• LinkedIn

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d0f67c8 and a9cd049.

Files selected for processing (4)

• README.md (5 hunks)
• charts/greptimedb-operator/Chart.yaml (1 hunks)
• charts/greptimedb-operator/README.md (3 hunks)
• charts/greptimedb-operator/README.md.gotmpl (2 hunks)

Files skipped from review due to trivial changes (1)

• charts/greptimedb-operator/Chart.yaml

Additional context used

LanguageTool

README.md

[uncategorized] ~151-~151: Possible missing comma found.
Context: ...default** after uninstalling greptimedb-operator unless you use --set crds.keep=false....

(AI_HYDRA_LEO_MISSING_COMMA)

Additional comments not posted (10)

charts/greptimedb-operator/README.md.gotmpl (3)

42-46: Clear uninstallation instructions.

The new "How to Uninstall" section provides clear and concise instructions for uninstalling the greptimedb-operator.

---

Line range hint 48-82: Improved CRDs management documentation.

The restructuring and additional details in the "CRDs Management" section improve clarity and usability for managing CRDs.

---

Line range hint 82-87: Clear instructions for updating CRDs in the chart.

The new section provides clear and concise instructions for updating CRDs in the chart.

README.md (4)

28-45: Clear instructions for using OCI artifacts.

The new "OCI Artifacts" section provides clear and concise instructions for using OCI artifacts without adding a chart repository.

---

115-123: Enhanced kubectl port-forward instructions.

The updated instructions for kubectl port-forward enhance accessibility and flexibility for accessing the GreptimeDB cluster.

---

151-153: Clarified CRD uninstallation instructions.

The clarification that CRDs are not deleted by default helps prevent accidental data loss and informs users about manual CRD deletion.

Tools

LanguageTool

[uncategorized] ~151-~151: Possible missing comma found.
Context: ...default** after uninstalling greptimedb-operator unless you use --set crds.keep=false....

(AI_HYDRA_LEO_MISSING_COMMA)

---

151-151: No change needed.

The sentence is clear and does not require a comma. The LanguageTool suggestion is a false positive.

Tools

LanguageTool

[uncategorized] ~151-~151: Possible missing comma found.
Context: ...default** after uninstalling greptimedb-operator unless you use --set crds.keep=false....

(AI_HYDRA_LEO_MISSING_COMMA)

charts/greptimedb-operator/README.md (3)

5-5: Version update to 0.2.3.

The version number has been updated to 0.2.3, indicating ongoing improvements.

---

43-47: Clear uninstallation instructions.

The new "How to Uninstall" section provides clear and concise instructions for uninstalling the greptimedb-operator.

---

Line range hint 49-83: Improved CRDs management documentation.

The restructuring and additional details in the "CRDs Management" section improve clarity and usability for managing CRDs.