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

docs: add note for confiservice and adminservice #5354

Closed
wants to merge 1 commit into from

Conversation

zhangbobo131415
Copy link
Contributor

@zhangbobo131415 zhangbobo131415 commented Mar 2, 2025

What's the purpose of this PR

优化分布式环境搭建文档

Which issue(s) this PR fixes:

Fixes #5348

Brief changelog

修改分分布式搭建文档,提醒用户apollo-configservice 和 apollo-adminservice注册端口不一样

Summary by CodeRabbit

  • Documentation
    • Updated the deployment guides with clearer instructions for configuring the services.
    • Clarified default registration ports (8080 and 8090) to help distinguish between the two services.
    • Expanded configuration examples, including settings for home page URLs and preference options using both JVM System Properties and OS Environment Variables.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Mar 2, 2025
Copy link
Contributor

coderabbitai bot commented Mar 2, 2025

Walkthrough

The documentation for distributed deployment has been updated in both English and Chinese versions. The changes clarify the default registration ports for apollo-configservice (8080) and apollo-adminservice (8090), and expand the configuration examples for JVM System Properties and OS Environment Variables. No alterations were made to exported or public entities.

Changes

File Path Summary of Changes
docs/en/.../distributed-deployment-guide.md
docs/zh/.../distributed-deployment-guide.md
Added a note clarifying default ports (8080 for configservice, 8090 for adminservice) along with expanded examples for setting homePageUrl and preferIpAddress via both JVM System Properties and OS Environment Variables.

Suggested labels

size:XS, lgtm

Suggested reviewers

  • nobodyiam

Poem

Hop, hop, hop—a rabbit's cheer,
For clearer docs that now appear.
Ports are set, examples shine bright,
Guiding deployments day and night.
With whiskers twitching in delight, I hop to say, "Everything’s just right!" 🐰


📜 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 5eb320f and 8131381.

📒 Files selected for processing (2)
  • docs/en/deployment/distributed-deployment-guide.md (1 hunks)
  • docs/zh/deployment/distributed-deployment-guide.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (8)
🔇 Additional comments (4)
docs/en/deployment/distributed-deployment-guide.md (1)

120-120: Documentation Clarification for Registration Ports

The new note clearly specifies that the default registration ports for apollo-configservice and apollo-adminservice are 8080 and 8090 respectively. This clarification directly addresses the PR objective of preventing configuration confusion and enhances the overall clarity of the deployment guide.

docs/zh/deployment/distributed-deployment-guide.md (3)

120-122: Addition of port clarification note.
The inserted note clearly informs users that apollo-configservice and apollo-adminservice register with different default ports (8080 and 8090, respectively). This clarification minimizes confusion during configuration and aligns well with the PR objective.


125-133: Clear JVM System Property configuration examples.
The updated JVM System Property examples now distinctly show the correct property settings for both services—using port 8080 for apollo-configservice and port 8090 for apollo-adminservice. This clear separation helps prevent misconfiguration and improves overall documentation clarity.


138-145: Enhanced OS Environment Variable configuration examples.
The revised OS Environment Variable examples explicitly differentiate between the two services by setting the appropriate port numbers. This ensures that users understand which environment variable corresponds to which service and on which port they will be registered.


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.
  • @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 Mar 2, 2025

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


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


You can retrigger this bot by commenting recheck in this Pull Request

@github-actions github-actions bot locked and limited conversation to collaborators Mar 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

优化搭建文档
1 participant