[OSPP]Support Kubernetes ConfigMap for Apollo java, golang client #79 #318
Conversation
WalkthroughThe changes introduce a configuration management feature that integrates Kubernetes ConfigMaps into the agollo package. This includes adding a handler for ConfigMaps, enhancing the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant App
participant ConfigMapHandler
participant K8sManager
User->>App: Request Configuration
App->>ConfigMapHandler: Load ConfigMap
ConfigMapHandler->>K8sManager: Get ConfigMap
K8sManager-->>ConfigMapHandler: Return ConfigMap Data
ConfigMapHandler-->>App: Return Loaded Configuration
App-->>User: Provide Configuration
Tip OpenAI O1 model for chat
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 (
|
|
感谢您提出Pull Request，我会尽快Review。我会在1-2日内进行查看或者回复，如果遇到节假日可能会处理较慢，敬请谅解。 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range and nitpick comments (2)
store/configMap/store_test.go (2)
52-99: Great test coverage for the happy path scenario!The
TestStore_LoadConfigMapfunction is well-structured and covers the successful loading of a ConfigMap. It initializes the necessary dependencies, creates a sample ConfigMap with comprehensive test data, and makes appropriate assertions to verify the expected behavior of theLoadConfigMapmethod.To further enhance the test coverage, consider adding more test cases to cover error scenarios and edge cases, such as:
- Loading a non-existent ConfigMap
- Handling errors during ConfigMap retrieval
- Dealing with invalid or malformed ConfigMap data
101-135: Excellent test coverage for the ConfigMap write operation!The
TestStore_WriteConfigMapfunction is well-structured and covers the successful writing of a ConfigMap. It initializes the necessary dependencies, prepares the test data, and makes appropriate assertions to verify the expected behavior of theWriteConfigMapmethod.To further improve the test coverage, consider adding more test cases to handle error scenarios and edge cases, such as:
- Writing a ConfigMap with invalid data
- Handling errors during ConfigMap creation or update
- Dealing with permission issues or other Kubernetes-related errors
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
go.sumis excluded by!**/*.sum
Files selected for processing (15)
- client.go (2 hunks)
- component/remote/async.go (1 hunks)
- env/config/config.go (2 hunks)
- extension/configmap.go (1 hunks)
- extension/configmap_test.go (1 hunks)
- go.mod (1 hunks)
- start.go (1 hunks)
- start_test.go (1 hunks)
- storage/repository.go (2 hunks)
- storage/repository_test.go (1 hunks)
- store/configMap/manager.go (1 hunks)
- store/configMap/manager_test.go (1 hunks)
- store/configMap/store.go (1 hunks)
- store/configMap/store_test.go (1 hunks)
- store/configmap.go (1 hunks)
Additional context used
golangci-lint
client.go
53-53: cannot use &configMap.Store{…} (value of type *configMap.Store) as store.ConfigMapHandler value in argument to extension.SetConfigMapHandler: *configMap.Store does not implement store.ConfigMapHandler (wrong type for method LoadConfigMap)
have LoadConfigMap(*config.ApolloConfig, string) (*config.ApolloConfig, error)
want LoadConfigMap(string) (*config.ApolloConfig, error)(typecheck)
Additional comments not posted (29)
store/configmap.go (1)
22-27: LGTM!The
ConfigMapHandlerinterface provides a clean abstraction for managing configuration maps. The method signatures are well-defined, and the comments provide clear explanations of the method behaviors. The code follows Go conventions and best practices.extension/configmap.go (2)
25-27: LGTM!The
SetConfigMapHandlerfunction correctly sets the globalconfigMapHandlervariable to the providedinConfigMapHandlerparameter. The function is exported, which is appropriate as it is intended to be used by other packages to set theconfigMapHandler.
30-32: LGTM!The
GetConfigMapHandlerfunction correctly returns the globalconfigMapHandlervariable. The function is exported, which is appropriate as it is intended to be used by other packages to get theconfigMapHandler.extension/configmap_test.go (4)
26-27: LGTM!The
TestConfigMapHandlerstruct is correctly defined. It appears to be a test stub for theConfigMapHandlerinterface.
29-31: LGTM!The
LoadConfigMapmethod is correctly defined on theTestConfigMapHandlerstruct. The method signature matches theConfigMapHandlerinterface. Returningnilvalues is appropriate for a test stub.
33-35: LGTM!The
WriteConfigMapmethod is correctly defined on theTestConfigMapHandlerstruct. The method signature matches theConfigMapHandlerinterface. Returning anilvalue is appropriate for a test stub.
38-44: LGTM!The
TestSetConfigMapHandlerfunction is a well-defined test case. It correctly tests the functionality of setting and retrieving theConfigMapHandler. The assertion ensures that the handler is properly set.store/configMap/store.go (2)
24-27: LGTM!The
Storestruct definition looks good. Using dependency injection for theK8sManageris a nice approach to make the code more testable.
38-44: LGTM!The
WriteConfigMapmethod looks good. It properly uses theAppID,Cluster, andNamespaceNameto uniquely identify the ConfigMap and the configuration key, which is consistent with theLoadConfigMapmethod. The error handling is also done correctly.start.go (6)
30-35: LGTM!The changes to
SetSignatureare limited to comment formatting and do not alter the functionality. The nil check ensures that only a validauthcomponent is set.
37-42: LGTM!The changes to
SetBackupFileHandlerare limited to comment formatting and do not alter the functionality. The nil check ensures that only a validfilecomponent is set.
44-49: New feature looks good!The new
SetConfigMapHandlerfunction enables setting a custom ConfigMap persistence component, which aligns with the PR objective of integrating Kubernetes ConfigMap as a new persistent storage solution. The nil check ensures that only a validconfigMapHandleris set.
51-56: LGTM!The changes to
SetLoadBalanceare limited to comment formatting and do not alter the functionality. The nil check ensures that only a validloadBalancecomponent is set.
58-63: LGTM!The changes to
SetLoggerare limited to comment formatting and do not alter the functionality. The nil check ensures that only a validloggerInterfaceis set.
Line range hint
65-70: LGTM!The changes to
SetCacheare limited to comment formatting and do not alter the functionality. The nil check ensures that only a validcacheFactoryis set.store/configMap/manager_test.go (2)
30-55: LGTM!The test function
TestK8sManager_SetConfigMapis well-written and covers the happy path scenario of setting a ConfigMap using theK8sManager. It follows a clear arrange-act-assert pattern, uses a fake Kubernetes client for testing, and makes comprehensive assertions to verify the expected behavior.
57-82: LGTM!The test function
TestK8sManager_GetConfigMapis well-written and covers the scenario of retrieving a ConfigMap using theK8sManager. It follows a clear arrange-act-assert pattern, uses a fake Kubernetes client with a pre-existing ConfigMap for testing, and makes assertions to verify that the returned configurations match the expected values.go.mod (1)
1-67: LGTM! The changes to thego.modfile align with the PR objectives.The updates to the
go.modfile, including the addition of Kubernetes-related dependencies, testing libraries, and configuration management libraries, are consistent with the PR objectives of implementing Kubernetes ConfigMap support and enhancing the module's capabilities.The updated Go version from
1.13to1.22.0may introduce new features and improvements that could benefit the module.Please ensure that the new dependencies are compatible with the updated Go version to avoid any potential integration issues. You can verify this by running the following commands:
If there are no errors or compatibility issues, the changes to the
go.modfile should be good to go.Verification successful
Go module dependencies look good and compatible
The analysis of the
go.modfile shows that the dependencies and Go version are up-to-date and compatible. Here are the key points:
- Go version 1.22.0 is specified, which is recent and supported.
- Direct dependencies, including Kubernetes-related packages, are at consistent versions.
- No version conflicts were detected among the dependencies.
The changes to the
go.modfile align well with the PR objectives and don't introduce any apparent compatibility issues.While the static analysis shows no issues, it's recommended that you perform a final manual verification in your development environment to ensure everything works as expected, especially regarding the Kubernetes integration and new dependencies.
Scripts executed
The following scripts were executed for the analysis:
Script:
go mod tidy go build ./... go test ./...Length of output: 256
Script:
#!/bin/bash # Display the content of go.mod file cat go.mod # Extract and display the Go version echo "Go version:" grep "^go " go.mod # Extract and display direct dependencies echo "Direct dependencies:" sed -n '/^require (/,/^)$/p' go.mod | grep -v "^require (" | grep -v "^)$" # Check for any potential version conflicts echo "Checking for potential version conflicts:" grep -P "v\d+\.\d+\.\d+" go.mod | sort | uniq -dLength of output: 5634
store/configMap/manager.go (3)
42-57: LGTM!The
GetK8sManagerfunction correctly initializes the singletonK8sManagerinstance using in-cluster configuration. It handles errors appropriately and ensures thread-safe lazy initialization usingsync.Once.
60-86: LGTM!The
SetConfigMapmethod correctly converts theApolloConfigdata to JSON and creates or updates a Kubernetes ConfigMap. It handles errors appropriately and sets a timeout for the API operations.
89-112: LGTM!The
GetConfigMapmethod correctly retrieves a ConfigMap, extracts JSON data for the given key, and unmarshals it into theConfigurationsfield of anApolloConfigstruct. It handles errors appropriately and sets a timeout for the API operation.component/remote/async.go (1)
150-158: LGTM!The changes introduce support for loading configurations from ConfigMaps as a fallback mechanism. The logic correctly prioritizes loading from the local backup file over the ConfigMap. This aligns with the PR objective of using ConfigMaps for persistent storage in Kubernetes environments.
The error handling is maintained by logging any issues encountered during the loading process.
env/config/config.go (3)
44-54: LGTM!The addition of the new fields
IsBackupConfigToConfigMapandConfigMapNamespaceto theAppConfigstruct, along with the clarifying comment for the existingIsBackupConfigfield, looks good. The default value offalseforIsBackupConfigToConfigMapensures that this feature is opt-in, and theConfigMapNamespacefield provides flexibility in specifying the namespace for the ConfigMap.
81-86: LGTM!The addition of the
GetIsBackupConfigToConfigMapgetter method to theAppConfigstruct looks good. The method name follows the Go naming convention, and it provides a way to retrieve the value of theIsBackupConfigToConfigMapfield.
88-90: LGTM!The addition of the
GetConfigMapNamespacegetter method to theAppConfigstruct looks good. The method name follows the Go naming convention, and it provides a way to retrieve the value of theConfigMapNamespacefield.start_test.go (1)
228-246: LGTM!The code changes introduce a new
testConfigMapHandlerstruct and its placeholder methodsLoadConfigMapandWriteConfigMap, which serve as a foundation for future implementation of loading and writing configurations to Kubernetes ConfigMaps.The
TestSetConfigMapHandlertest function ensures that the ConfigMap handler can be set and retrieved correctly, providing adequate coverage for the newly introducedSetConfigMapHandlerfunction.The code changes are well-structured, follow the existing coding style and conventions, and align with the larger effort to integrate Kubernetes ConfigMaps into the agollo package for configuration management.
client.go (1)
23-23: LGTM!The import statement is correct and necessary for the changes introduced in this file.
storage/repository_test.go (1)
61-61: LGTM!The TODO comment is a good reminder for a planned test enhancement. It does not alter any functionality at this time.
storage/repository.go (1)
Line range hint
456-492: LGTM!The changes to the
UpdateApolloConfigfunction look good:
- The new conditional check for writing the configuration to a ConfigMap follows the existing pattern for writing backup files.
- The
WriteConfigMapmethod from theConfigMapHandleris invoked with the appropriate parameters.- The changes maintain the existing code structure, style, and conventions.
| // TODO 在这里把json转为ApolloConfig, 但ReleaseKey字段会丢失 | ||
| config.Configurations, _ = c.K8sManager.GetConfigMap(configMapName, configMapNamespace, key) |
There was a problem hiding this comment.
Address the TODO comment about losing the ReleaseKey.
The comment indicates that the ReleaseKey field is lost when converting the JSON to ApolloConfig. This seems like an important piece of information that shouldn't be discarded. Please investigate this further and ensure that the ReleaseKey is properly handled.
| configMapName := config.AppID | ||
| key := config.Cluster + "+" + config.NamespaceName | ||
| // TODO 在这里把json转为ApolloConfig, 但ReleaseKey字段会丢失 | ||
| config.Configurations, _ = c.K8sManager.GetConfigMap(configMapName, configMapNamespace, key) |
There was a problem hiding this comment.
Handle the error returned from GetConfigMap.
The error returned from GetConfigMap is being ignored. It's a good practice to always handle errors. If an error occurs while retrieving the ConfigMap, it should be returned from the LoadConfigMap method so that the caller can handle it appropriately.
Modify the code to handle the error:
-config.Configurations, _ = c.K8sManager.GetConfigMap(configMapName, configMapNamespace, key)
+config.Configurations, err := c.K8sManager.GetConfigMap(configMapName, configMapNamespace, key)
+if err != nil {
+ return nil, err
+}Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| config.Configurations, _ = c.K8sManager.GetConfigMap(configMapName, configMapNamespace, key) | |
| config.Configurations, err := c.K8sManager.GetConfigMap(configMapName, configMapNamespace, key) | |
| if err != nil { | |
| return nil, err | |
| } |
| @@ -49,6 +50,7 @@ const separator = "," | |||
| func init() { | |||
| extension.SetCacheFactory(&memory.DefaultCacheFactory{}) | |||
| extension.SetLoadBalance(&roundrobin.RoundRobin{}) | |||
| extension.SetConfigMapHandler(&configMap.Store{configMap.GetK8sManager()}) | |||
There was a problem hiding this comment.
Type mismatch error in LoadConfigMap method signature.
The static analysis tool has correctly identified a type mismatch error in the LoadConfigMap method implemented by configMap.Store. The method signature does not match the one expected by the store.ConfigMapHandler interface:
have LoadConfigMap(*config.ApolloConfig, string) (*config.ApolloConfig, error)
want LoadConfigMap(string) (*config.ApolloConfig, error)
This error needs to be fixed to ensure the correct functionality of the configuration map handler.
Do you want me to suggest the necessary changes to fix this type mismatch error or open a GitHub issue to track this task?
Tools
golangci-lint
53-53: cannot use &configMap.Store{…} (value of type *configMap.Store) as store.ConfigMapHandler value in argument to extension.SetConfigMapHandler: *configMap.Store does not implement store.ConfigMapHandler (wrong type for method LoadConfigMap)
have LoadConfigMap(*config.ApolloConfig, string) (*config.ApolloConfig, error)
want LoadConfigMap(string) (*config.ApolloConfig, error)(typecheck)
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 apolloconfig/apollo#5210
Summary by CodeRabbit
New Features
Bug Fixes
Tests
Chores