[Docs]OSPP Support Kubernetes ConfigMap for Apollo java, golang client #5233
Conversation
dosubot
bot
added
the
size:M
WalkthroughThe 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 details how clients can cache configuration data in ConfigMaps, enhancing availability during service outages and network issues. New configuration properties are introduced, specifying the structure of cached data, and comprehensive instructions for granting necessary permissions to client pods are provided. Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
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-propertiesconfiguration 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.labelconfiguration 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.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/zh/client/java-sdk-user-guide.md (1)
403-489: Comprehensive guide on ConfigMap caching in Kubernetes.This new section provides detailed information about ConfigMap caching for Apollo clients in Kubernetes environments. It covers:
- Version compatibility
- Configuration properties
- Naming conventions for ConfigMaps
- Steps to grant necessary permissions to the Pod's Service Account
The content is well-structured and informative. However, there are a few minor improvements that could be made:
The code blocks for Kubernetes resources (ServiceAccount, Role, RoleBinding, Pod) are not specified with a language. Adding
yamlas the language would improve syntax highlighting.The numbered list for granting permissions is not properly formatted in Markdown, which may affect rendering.
Consider applying the following changes to improve formatting:
- Add
yamlto the code blocks. For example:- ``` + ```yaml apiVersion: v1 kind: ServiceAccount metadata: name: my-service-account namespace: my-namespace ``` 2. Fix the numbered list formatting by adding a blank line after each item. For example: ```diff 1. 创建Service Account: 如果还没有Service Account，你需要创建一个。 + 2. 创建Role或ClusterRole: 定义一个Role或ClusterRole，授予对特定ConfigMap的读写权限。如果ConfigMap是跨多个Namespace使用的，应该使用ClusterRole。 + 3. 绑定Service Account到Role或ClusterRole: 使用RoleBinding或ClusterRoleBinding将Service Account绑定到上面创建的Role或ClusterRole。These changes will improve the readability and rendering of the documentation.
🧰 Tools
🪛 Markdownlint
440-440: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
452-452: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
468-468: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
481-481: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 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
440-440: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
452-452: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
468-468: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
481-481: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🔇 Additional comments (1)
docs/zh/client/java-sdk-user-guide.md (1)
166-167: Informative addition about local file caching.This note provides valuable information about the dual caching mechanism when using ConfigMap in Kubernetes environments. It enhances the user's understanding of the caching strategy.
dosubot
bot
added
size:L
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
docs/zh/client/java-sdk-user-guide.md (1)
403-490: Comprehensive addition of ConfigMap caching information.This new section provides detailed information about ConfigMap caching in Kubernetes environments for Apollo client version 2.4.0 and above. The content is well-structured and informative, covering:
- Version applicability
- Purpose and benefits of ConfigMap caching
- Configuration properties
- Structure of cached data
- Detailed instructions for granting necessary permissions
The information appears to be complete and valuable for users implementing Apollo in Kubernetes environments.
However, there are a few minor improvements that could be made:
- Consider adding a brief introduction explaining why ConfigMap caching is beneficial in Kubernetes environments.
- The code blocks for Kubernetes configurations (ServiceAccount, Role, RoleBinding, Pod) should have a language specifier for proper syntax highlighting.
To improve readability and syntax highlighting, add language specifiers to the code blocks. For example:
- ``` + ```yaml apiVersion: v1 kind: ServiceAccount metadata: name: my-service-account namespace: my-namespace ```Apply similar changes to the other code blocks in this section.
🧰 Tools
🪛 Markdownlint
440-440: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
452-452: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
468-468: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
481-481: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/en/client/java-sdk-user-guide.md (4)
457-460: Add language specification to the code blockTo improve readability and enable proper syntax highlighting, please add a language specification to this code block. For YAML content, you can add
yamlafter the opening triple backticks.Example:
apiVersion: v1 kind: ServiceAccount metadata: name: my-service-account namespace: my-namespace🧰 Tools
🪛 Markdownlint
457-457: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
469-482: Add language specification to the code blockTo improve readability and enable proper syntax highlighting, please add a language specification to this code block. For YAML content, you can add
yamlafter the opening triple backticks.Example:
apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: namespace: my-namespace name: configmap-reader rules: - apiGroups: [""] resources: ["configmaps"] verbs: ["get", "watch", "list", "update", "patch"]🧰 Tools
🪛 Markdownlint
469-469: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
485-496: Add language specification to the code blockTo improve readability and enable proper syntax highlighting, please add a language specification to this code block. For YAML content, you can add
yamlafter the opening triple backticks.Example:
apiVersion: v1 kind: Pod metadata: name: my-pod namespace: my-namespace spec: serviceAccountName: my-service-account containers: - name: my-container image: my-image🧰 Tools
🪛 Markdownlint
485-485: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
498-503: Add language specification to the code blockTo improve readability and enable proper syntax highlighting, please add a language specification to this code block. For shell commands, you can add
bashafter the opening triple backticks.Example:
kubectl apply -f service-account.yaml kubectl apply -f role.yaml kubectl apply -f role-binding.yaml kubectl apply -f pod.yaml🧰 Tools
🪛 Markdownlint
498-498: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- docs/en/client/java-sdk-user-guide.md (2 hunks)
- docs/zh/client/java-sdk-user-guide.md (2 hunks)
🧰 Additional context used
🪛 Markdownlint
docs/en/client/java-sdk-user-guide.md
457-457: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
469-469: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
485-485: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
498-498: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/zh/client/java-sdk-user-guide.md
440-440: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
452-452: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
468-468: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
481-481: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🔇 Additional comments (2)
docs/zh/client/java-sdk-user-guide.md (1)
166-167: Approved: Clear note about local file caching.This note provides important information about the behavior of caching in Kubernetes environments. It's clear and concise.
docs/en/client/java-sdk-user-guide.md (1)
418-506: Excellent addition of ConfigMap caching documentation!The new section on ConfigMap caching for Kubernetes environments is a valuable addition to the documentation. It provides clear instructions and examples for setting up this feature. Here are a few suggestions to further improve the content:
- Consider adding a brief explanation of the benefits of using ConfigMap caching in Kubernetes environments.
- It might be helpful to mention any potential drawbacks or considerations when using this feature.
- The permissions setup instructions are comprehensive, but consider adding a note about security best practices when granting these permissions.
Overall, this is a well-written and informative addition to the documentation.
🧰 Tools
🪛 Markdownlint
457-457: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
469-469: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
485-485: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
498-498: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
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
Documentation