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

client.go

@@ -20,6 +20,7 @@ package agollo
 import (
 	"container/list"
 	"errors"
+	"github.com/apolloconfig/agollo/v4/store/configmap"
 	"strings"
 
 	"github.com/apolloconfig/agollo/v4/agcache"
@@ -114,6 +115,15 @@ func StartWithConfig(loadAppConfig func() (*config.AppConfig, error)) (Client, e
 		return nil, err
 	}
 
+	// set k8sManager before first sync
+	if appConfig.IsBackupConfigToConfigMap {
+		manager, err := configmap.GetK8sManager()
+		if err != nil {
+			return nil, err
+		}
+		extension.SetConfigMapHandler(&configmap.Store{K8sManager: manager})
+	}
+
 	c := create()
 	if appConfig != nil {
 		c.appConfig = appConfig

component/remote/async.go

@@ -147,7 +147,16 @@ func toApolloConfig(resBody []byte) ([]*config.Notification, error) {
 func loadBackupConfig(namespace string, appConfig config.AppConfig) []*config.ApolloConfig {
 	apolloConfigs := make([]*config.ApolloConfig, 0)
 	config.SplitNamespaces(namespace, func(namespace string) {
-		c, err := extension.GetFileHandler().LoadConfigFile(appConfig.BackupConfigPath, appConfig.AppID, namespace)
+		var c *config.ApolloConfig
+		var err error
+
+		// 增加configMap读取，但优先本地文件（configMap不支持灰度）
+		if appConfig.GetIsBackupConfig() {
+			c, err = extension.GetFileHandler().LoadConfigFile(appConfig.BackupConfigPath, appConfig.AppID, namespace)
+		} else if appConfig.GetIsBackupConfigToConfigMap() {
+			c, err = extension.GetConfigMapHandler().LoadConfigMap(appConfig, appConfig.ConfigMapNamespace)
+		}
+
 		if err != nil {
 			log.Errorf("LoadConfigFile error, error: %v", err)
 			return

env/config/config.go

@@ -41,15 +41,17 @@ type File interface {
 
 // AppConfig 配置文件
 type AppConfig struct {
-	AppID             string `json:"appId"`
-	Cluster           string `json:"cluster"`
-	NamespaceName     string `json:"namespaceName"`
-	IP                string `json:"ip"`
-	IsBackupConfig    bool   `default:"true" json:"isBackupConfig"`
-	BackupConfigPath  string `json:"backupConfigPath"`
-	Secret            string `json:"secret"`
-	Label             string `json:"label"`
-	SyncServerTimeout int    `json:"syncServerTimeout"`
+	AppID                     string `json:"appId"`
+	Cluster                   string `json:"cluster"`
+	NamespaceName             string `json:"namespaceName"`
+	IP                        string `json:"ip"`
+	IsBackupConfigToConfigMap bool   `default:"false" json:"isBackupConfigToConfigmap"`
+	ConfigMapNamespace        string `json:"configMapNamespace"`
+	IsBackupConfig            bool   `default:"true" json:"isBackupConfig"`
+	BackupConfigPath          string `json:"backupConfigPath"`
+	Secret                    string `json:"secret"`
+	Label                     string `json:"label"`
+	SyncServerTimeout         int    `json:"syncServerTimeout"`
 	// MustStart 可用于控制第一次同步必须成功
 	MustStart               bool `default:"false"`
 	notificationsMap        *notificationsMap
@@ -76,6 +78,20 @@ func (a *AppConfig) GetBackupConfigPath() string {
 	return a.BackupConfigPath
 }
 
+// GetIsBackupConfigToConfigMap whether backup config to configmap after fetch config from apollo
+// false : no (default)
+// true : yes
+func (a *AppConfig) GetIsBackupConfigToConfigMap() bool {
+	return a.IsBackupConfigToConfigMap
+}
+
+func (a *AppConfig) GetConfigMapNamespace() string {
+	if a.ConfigMapNamespace == "" {
+		a.ConfigMapNamespace = "default"
+	}
+	return a.ConfigMapNamespace
+}
+
 // GetHost GetHost
 func (a *AppConfig) GetHost() string {
 	u, err := url.Parse(a.IP)

extension/configmap.go

@@ -0,0 +1,32 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package extension
+
+import "github.com/apolloconfig/agollo/v4/store"
+
+var configMapHandler store.ConfigMapHandler
+
+// SetConfigMapHandler Set the ConfigMap cache handler
+func SetConfigMapHandler(inConfigMapHandler store.ConfigMapHandler) {
+	configMapHandler = inConfigMapHandler
+}
+
+// GetConfigMapHandler Get the ConfigMap cache handler
+func GetConfigMapHandler() store.ConfigMapHandler {
+	return configMapHandler
+}

extension/configmap_test.go

@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package extension
+
+import (
+	"github.com/apolloconfig/agollo/v4/env/config"
+	. "github.com/tevid/gohamcrest"
+	"testing"
+)
+
+type TestConfigMapHandler struct {
+}
+
+func (t *TestConfigMapHandler) LoadConfigMap(configMapNamespace string) (*config.ApolloConfig, error) {
+	return nil, nil
+}
+
+func (t *TestConfigMapHandler) WriteConfigMap(config *config.ApolloConfig, configMapNamespace string) error {
+	return nil
+}
+
+// TestSetConfigMapHandler 测试 SetConfigMapHandler 函数
+func TestSetConfigMapHandler(t *testing.T) {
+	SetConfigMapHandler(&TestConfigMapHandler{})
+
+	resultConfigMapHandler := GetConfigMapHandler()
+
+	Assert(t, resultConfigMapHandler, NotNilVal())
+}

go.mod

@@ -1,9 +1,66 @@
 module github.com/apolloconfig/agollo/v4
 
 require (
-	github.com/agiledragon/gomonkey/v2 v2.11.0 // indirect
+	github.com/agiledragon/gomonkey/v2 v2.11.0
 	github.com/spf13/viper v1.8.1
+	github.com/stretchr/testify v1.8.4
 	github.com/tevid/gohamcrest v1.1.1
+	k8s.io/api v0.30.1
+	k8s.io/apimachinery v0.30.1
+	k8s.io/client-go v0.30.1
 )
 
-go 1.13
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/emicklei/go-restful/v3 v3.11.0 // indirect
+	github.com/evanphx/json-patch v4.12.0+incompatible // indirect
+	github.com/fsnotify/fsnotify v1.4.9 // indirect
+	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/go-openapi/jsonpointer v0.19.6 // indirect
+	github.com/go-openapi/jsonreference v0.20.2 // indirect
+	github.com/go-openapi/swag v0.22.3 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/protobuf v1.5.4 // indirect
+	github.com/google/gnostic-models v0.6.8 // indirect
+	github.com/google/gofuzz v1.2.0 // indirect
+	github.com/google/uuid v1.3.0 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/magiconair/properties v1.8.5 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/mitchellh/mapstructure v1.4.1 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/pelletier/go-toml v1.9.3 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/spf13/afero v1.9.2 // indirect
+	github.com/spf13/cast v1.3.1 // indirect
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/subosito/gotenv v1.2.0 // indirect
+	golang.org/x/net v0.23.0 // indirect
+	golang.org/x/oauth2 v0.10.0 // indirect
+	golang.org/x/sys v0.18.0 // indirect
+	golang.org/x/term v0.18.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+	golang.org/x/time v0.3.0 // indirect
+	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/protobuf v1.33.0 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/ini.v1 v1.62.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	k8s.io/klog/v2 v2.120.1 // indirect
+	k8s.io/kube-openapi v0.0.0-20240228011516-70dd3763d340 // indirect
+	k8s.io/utils v0.0.0-20230726121419-3b25d923346b // indirect
+	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
+	sigs.k8s.io/yaml v1.3.0 // indirect
+)
+
+go 1.22.0
+
+toolchain go1.22.5