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

dyx1234 commented 2 months ago

What's the purpose of this PR

解决Apollo客户端在Kubernetes环境下因服务端宕机或Pod重启导致配置信息文件丢失的问题。通过使用Kubernetes ConfigMap作为新的持久化存储方案，提高配置信息的可靠性和容错性。

Solve the problem of Apollo client configuration information files being lost due to server downtime or Pod restart in the Kubernetes environment. By using Kubernetes ConfigMap as a new persistent storage solution, the reliability and fault tolerance of configuration information are improved.

discussion https://github.com/apolloconfig/apollo/discussions/5210

Brief changelog

XXXXX

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
- Introduced support for Kubernetes ConfigMap caching in the Apollo client.
- Added configuration options for enabling Kubernetes cache and specifying the namespace.
Bug Fixes
- Enhanced error handling and logging for ConfigMap operations.
Tests
- Added comprehensive unit tests for K8sConfigMapConfigRepository and KubernetesManager to ensure functionality and reliability.
Documentation
- Updated release notes to include new features and fixes related to Kubernetes support.

github-actions[bot] commented 2 months ago

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

coderabbitai[bot] commented 2 months ago

Walkthrough

The pull request introduces significant enhancements to the Apollo client, primarily focused on integrating Kubernetes support. A new dependency for the Kubernetes Java client is added, along with the creation of classes and methods to manage configuration data through Kubernetes ConfigMaps. Key additions include the K8sConfigMapConfigRepository for configuration management, a KubernetesManager for interacting with ConfigMaps, and various utility methods for handling Kubernetes-specific properties. Additionally, tests for the new functionalities and updates to configuration metadata are included.

Changes

File	Change Summary
`apollo-client/pom.xml`	Added a dependency for the Kubernetes Java client (`io.kubernetes:client-java:18.0.0`) and updated the `<revision>` property.
`apollo-client/src/main/java/com/ctrip/framework/apollo/internals/K8sConfigMapConfigRepository.java`	Added the `K8sConfigMapConfigRepository` class for managing configuration in Kubernetes ConfigMaps, including multiple constructors and methods for synchronization, loading, and persisting configurations.
`apollo-client/src/main/java/com/ctrip/framework/apollo/spi/DefaultConfigFactory.java`	Modified the `createConfigRepository` method to prioritize Kubernetes caching and added a new method `createConfigMapConfigRepository` for creating a ConfigMap repository.
`apollo-client/src/main/java/com/ctrip/framework/apollo/util/ConfigUtil.java`	Introduced a new boolean field for Kubernetes cache enabling and methods to manage Kubernetes config map namespace retrieval and initialization.
`apollo-client/src/test/java/com/ctrip/framework/apollo/internals/K8sConfigMapConfigRepositoryTest.java`	Added a test class to validate the functionalities of `K8sConfigMapConfigRepository`, including setup, teardown, and various test cases for its methods.
`apollo-client/src/test/java/com/ctrip/framework/apollo/util/ConfigUtilTest.java`	Enhanced test coverage for `ConfigUtil` with new tests for Kubernetes config map namespace handling.
`apollo-core/src/main/java/com/ctrip/framework/apollo/core/ApolloClientSystemConsts.java`	Added new constants for Kubernetes configuration options, including cache namespace and enable flags.
`apollo-core/src/main/java/com/ctrip/framework/apollo/core/ConfigConsts.java`	Updated the `CLUSTER_NAMESPACE_SEPARATOR` constant and added a new default value for Kubernetes cache config map namespace.
`CHANGES.md`	Documented the new feature related to Kubernetes ConfigMap caching and included links to relevant pull requests.
`apollo-client/src/main/resources/META-INF/additional-spring-configuration-metadata.json`	Added new properties for enabling Kubernetes caching and specifying the Kubernetes config map namespace.
`apollo-client/src/main/java/com/ctrip/framework/apollo/kubernetes/KubernetesManager.java`	Introduced the `KubernetesManager` class for managing Kubernetes ConfigMaps, including methods for creating, updating, retrieving, and checking ConfigMaps.
`apollo-client/src/test/java/com/ctrip/framework/apollo/kubernetes/KubernetesManagerTest.java`	Added a test class for `KubernetesManager`, covering creation, retrieval, updating, and existence checking of ConfigMaps.
`apollo-client/src/main/java/com/ctrip/framework/apollo/util/escape/EscapeUtil.java`	Introduced the `EscapeUtil` class with methods for escaping namespaces and creating ConfigMap keys.

Possibly related PRs

#82: The changes in this PR involve modifications to the pom.xml file and the addition of a new dependency for the Kubernetes Java client, which directly relates to the main PR's addition of the same dependency in pom.xml.

🐰 In the fields where Kubernetes blooms,
A rabbit hops, dispelling glooms.
Configs managed with such delight,
In maps of green, they take their flight.
With every change, our joy expands,
Hopping high in code-filled lands! 🌱✨

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between f7ff6d9840db655a53e7b942b46a9f97e645eea6 and b8392ca48b9ce73ec16da717ea45c987af40d66a.

📒 Files selected for processing (3)

* apollo-client/src/main/java/com/ctrip/framework/apollo/kubernetes/KubernetesManager.java (1 hunks) * apollo-client/src/main/java/com/ctrip/framework/apollo/util/escape/EscapeUtil.java (1 hunks) * apollo-client/src/test/java/com/ctrip/framework/apollo/internals/K8sConfigMapConfigRepositoryTest.java (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

* apollo-client/src/main/java/com/ctrip/framework/apollo/kubernetes/KubernetesManager.java * apollo-client/src/main/java/com/ctrip/framework/apollo/util/escape/EscapeUtil.java * apollo-client/src/test/java/com/ctrip/framework/apollo/internals/K8sConfigMapConfigRepositoryTest.java

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

dyx1234 commented 2 months ago

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

dyx1234 commented 1 month ago

@shoothzj PTAL

apolloconfig / apollo-java