[Docs]OSPP Support Kubernetes ConfigMap for Apollo java, golang client

[dyx1234]

What's the purpose of this PR

docs for pr apolloconfig/apollo-java#79
discussion #5210

Brief changelog

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

• New Features

  • Updated Java SDK user guide to include ConfigMap caching information for Kubernetes environments (versions 2.4.0 and above).
  • Introduced new configuration properties for managing ConfigMap caching.

• Documentation

  • Enhanced documentation detailing the structure of cached configuration data and necessary permissions for client pods.

[coderabbitai]

Walkthrough

The documentation for the Java SDK user guide has been updated to include new information about ConfigMap caching in Kubernetes environments for versions 2.4.0 and above. It outlines how clients can cache configuration data from the server within a ConfigMap, enhancing availability during service outages. New configuration properties have been introduced to manage this feature, and the documentation specifies the structure of cached data and the necessary permissions for client pods.

Changes

Files	Change Summary
docs/zh/client/java-sdk-user-guide.md	Added documentation on ConfigMap caching settings in the Java SDK user guide under section "1.2.4.10 ConfigMap缓存设置".

Poem

In the fields where rabbits play,
A new guide has come our way!
With ConfigMaps to help us thrive,
Caching secrets, we’ll survive!
Hop along, let’s cheer and sing,
For better configs, joy they bring! 🐇✨

---

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>, 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 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

Outside diff range and nitpick comments (1)

docs/zh/client/java-sdk-user-guide.md (1)

430-430: TODO: Add the guide for setting read/write permissions.

Please remember to add the guide for setting the necessary read/write permissions for the client pod to access the ConfigMap, as mentioned in the placeholder comment.

Do you want me to open a GitHub issue to track this task?

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 31e6486 and 315e7f9.

Files selected for processing (1)

• docs/zh/client/java-sdk-user-guide.md (2 hunks)

Additional context used

Markdownlint

docs/zh/client/java-sdk-user-guide.md

409-409: null
No empty links

(MD042, no-empty-links)

Additional comments not posted (4)

docs/zh/client/java-sdk-user-guide.md (4)

403-431: Great addition to enhance availability in Kubernetes environments!

The new feature to cache configurations in a ConfigMap is a valuable addition to enhance the availability of the Apollo client in Kubernetes environments. The documentation clearly explains the purpose, configuration properties, and structure of the cached data.

Tools

Markdownlint

409-409: null
No empty links

(MD042, no-empty-links)

---

403-403: Useful new configuration property for flexibility!

The new apollo.override-system-properties configuration property in version 2.1.0+ is a helpful addition to provide flexibility in controlling whether Apollo's remote properties should override Java's system properties. The documentation clearly explains its purpose and the order of precedence for configuration.

---

407-407: Helpful new configuration property for gray releases!

The new apollo.label configuration property is a useful addition to allow specifying the label information for the application, which is important for configuring gray release rules. The documentation clearly explains its purpose and the order of precedence for configuration.

---

Line range hint 453-453: Excellent support for Spring Boot 2.4+ and WebClient extension!

The addition of Config Data Loader support for Spring Boot 2.4+ and Apollo Client 1.9.0+, along with the ability to extend the HTTP client using WebClient, is a great enhancement. The documentation provides clear instructions on the required dependencies, configuration properties, and the extensibility point for customizing the WebClient through an SPI implementation.