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

feat: 新增K8S集群中服务接入方式 #5322

Merged
merged 3 commits into from
Feb 5, 2025

Conversation

adamswanglin
Copy link
Contributor

@adamswanglin adamswanglin commented Jan 23, 2025

What's the purpose of this PR

新增ConfigMap接入方式

Which issue(s) this PR fixes:

Fixes #

Brief changelog

新增ConfigMap接入方式:自动同步 Apollo 配置到 K8S ConfigMap 中

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Added a new guide for K8S ConfigMap integration in both English and Chinese client documentation.
    • Introduced sections detailing automatic Apollo configuration synchronization into K8S ConfigMap in both English and Chinese guides.

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jan 23, 2025
Copy link
Contributor

coderabbitai bot commented Jan 23, 2025

Walkthrough

This pull request enhances the documentation by adding a new guide for Kubernetes (K8S) ConfigMap integration in both Chinese and English. The changes include updates to the sidebar navigation to include links to new markdown files that provide detailed instructions for integrating Apollo configurations with K8S ConfigMap.

Changes

File Change Summary
docs/zh/_sidebar.md Added new entry for "K8S ConfigMap接入指南" (K8S ConfigMap Integration Guide) in the "客户端指南" (Client Guide) section
docs/zh/client/k8s-configmap-user-guide.md Created new documentation file with a section on Apollo K8S ConfigMap integration
docs/en/_sidebar.md Added new entry for "K8S ConfigMap Integration Usage Guide" in the "SDK Guide" section
docs/en/client/k8s-configmap-user-guide.md Created new documentation file with a section on Apollo K8S ConfigMap integration

Possibly related PRs

Suggested labels

size:M, lgtm

Suggested reviewers

  • nobodyiam

Poem

🐰 Hop, hop, config's new dance!
K8S and Apollo now advance
ConfigMap joins the party bright
Synchronizing with pure delight
Documentation spreads its wings 🚀

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1fcb11c and f97409b.

📒 Files selected for processing (2)
  • docs/en/_sidebar.md (1 hunks)
  • docs/en/client/k8s-configmap-user-guide.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/en/client/k8s-configmap-user-guide.md
🔇 Additional comments (1)
docs/en/_sidebar.md (1)

34-34: New Sidebar Entry for K8S ConfigMap Integration

The new entry, - [K8S ConfigMap Integration Usage Guide](en/client/k8s-configmap-user-guide.md), is clearly added under the SDK Guide section, aligning with the update objectives to streamline K8S service integration. Ensure that the linked guide contains detailed instructions for automatically syncing Apollo configurations into Kubernetes ConfigMaps and that it adheres to the project's documentation style standards.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

github-actions bot commented Jan 23, 2025

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@nobodyiam
Copy link
Member

Please include the English version of the document and sign the CLA as instructed by the CLA Assistant Lite bot.

@adamswanglin
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Feb 5, 2025
Copy link
Member

@nobodyiam nobodyiam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 5, 2025
@nobodyiam nobodyiam merged commit 529ac78 into apolloconfig:master Feb 5, 2025
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 5, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants