feat: Add OpenIM server, environment support for Docker Compose, and Kubernetes deployment. (#1559)

* feat: add openim server code

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add openim env

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add openim mongo and redis env

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add zk and redis mongo env

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add kafka and redis mongo env

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add openim docker

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add openim docker

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add openim docker

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add openim copyright

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* fix: docker compose

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* fix: remove openim chat config file

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add openim config set

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add openim config set

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* fix: fix Security vulnerability

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* fix: fix Security vulnerability

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* fix: docker compose

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* Update kubernetes.go

* Update discoveryregister.go

* fix: copyright-add

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

---------

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

pkg/common/cmd/constant.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 cmd
 
 const (

pkg/common/config/config.go

@@ -16,6 +16,7 @@ package config
 
 import (
 	"bytes"
+
 	"github.com/OpenIMSDK/tools/discoveryregistry"
 	"gopkg.in/yaml.v3"
 )

pkg/common/config/parse.go

@@ -35,7 +35,7 @@ const (
 	DefaultFolderPath    = "../config/"
 )
 
-// return absolude path join ../config/, this is k8s container config path
+// return absolude path join ../config/, this is k8s container config path.
 func GetDefaultConfigPath() string {
 	b, err := filepath.Abs(os.Args[0])
 	if err != nil {
@@ -45,7 +45,7 @@ func GetDefaultConfigPath() string {
 	return filepath.Join(filepath.Dir(b), "../config/")
 }
 
-// getProjectRoot returns the absolute path of the project root directory
+// getProjectRoot returns the absolute path of the project root directory.
 func GetProjectRoot() string {
 	b, _ := filepath.Abs(os.Args[0])
 

pkg/common/convert/user.go

@@ -15,9 +15,10 @@
 package convert
 
 import (
-	"github.com/OpenIMSDK/protocol/sdkws"
 	"time"
 
+	"github.com/OpenIMSDK/protocol/sdkws"
+
 	relationtb "github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
 )
 

pkg/common/db/cache/group.go

@@ -39,7 +39,7 @@ const (
 	groupMemberIDsKey   = "GROUP_MEMBER_IDS:"
 	groupMembersHashKey = "GROUP_MEMBERS_HASH2:"
 	groupMemberInfoKey  = "GROUP_MEMBER_INFO:"
-	//groupOwnerInfoKey   = "GROUP_OWNER_INFO:"
+	//groupOwnerInfoKey   = "GROUP_OWNER_INFO:".
 	joinedGroupsKey            = "JOIN_GROUPS_KEY:"
 	groupMemberNumKey          = "GROUP_MEMBER_NUM_CACHE:"
 	groupRoleLevelMemberIDsKey = "GROUP_ROLE_LEVEL_MEMBER_IDS:"

pkg/common/db/cache/init_redis.go

@@ -18,6 +18,8 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
+	"strings"
 	"time"
 
 	"github.com/redis/go-redis/v9"
@@ -43,6 +45,9 @@ func NewRedis() (redis.UniversalClient, error) {
 		return redisClient, nil
 	}
 
+	// Read configuration from environment variables
+	overrideConfigFromEnv()
+
 	if len(config.Config.Redis.Address) == 0 {
 		return nil, errors.New("redis address is empty")
 	}
@@ -60,9 +65,9 @@ func NewRedis() (redis.UniversalClient, error) {
 		rdb = redis.NewClient(&redis.Options{
 			Addr:       config.Config.Redis.Address[0],
 			Username:   config.Config.Redis.Username,
-			Password:   config.Config.Redis.Password, // no password set
-			DB:         0,                            // use default DB
-			PoolSize:   100,                          // connection pool size
+			Password:   config.Config.Redis.Password,
+			DB:         0,   // use default DB
+			PoolSize:   100, // connection pool size
 			MaxRetries: maxRetry,
 		})
 	}
@@ -78,3 +83,16 @@ func NewRedis() (redis.UniversalClient, error) {
 	redisClient = rdb
 	return rdb, err
 }
+
+// overrideConfigFromEnv overrides configuration fields with environment variables if present.
+func overrideConfigFromEnv() {
+	if envAddr := os.Getenv("REDIS_ADDRESS"); envAddr != "" {
+		config.Config.Redis.Address = strings.Split(envAddr, ",") // Assuming addresses are comma-separated
+	}
+	if envUser := os.Getenv("REDIS_USERNAME"); envUser != "" {
+		config.Config.Redis.Username = envUser
+	}
+	if envPass := os.Getenv("REDIS_PASSWORD"); envPass != "" {
+		config.Config.Redis.Password = envPass
+	}
+}

pkg/common/db/cache/msg_test.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 cache
 
 import (

pkg/common/db/cache/s3.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 cache
 
 import (

pkg/common/db/mgo/black.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/conversation.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/friend.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/friend_request.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/group.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/group_member.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/group_request.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/log.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/object.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/mgo/user.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 mgo
 
 import (

pkg/common/db/s3/cos/internal.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 cos
 
 import (

pkg/common/db/s3/minio/internal.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 minio
 
 import (

pkg/common/db/s3/minio/thumbnail.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 minio
 
 import (

pkg/common/db/table/relation/log.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 relation
 
 import (

pkg/common/db/unrelation/mongo.go

@@ -17,11 +17,11 @@ package unrelation
 import (
 	"context"
 	"fmt"
+	"os"
 	"strings"
 	"time"
 
 	"go.mongodb.org/mongo-driver/bson"
-
 	"go.mongodb.org/mongo-driver/mongo"
 	"go.mongodb.org/mongo-driver/mongo/options"
 
@@ -34,7 +34,8 @@ import (
 )
 
 const (
-	maxRetry = 10 // number of retries
+	maxRetry         = 10 // number of retries
+	mongoConnTimeout = 10 * time.Second
 )
 
 type Mongo struct {
@@ -44,90 +45,122 @@ type Mongo struct {
 // NewMongo Initialize MongoDB connection.
 func NewMongo() (*Mongo, error) {
 	specialerror.AddReplace(mongo.ErrNoDocuments, errs.ErrRecordNotFound)
-	uri := "mongodb://sample.host:27017/?maxPoolSize=20&w=majority"
-	if config.Config.Mongo.Uri != "" {
-		uri = config.Config.Mongo.Uri
-	} else {
-		mongodbHosts := ""
-		for i, v := range config.Config.Mongo.Address {
-			if i == len(config.Config.Mongo.Address)-1 {
-				mongodbHosts += v
-			} else {
-				mongodbHosts += v + ","
-			}
-		}
-		if config.Config.Mongo.Password != "" && config.Config.Mongo.Username != "" {
-			uri = fmt.Sprintf("mongodb://%s:%s@%s/%s?maxPoolSize=%d&authSource=admin",
-				config.Config.Mongo.Username, config.Config.Mongo.Password, mongodbHosts,
-				config.Config.Mongo.Database, config.Config.Mongo.MaxPoolSize)
-		} else {
-			uri = fmt.Sprintf("mongodb://%s/%s/?maxPoolSize=%d&authSource=admin",
-				mongodbHosts, config.Config.Mongo.Database,
-				config.Config.Mongo.MaxPoolSize)
-		}
-	}
-	fmt.Println("mongo:", uri)
+	uri := buildMongoURI()
+
 	var mongoClient *mongo.Client
-	var err error = nil
+	var err error
+
+	// Retry connecting to MongoDB
 	for i := 0; i <= maxRetry; i++ {
-		ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
+		ctx, cancel := context.WithTimeout(context.Background(), mongoConnTimeout)
 		defer cancel()
 		mongoClient, err = mongo.Connect(ctx, options.Client().ApplyURI(uri))
 		if err == nil {
 			return &Mongo{db: mongoClient}, nil
 		}
-		if cmdErr, ok := err.(mongo.CommandError); ok {
-			if cmdErr.Code == 13 || cmdErr.Code == 18 {
-				return nil, err
-			} else {
-				fmt.Printf("Failed to connect to MongoDB: %s\n", err)
-			}
+		if shouldRetry(err) {
+			fmt.Printf("Failed to connect to MongoDB, retrying: %s\n", err)
+			time.Sleep(time.Second) // exponential backoff could be implemented here
+			continue
 		}
+		return nil, err
 	}
 	return nil, err
 }
 
+func buildMongoURI() string {
+	uri := os.Getenv("MONGO_URI")
+	if uri != "" {
+		return uri
+	}
+
+	username := os.Getenv("MONGO_USERNAME")
+	password := os.Getenv("MONGO_PASSWORD")
+	address := os.Getenv("MONGO_ADDRESS")
+	port := os.Getenv("MONGO_PORT")
+	database := os.Getenv("MONGO_DATABASE")
+	maxPoolSize := os.Getenv("MONGO_MAX_POOL_SIZE")
+
+	if username == "" {
+		username = config.Config.Mongo.Username
+	}
+	if password == "" {
+		password = config.Config.Mongo.Password
+	}
+	if address == "" {
+		address = strings.Join(config.Config.Mongo.Address, ",")
+	} else if port != "" {
+		address = fmt.Sprintf("%s:%s", address, port)
+	}
+	if database == "" {
+		database = config.Config.Mongo.Database
+	}
+	if maxPoolSize == "" {
+		maxPoolSize = fmt.Sprint(config.Config.Mongo.MaxPoolSize)
+	}
+
+	uriFormat := "mongodb://%s/%s?maxPoolSize=%s&authSource=admin"
+	if username != "" && password != "" {
+		uriFormat = "mongodb://%s:%s@%s/%s?maxPoolSize=%s&authSource=admin"
+		return fmt.Sprintf(uriFormat, username, password, address, database, maxPoolSize)
+	}
+	return fmt.Sprintf(uriFormat, address, database, maxPoolSize)
+}
+
+func shouldRetry(err error) bool {
+	if cmdErr, ok := err.(mongo.CommandError); ok {
+		return cmdErr.Code != 13 && cmdErr.Code != 18
+	}
+	return true
+}
+
+// GetClient returns the MongoDB client.
 func (m *Mongo) GetClient() *mongo.Client {
 	return m.db
 }
 
+// GetDatabase returns the specific database from MongoDB.
 func (m *Mongo) GetDatabase() *mongo.Database {
 	return m.db.Database(config.Config.Mongo.Database)
 }
 
+// CreateMsgIndex creates an index for messages in MongoDB.
 func (m *Mongo) CreateMsgIndex() error {
 	return m.createMongoIndex(unrelation.Msg, true, "doc_id")
 }
 
+// createMongoIndex creates an index in a MongoDB collection.
 func (m *Mongo) createMongoIndex(collection string, isUnique bool, keys ...string) error {
-	db := m.db.Database(config.Config.Mongo.Database).Collection(collection)
+	db := m.GetDatabase().Collection(collection)
 	opts := options.CreateIndexes().SetMaxTime(10 * time.Second)
 	indexView := db.Indexes()
-	keysDoc := bson.D{}
-	// create composite indexes
-	for _, key := range keys {
-		if strings.HasPrefix(key, "-") {
-			keysDoc = append(keysDoc, bson.E{Key: strings.TrimLeft(key, "-"), Value: -1})
-			// keysDoc = keysDoc.Append(strings.TrimLeft(key, "-"), bsonx.Int32(-1))
-		} else {
-			keysDoc = append(keysDoc, bson.E{Key: key, Value: 1})
-			// keysDoc = keysDoc.Append(key, bsonx.Int32(1))
-		}
-	}
-	// create index
+
+	keysDoc := buildIndexKeys(keys)
+
 	index := mongo.IndexModel{
 		Keys: keysDoc,
 	}
 	if isUnique {
 		index.Options = options.Index().SetUnique(true)
 	}
-	result, err := indexView.CreateOne(
-		context.Background(),
-		index,
-		opts,
-	)
+
+	_, err := indexView.CreateOne(context.Background(), index, opts)
 	if err != nil {
-		return utils.Wrap(err, result)
+		return utils.Wrap(err, "CreateIndex")
 	}
 	return nil
 }
+
+// buildIndexKeys builds the BSON document for index keys.
+func buildIndexKeys(keys []string) bson.D {
+	keysDoc := bson.D{}
+	for _, key := range keys {
+		direction := 1 // default direction is ascending
+		if strings.HasPrefix(key, "-") {
+			direction = -1 // descending order for prefixed with "-"
+			key = strings.TrimLeft(key, "-")
+		}
+		keysDoc = append(keysDoc, bson.E{Key: key, Value: direction})
+	}
+	return keysDoc
+}

pkg/common/discoveryregister/discoveryregister.go

@@ -1,159 +1,42 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 discoveryregister
 
 import (
-	"context"
 	"errors"
-	"fmt"
 	"os"
-	"strconv"
-	"strings"
-	"time"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister/kubernetes"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister/zookeeper"
 
 	"github.com/OpenIMSDK/tools/discoveryregistry"
-	openkeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
-	"github.com/OpenIMSDK/tools/log"
-	"google.golang.org/grpc"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
+// NewDiscoveryRegister creates a new service discovery and registry client based on the provided environment type.
 func NewDiscoveryRegister(envType string) (discoveryregistry.SvcDiscoveryRegistry, error) {
-	var client discoveryregistry.SvcDiscoveryRegistry
-	var err error
+
+	if os.Getenv("ENVS_DISCOVERY") != "" {
+		envType = os.Getenv("ENVS_DISCOVERY")
+	}
+
 	switch envType {
 	case "zookeeper":
-		client, err = openkeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
-			openkeeper.WithFreq(time.Hour), openkeeper.WithUserNameAndPassword(
-				config.Config.Zookeeper.Username,
-				config.Config.Zookeeper.Password,
-			), openkeeper.WithRoundRobin(), openkeeper.WithTimeout(10), openkeeper.WithLogger(log.NewZkLogger()))
+		return zookeeper.NewZookeeperDiscoveryRegister()
 	case "k8s":
-		client, err = NewK8sDiscoveryRegister()
+		return kubernetes.NewK8sDiscoveryRegister()
 	default:
-		client = nil
-		err = errors.New("envType not correct")
-	}
-	return client, err
-}
-
-type K8sDR struct {
-	options         []grpc.DialOption
-	rpcRegisterAddr string
-}
-
-func NewK8sDiscoveryRegister() (discoveryregistry.SvcDiscoveryRegistry, error) {
-	return &K8sDR{}, nil
-}
-
-func (cli *K8sDR) Register(serviceName, host string, port int, opts ...grpc.DialOption) error {
-	if serviceName != config.Config.RpcRegisterName.OpenImMessageGatewayName {
-		cli.rpcRegisterAddr = serviceName
-	} else {
-		cli.rpcRegisterAddr = cli.getSelfHost(context.Background())
-	}
-
-	return nil
-}
-func (cli *K8sDR) UnRegister() error {
-
-	return nil
-}
-func (cli *K8sDR) CreateRpcRootNodes(serviceNames []string) error {
-
-	return nil
-}
-func (cli *K8sDR) RegisterConf2Registry(key string, conf []byte) error {
-
-	return nil
-}
-
-func (cli *K8sDR) GetConfFromRegistry(key string) ([]byte, error) {
-
-	return nil, nil
-}
-func (cli *K8sDR) getSelfHost(ctx context.Context) string {
-	port := 88
-	instance := "openimserver"
-	selfPodName := os.Getenv("MY_POD_NAME")
-	ns := os.Getenv("MY_POD_NAMESPACE")
-	statefuleIndex := 0
-	gatewayEnds := strings.Split(config.Config.RpcRegisterName.OpenImMessageGatewayName, ":")
-	if len(gatewayEnds) != 2 {
-		log.ZError(ctx, "msggateway RpcRegisterName is error:config.Config.RpcRegisterName.OpenImMessageGatewayName", errors.New("config error"))
-	} else {
-		port, _ = strconv.Atoi(gatewayEnds[1])
-	}
-	podInfo := strings.Split(selfPodName, "-")
-	instance = podInfo[0]
-	count := len(podInfo)
-	statefuleIndex, _ = strconv.Atoi(podInfo[count-1])
-	host := fmt.Sprintf("%s-openim-msggateway-%d.%s-openim-msggateway-headless.%s.svc.cluster.local:%d", instance, statefuleIndex, instance, ns, port)
-	return host
-}
-
-// like openimserver-openim-msggateway-0.openimserver-openim-msggateway-headless.openim-lin.svc.cluster.local:88
-func (cli *K8sDR) getMsgGatewayHost(ctx context.Context) []string {
-	port := 88
-	instance := "openimserver"
-	selfPodName := os.Getenv("MY_POD_NAME")
-	replicas := os.Getenv("MY_MSGGATEWAY_REPLICACOUNT")
-	ns := os.Getenv("MY_POD_NAMESPACE")
-	gatewayEnds := strings.Split(config.Config.RpcRegisterName.OpenImMessageGatewayName, ":")
-	if len(gatewayEnds) != 2 {
-		log.ZError(ctx, "msggateway RpcRegisterName is error:config.Config.RpcRegisterName.OpenImMessageGatewayName", errors.New("config error"))
-	} else {
-		port, _ = strconv.Atoi(gatewayEnds[1])
-	}
-	nReplicas, _ := strconv.Atoi(replicas)
-	podInfo := strings.Split(selfPodName, "-")
-	instance = podInfo[0]
-	var ret []string
-	for i := 0; i < nReplicas; i++ {
-		host := fmt.Sprintf("%s-openim-msggateway-%d.%s-openim-msggateway-headless.%s.svc.cluster.local:%d", instance, i, instance, ns, port)
-		ret = append(ret, host)
-	}
-	log.ZInfo(ctx, "getMsgGatewayHost", "instance", instance, "selfPodName", selfPodName, "replicas", replicas, "ns", ns, "ret", ret)
-	return ret
-}
-func (cli *K8sDR) GetConns(ctx context.Context, serviceName string, opts ...grpc.DialOption) ([]*grpc.ClientConn, error) {
-
-	if serviceName != config.Config.RpcRegisterName.OpenImMessageGatewayName {
-		conn, err := grpc.DialContext(ctx, serviceName, append(cli.options, opts...)...)
-		return []*grpc.ClientConn{conn}, err
-	} else {
-		var ret []*grpc.ClientConn
-		gatewayHosts := cli.getMsgGatewayHost(ctx)
-		for _, host := range gatewayHosts {
-			conn, err := grpc.DialContext(ctx, host, append(cli.options, opts...)...)
-			if err != nil {
-				return nil, err
-			} else {
-				ret = append(ret, conn)
-			}
-		}
-		return ret, nil
+		return nil, errors.New("envType not correct")
 	}
 }
-func (cli *K8sDR) GetConn(ctx context.Context, serviceName string, opts ...grpc.DialOption) (*grpc.ClientConn, error) {
-
-	return grpc.DialContext(ctx, serviceName, append(cli.options, opts...)...)
-}
-func (cli *K8sDR) GetSelfConnTarget() string {
-
-	return cli.rpcRegisterAddr
-}
-func (cli *K8sDR) AddOption(opts ...grpc.DialOption) {
-	cli.options = append(cli.options, opts...)
-}
-func (cli *K8sDR) CloseConn(conn *grpc.ClientConn) {
-	conn.Close()
-}
-
-// do not use this method for call rpc
-func (cli *K8sDR) GetClientLocalConns() map[string][]*grpc.ClientConn {
-	fmt.Println("should not call this function!!!!!!!!!!!!!!!!!!!!!!!!!")
-	return nil
-}
-func (cli *K8sDR) Close() {
-	return
-}

pkg/common/discoveryregister/discoveryregister_test.go

@@ -1,407 +1,59 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 discoveryregister
 
 import (
-	"context"
-	"reflect"
+	"os"
 	"testing"
 
 	"github.com/OpenIMSDK/tools/discoveryregistry"
-	"google.golang.org/grpc"
+	"github.com/stretchr/testify/assert"
 )
 
+func setupTestEnvironment() {
+	os.Setenv("ZOOKEEPER_SCHEMA", "openim")
+	os.Setenv("ZOOKEEPER_ADDRESS", "172.28.0.1:12181")
+	os.Setenv("ZOOKEEPER_USERNAME", "")
+	os.Setenv("ZOOKEEPER_PASSWORD", "")
+}
+
 func TestNewDiscoveryRegister(t *testing.T) {
-	type args struct {
-		envType string
-	}
-	tests := []struct {
-		name    string
-		args    args
-		want    discoveryregistry.SvcDiscoveryRegistry
-		wantErr bool
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got, err := NewDiscoveryRegister(tt.args.envType)
-			if (err != nil) != tt.wantErr {
-				t.Errorf("NewDiscoveryRegister() error = %v, wantErr %v", err, tt.wantErr)
-				return
-			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("NewDiscoveryRegister() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
+	setupTestEnvironment()
 
-func TestNewK8sDiscoveryRegister(t *testing.T) {
 	tests := []struct {
-		name    string
-		want    discoveryregistry.SvcDiscoveryRegistry
-		wantErr bool
+		envType        string
+		expectedError  bool
+		expectedResult bool
 	}{
-		// TODO: Add test cases.
+		{"zookeeper", false, true},
+		{"k8s", false, true}, // 假设 k8s 配置也已正确设置
+		{"invalid", true, false},
 	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got, err := NewK8sDiscoveryRegister()
-			if (err != nil) != tt.wantErr {
-				t.Errorf("NewK8sDiscoveryRegister() error = %v, wantErr %v", err, tt.wantErr)
-				return
-			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("NewK8sDiscoveryRegister() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
 
-func TestK8sDR_Register(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	type args struct {
-		serviceName string
-		host        string
-		port        int
-		opts        []grpc.DialOption
-	}
-	tests := []struct {
-		name    string
-		fields  fields
-		args    args
-		wantErr bool
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			if err := cli.Register(tt.args.serviceName, tt.args.host, tt.args.port, tt.args.opts...); (err != nil) != tt.wantErr {
-				t.Errorf("K8sDR.Register() error = %v, wantErr %v", err, tt.wantErr)
-			}
-		})
-	}
-}
+	for _, test := range tests {
+		client, err := NewDiscoveryRegister(test.envType)
 
-func TestK8sDR_UnRegister(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	tests := []struct {
-		name    string
-		fields  fields
-		wantErr bool
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
+		if test.expectedError {
+			assert.Error(t, err)
+		} else {
+			assert.NoError(t, err)
+			if test.expectedResult {
+				assert.Implements(t, (*discoveryregistry.SvcDiscoveryRegistry)(nil), client)
+			} else {
+				assert.Nil(t, client)
 			}
-			if err := cli.UnRegister(); (err != nil) != tt.wantErr {
-				t.Errorf("K8sDR.UnRegister() error = %v, wantErr %v", err, tt.wantErr)
-			}
-		})
-	}
-}
-
-func TestK8sDR_CreateRpcRootNodes(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	type args struct {
-		serviceNames []string
-	}
-	tests := []struct {
-		name    string
-		fields  fields
-		args    args
-		wantErr bool
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			if err := cli.CreateRpcRootNodes(tt.args.serviceNames); (err != nil) != tt.wantErr {
-				t.Errorf("K8sDR.CreateRpcRootNodes() error = %v, wantErr %v", err, tt.wantErr)
-			}
-		})
-	}
-}
-
-func TestK8sDR_RegisterConf2Registry(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	type args struct {
-		key  string
-		conf []byte
-	}
-	tests := []struct {
-		name    string
-		fields  fields
-		args    args
-		wantErr bool
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			if err := cli.RegisterConf2Registry(tt.args.key, tt.args.conf); (err != nil) != tt.wantErr {
-				t.Errorf("K8sDR.RegisterConf2Registry() error = %v, wantErr %v", err, tt.wantErr)
-			}
-		})
-	}
-}
-
-func TestK8sDR_GetConfFromRegistry(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	type args struct {
-		key string
-	}
-	tests := []struct {
-		name    string
-		fields  fields
-		args    args
-		want    []byte
-		wantErr bool
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			got, err := cli.GetConfFromRegistry(tt.args.key)
-			if (err != nil) != tt.wantErr {
-				t.Errorf("K8sDR.GetConfFromRegistry() error = %v, wantErr %v", err, tt.wantErr)
-				return
-			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("K8sDR.GetConfFromRegistry() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
-
-func TestK8sDR_GetConns(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	type args struct {
-		ctx         context.Context
-		serviceName string
-		opts        []grpc.DialOption
-	}
-	tests := []struct {
-		name    string
-		fields  fields
-		args    args
-		want    []*grpc.ClientConn
-		wantErr bool
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			got, err := cli.GetConns(tt.args.ctx, tt.args.serviceName, tt.args.opts...)
-			if (err != nil) != tt.wantErr {
-				t.Errorf("K8sDR.GetConns() error = %v, wantErr %v", err, tt.wantErr)
-				return
-			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("K8sDR.GetConns() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
-
-func TestK8sDR_GetConn(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	type args struct {
-		ctx         context.Context
-		serviceName string
-		opts        []grpc.DialOption
-	}
-	tests := []struct {
-		name    string
-		fields  fields
-		args    args
-		want    *grpc.ClientConn
-		wantErr bool
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			got, err := cli.GetConn(tt.args.ctx, tt.args.serviceName, tt.args.opts...)
-			if (err != nil) != tt.wantErr {
-				t.Errorf("K8sDR.GetConn() error = %v, wantErr %v", err, tt.wantErr)
-				return
-			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("K8sDR.GetConn() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
-
-func TestK8sDR_GetSelfConnTarget(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	tests := []struct {
-		name   string
-		fields fields
-		want   string
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			if got := cli.GetSelfConnTarget(); got != tt.want {
-				t.Errorf("K8sDR.GetSelfConnTarget() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
-
-func TestK8sDR_AddOption(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	type args struct {
-		opts []grpc.DialOption
-	}
-	tests := []struct {
-		name   string
-		fields fields
-		args   args
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			cli.AddOption(tt.args.opts...)
-		})
-	}
-}
-
-func TestK8sDR_CloseConn(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	type args struct {
-		conn *grpc.ClientConn
-	}
-	tests := []struct {
-		name   string
-		fields fields
-		args   args
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			cli.CloseConn(tt.args.conn)
-		})
-	}
-}
-
-func TestK8sDR_GetClientLocalConns(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	tests := []struct {
-		name   string
-		fields fields
-		want   map[string][]*grpc.ClientConn
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			if got := cli.GetClientLocalConns(); !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("K8sDR.GetClientLocalConns() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
-
-func TestK8sDR_Close(t *testing.T) {
-	type fields struct {
-		options         []grpc.DialOption
-		rpcRegisterAddr string
-	}
-	tests := []struct {
-		name   string
-		fields fields
-	}{
-		// TODO: Add test cases.
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cli := &K8sDR{
-				options:         tt.fields.options,
-				rpcRegisterAddr: tt.fields.rpcRegisterAddr,
-			}
-			cli.Close()
-		})
+		}
 	}
 }

pkg/common/discoveryregister/kubernetes/kubernetes.go

@@ -0,0 +1,174 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 kubernetes
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"os"
+	"strconv"
+	"strings"
+
+	"google.golang.org/grpc"
+
+	"github.com/OpenIMSDK/tools/discoveryregistry"
+	"github.com/OpenIMSDK/tools/log"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+)
+
+// K8sDR represents the Kubernetes service discovery and registration client.
+type K8sDR struct {
+	options         []grpc.DialOption
+	rpcRegisterAddr string
+}
+
+// NewK8sDiscoveryRegister creates a new instance of K8sDR for Kubernetes service discovery and registration.
+func NewK8sDiscoveryRegister() (discoveryregistry.SvcDiscoveryRegistry, error) {
+
+	return &K8sDR{}, nil
+}
+
+// Register registers a service with Kubernetes.
+func (cli *K8sDR) Register(serviceName, host string, port int, opts ...grpc.DialOption) error {
+	if serviceName != config.Config.RpcRegisterName.OpenImMessageGatewayName {
+		cli.rpcRegisterAddr = serviceName
+	} else {
+		cli.rpcRegisterAddr = cli.getSelfHost(context.Background())
+	}
+
+	return nil
+}
+
+// UnRegister removes a service registration from Kubernetes.
+func (cli *K8sDR) UnRegister() error {
+
+	return nil
+}
+
+// CreateRpcRootNodes creates root nodes for RPC in Kubernetes.
+func (cli *K8sDR) CreateRpcRootNodes(serviceNames []string) error {
+
+	return nil
+}
+
+// RegisterConf2Registry registers a configuration to the registry.
+func (cli *K8sDR) RegisterConf2Registry(key string, conf []byte) error {
+
+	return nil
+}
+
+// GetConfFromRegistry retrieves a configuration from the registry.
+func (cli *K8sDR) GetConfFromRegistry(key string) ([]byte, error) {
+	return nil, nil
+}
+
+func (cli *K8sDR) getSelfHost(ctx context.Context) string {
+	port := 88
+	instance := "openimserver"
+	selfPodName := os.Getenv("MY_POD_NAME")
+	ns := os.Getenv("MY_POD_NAMESPACE")
+	statefuleIndex := 0
+	gatewayEnds := strings.Split(config.Config.RpcRegisterName.OpenImMessageGatewayName, ":")
+	if len(gatewayEnds) != 2 {
+		log.ZError(ctx, "msggateway RpcRegisterName is error:config.Config.RpcRegisterName.OpenImMessageGatewayName", errors.New("config error"))
+	} else {
+		port, _ = strconv.Atoi(gatewayEnds[1])
+	}
+	podInfo := strings.Split(selfPodName, "-")
+	instance = podInfo[0]
+	count := len(podInfo)
+	statefuleIndex, _ = strconv.Atoi(podInfo[count-1])
+	host := fmt.Sprintf("%s-openim-msggateway-%d.%s-openim-msggateway-headless.%s.svc.cluster.local:%d", instance, statefuleIndex, instance, ns, port)
+	return host
+}
+
+// GetConns returns a list of gRPC client connections for a given service.
+func (cli *K8sDR) GetConns(ctx context.Context, serviceName string, opts ...grpc.DialOption) ([]*grpc.ClientConn, error) {
+	if serviceName != config.Config.RpcRegisterName.OpenImMessageGatewayName {
+		conn, err := grpc.DialContext(ctx, serviceName, append(cli.options, opts...)...)
+		return []*grpc.ClientConn{conn}, err
+	}
+	var ret []*grpc.ClientConn
+	gatewayHosts := cli.getMsgGatewayHost(ctx)
+	for _, host := range gatewayHosts {
+		conn, err := grpc.DialContext(ctx, host, append(cli.options, opts...)...)
+		if err != nil {
+			return nil, err
+		}
+		ret = append(ret, conn)
+	}
+	return ret, nil
+}
+
+// like openimserver-openim-msggateway-0.openimserver-openim-msggateway-headless.openim-lin.svc.cluster.local:88
+func (cli *K8sDR) getMsgGatewayHost(ctx context.Context) []string {
+	port := 88
+	instance := "openimserver"
+	selfPodName := os.Getenv("MY_POD_NAME")
+	replicas := os.Getenv("MY_MSGGATEWAY_REPLICACOUNT")
+	ns := os.Getenv("MY_POD_NAMESPACE")
+	gatewayEnds := strings.Split(config.Config.RpcRegisterName.OpenImMessageGatewayName, ":")
+	if len(gatewayEnds) != 2 {
+		log.ZError(ctx, "msggateway RpcRegisterName is error:config.Config.RpcRegisterName.OpenImMessageGatewayName", errors.New("config error"))
+	} else {
+		port, _ = strconv.Atoi(gatewayEnds[1])
+	}
+	nReplicas, _ := strconv.Atoi(replicas)
+	podInfo := strings.Split(selfPodName, "-")
+	instance = podInfo[0]
+	var ret []string
+	for i := 0; i < nReplicas; i++ {
+		host := fmt.Sprintf("%s-openim-msggateway-%d.%s-openim-msggateway-headless.%s.svc.cluster.local:%d", instance, i, instance, ns, port)
+		ret = append(ret, host)
+	}
+	log.ZInfo(ctx, "getMsgGatewayHost", "instance", instance, "selfPodName", selfPodName, "replicas", replicas, "ns", ns, "ret", ret)
+
+	return ret
+}
+
+// GetConn returns a single gRPC client connection for a given service.
+func (cli *K8sDR) GetConn(ctx context.Context, serviceName string, opts ...grpc.DialOption) (*grpc.ClientConn, error) {
+	return grpc.DialContext(ctx, serviceName, append(cli.options, opts...)...)
+}
+
+// GetSelfConnTarget returns the connection target of the client itself.
+func (cli *K8sDR) GetSelfConnTarget() string {
+	return cli.rpcRegisterAddr
+}
+
+// AddOption adds gRPC dial options to the client.
+func (cli *K8sDR) AddOption(opts ...grpc.DialOption) {
+	cli.options = append(cli.options, opts...)
+}
+
+// CloseConn closes a given gRPC client connection.
+func (cli *K8sDR) CloseConn(conn *grpc.ClientConn) {
+	conn.Close()
+}
+
+// do not use this method for call rpc.
+func (cli *K8sDR) GetClientLocalConns() map[string][]*grpc.ClientConn {
+	fmt.Println("should not call this function!!!!!!!!!!!!!!!!!!!!!!!!!")
+
+	return nil
+}
+
+// Close closes the K8sDR client.
+func (cli *K8sDR) Close() {
+
+	// Close any open resources here (if applicable)
+	return
+}

pkg/common/discoveryregister/zookeeper/zookeeper.go

@@ -0,0 +1,61 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 zookeeper
+
+import (
+	"os"
+	"strings"
+	"time"
+
+	"github.com/OpenIMSDK/tools/discoveryregistry"
+	openkeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
+	"github.com/OpenIMSDK/tools/log"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+)
+
+// NewZookeeperDiscoveryRegister creates a new instance of ZookeeperDR for Zookeeper service discovery and registration.
+func NewZookeeperDiscoveryRegister() (discoveryregistry.SvcDiscoveryRegistry, error) {
+	schema := getEnv("ZOOKEEPER_SCHEMA", config.Config.Zookeeper.Schema)
+	zkAddr := getZkAddrFromEnv(config.Config.Zookeeper.ZkAddr)
+	username := getEnv("ZOOKEEPER_USERNAME", config.Config.Zookeeper.Username)
+	password := getEnv("ZOOKEEPER_PASSWORD", config.Config.Zookeeper.Password)
+
+	return openkeeper.NewClient(
+		zkAddr,
+		schema,
+		openkeeper.WithFreq(time.Hour),
+		openkeeper.WithUserNameAndPassword(username, password),
+		openkeeper.WithRoundRobin(),
+		openkeeper.WithTimeout(10),
+		openkeeper.WithLogger(log.NewZkLogger()),
+	)
+}
+
+// getEnv returns the value of an environment variable if it exists, otherwise it returns the fallback value.
+func getEnv(key, fallback string) string {
+	if value, exists := os.LookupEnv(key); exists {
+		return value
+	}
+	return fallback
+}
+
+// getZkAddrFromEnv returns the value of an environment variable if it exists, otherwise it returns the fallback value.
+func getZkAddrFromEnv(fallback []string) []string {
+	if value, exists := os.LookupEnv("ZOOKEEPER_ADDRESS"); exists {
+		return strings.Split(value, ",")
+	}
+	return fallback
+}

pkg/common/ginprometheus/ginprometheus.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 ginprometheus
 
 import (

pkg/common/kafka/producer.go

@@ -21,19 +21,18 @@ import (
 	"strings"
 	"time"
 
+	"github.com/IBM/sarama"
 	"github.com/OpenIMSDK/protocol/constant"
-	log "github.com/OpenIMSDK/tools/log"
+	"github.com/OpenIMSDK/tools/log"
 	"github.com/OpenIMSDK/tools/mcontext"
 	"github.com/OpenIMSDK/tools/utils"
+	"google.golang.org/protobuf/proto"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
-
-	"github.com/IBM/sarama"
-	"google.golang.org/protobuf/proto"
 )
 
 const (
-	maxRetry = 10 // number of retries
+	maxRetry = 10 // Maximum number of retries for producer creation
 )
 
 var errEmptyMsg = errors.New("binary msg is empty")
@@ -45,62 +44,85 @@ type Producer struct {
 	producer sarama.SyncProducer
 }
 
-// NewKafkaProducer Initialize kafka producer.
+// NewKafkaProducer initializes a new Kafka producer.
 func NewKafkaProducer(addr []string, topic string) *Producer {
-	p := Producer{}
-	p.config = sarama.NewConfig()             // Instantiate a sarama Config
-	p.config.Producer.Return.Successes = true // Whether to enable the successes channel to be notified after the message is sent successfully
+	p := Producer{
+		addr:   addr,
+		topic:  topic,
+		config: sarama.NewConfig(),
+	}
+
+	// Set producer return flags
+	p.config.Producer.Return.Successes = true
 	p.config.Producer.Return.Errors = true
-	p.config.Producer.Partitioner = sarama.NewHashPartitioner // Set the hash-key automatic hash partition. When sending a message, you must specify the key value of the message. If there is no key, the partition will be selected randomly
 
-	var producerAck = sarama.WaitForAll // default: WaitForAll
-	switch strings.ToLower(config.Config.Kafka.ProducerAck) {
-	case "no_response":
-		producerAck = sarama.NoResponse
-	case "wait_for_local":
-		producerAck = sarama.WaitForLocal
-	case "wait_for_all":
-		producerAck = sarama.WaitForAll
-	}
-	p.config.Producer.RequiredAcks = producerAck
+	// Set partitioner strategy
+	p.config.Producer.Partitioner = sarama.NewHashPartitioner
 
-	var compress = sarama.CompressionNone // default: no compress
-	_ = compress.UnmarshalText(bytes.ToLower([]byte(config.Config.Kafka.CompressType)))
-	p.config.Producer.Compression = compress
+	// Configure producer acknowledgement level
+	configureProducerAck(&p, config.Config.Kafka.ProducerAck)
 
-	if config.Config.Kafka.Username != "" && config.Config.Kafka.Password != "" {
+	// Configure message compression
+	configureCompression(&p, config.Config.Kafka.CompressType)
+
+	// Get Kafka configuration from environment variables or fallback to config file
+	kafkaUsername := getEnvOrConfig("KAFKA_USERNAME", config.Config.Kafka.Username)
+	kafkaPassword := getEnvOrConfig("KAFKA_PASSWORD", config.Config.Kafka.Password)
+	kafkaAddr := getEnvOrConfig("KAFKA_ADDRESS", addr[0]) // Assuming addr[0] contains address from config
+
+	// Configure SASL authentication if credentials are provided
+	if kafkaUsername != "" && kafkaPassword != "" {
 		p.config.Net.SASL.Enable = true
-		p.config.Net.SASL.User = config.Config.Kafka.Username
-		p.config.Net.SASL.Password = config.Config.Kafka.Password
+		p.config.Net.SASL.User = kafkaUsername
+		p.config.Net.SASL.Password = kafkaPassword
 	}
-	p.addr = addr
-	p.topic = topic
+
+	// Set the Kafka address
+	p.addr = []string{kafkaAddr}
+
+	// Set up TLS configuration (if required)
 	SetupTLSConfig(p.config)
-	var producer sarama.SyncProducer
+
+	// Create the producer with retries
 	var err error
 	for i := 0; i <= maxRetry; i++ {
-		producer, err = sarama.NewSyncProducer(p.addr, p.config) // Initialize the client
+		p.producer, err = sarama.NewSyncProducer(p.addr, p.config)
 		if err == nil {
-			p.producer = producer
 			return &p
 		}
-		//TODO If the password is wrong, exit directly
-		//if packetErr, ok := err.(*sarama.PacketEncodingError); ok {
-		//if _, ok := packetErr.Err.(sarama.AuthenticationError); ok {
-		//	fmt.Println("Kafka password is wrong.")
-		//}
-		//} else {
-		//	fmt.Printf("Failed to create Kafka producer: %v\n", err)
-		//}
-		time.Sleep(time.Duration(1) * time.Second)
+		time.Sleep(1 * time.Second) // Wait before retrying
 	}
+
+	// Panic if unable to create producer after retries
 	if err != nil {
-		panic(err.Error())
+		panic("Failed to create Kafka producer: " + err.Error())
 	}
-	p.producer = producer
+
 	return &p
 }
 
+// configureProducerAck configures the producer's acknowledgement level.
+func configureProducerAck(p *Producer, ackConfig string) {
+	switch strings.ToLower(ackConfig) {
+	case "no_response":
+		p.config.Producer.RequiredAcks = sarama.NoResponse
+	case "wait_for_local":
+		p.config.Producer.RequiredAcks = sarama.WaitForLocal
+	case "wait_for_all":
+		p.config.Producer.RequiredAcks = sarama.WaitForAll
+	default:
+		p.config.Producer.RequiredAcks = sarama.WaitForAll
+	}
+}
+
+// configureCompression configures the message compression type for the producer.
+func configureCompression(p *Producer, compressType string) {
+	var compress sarama.CompressionCodec = sarama.CompressionNone
+	compress.UnmarshalText(bytes.ToLower([]byte(compressType)))
+	p.config.Producer.Compression = compress
+}
+
+// GetMQHeaderWithContext extracts message queue headers from the context.
 func GetMQHeaderWithContext(ctx context.Context) ([]sarama.RecordHeader, error) {
 	operationID, opUserID, platform, connID, err := mcontext.GetCtxInfos(ctx)
 	if err != nil {
@@ -111,22 +133,23 @@ func GetMQHeaderWithContext(ctx context.Context) ([]sarama.RecordHeader, error)
 		{Key: []byte(constant.OpUserID), Value: []byte(opUserID)},
 		{Key: []byte(constant.OpUserPlatform), Value: []byte(platform)},
 		{Key: []byte(constant.ConnID), Value: []byte(connID)},
-	}, err
+	}, nil
 }
 
+// GetContextWithMQHeader creates a context from message queue headers.
 func GetContextWithMQHeader(header []*sarama.RecordHeader) context.Context {
 	var values []string
 	for _, recordHeader := range header {
 		values = append(values, string(recordHeader.Value))
 	}
-	return mcontext.WithMustInfoCtx(values) // TODO
+	return mcontext.WithMustInfoCtx(values) // Attach extracted values to context
 }
 
+// SendMessage sends a message to the Kafka topic configured in the Producer.
 func (p *Producer) SendMessage(ctx context.Context, key string, msg proto.Message) (int32, int64, error) {
 	log.ZDebug(ctx, "SendMessage", "msg", msg, "topic", p.topic, "key", key)
-	kMsg := &sarama.ProducerMessage{}
-	kMsg.Topic = p.topic
-	kMsg.Key = sarama.StringEncoder(key)
+
+	// Marshal the protobuf message
 	bMsg, err := proto.Marshal(msg)
 	if err != nil {
 		return 0, 0, utils.Wrap(err, "kafka proto Marshal err")
@@ -134,20 +157,33 @@ func (p *Producer) SendMessage(ctx context.Context, key string, msg proto.Messag
 	if len(bMsg) == 0 {
 		return 0, 0, utils.Wrap(errEmptyMsg, "")
 	}
-	kMsg.Value = sarama.ByteEncoder(bMsg)
+
+	// Prepare Kafka message
+	kMsg := &sarama.ProducerMessage{
+		Topic: p.topic,
+		Key:   sarama.StringEncoder(key),
+		Value: sarama.ByteEncoder(bMsg),
+	}
+
+	// Validate message key and value
 	if kMsg.Key.Length() == 0 || kMsg.Value.Length() == 0 {
 		return 0, 0, utils.Wrap(errEmptyMsg, "")
 	}
-	kMsg.Metadata = ctx
+
+	// Attach context metadata as headers
 	header, err := GetMQHeaderWithContext(ctx)
 	if err != nil {
 		return 0, 0, utils.Wrap(err, "")
 	}
 	kMsg.Headers = header
+
+	// Send the message
 	partition, offset, err := p.producer.SendMessage(kMsg)
-	log.ZDebug(ctx, "ByteEncoder SendMessage end", "key ", kMsg.Key, "key length", kMsg.Value.Length())
 	if err != nil {
 		log.ZWarn(ctx, "p.producer.SendMessage error", err)
+		return 0, 0, utils.Wrap(err, "")
 	}
-	return partition, offset, utils.Wrap(err, "")
+
+	log.ZDebug(ctx, "ByteEncoder SendMessage end", "key", kMsg.Key, "key length", kMsg.Value.Length())
+	return partition, offset, nil
 }

pkg/common/kafka/util.go

@@ -15,6 +15,8 @@
 package kafka
 
 import (
+	"os"
+
 	"github.com/IBM/sarama"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
@@ -33,3 +35,12 @@ func SetupTLSConfig(cfg *sarama.Config) {
 		)
 	}
 }
+
+// getEnvOrConfig returns the value of the environment variable if it exists,
+// otherwise, it returns the value from the configuration file.
+func getEnvOrConfig(envName string, configValue string) string {
+	if value, exists := os.LookupEnv(envName); exists {
+		return value
+	}
+	return configValue
+}

pkg/common/prommetrics/gin_api.go

@@ -1,10 +1,24 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 prommetrics
 
 import ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
 
 /*
 labels := prometheus.Labels{"label_one": "any", "label_two": "value"}
-ApiCustomCnt.MetricCollector.(*prometheus.CounterVec).With(labels).Inc()
+ApiCustomCnt.MetricCollector.(*prometheus.CounterVec).With(labels).Inc().
 */
 var (
 	ApiCustomCnt = &ginProm.Metric{

pkg/common/prommetrics/grpc_auth.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 prommetrics
 
 import (

pkg/common/prommetrics/grpc_msg.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 prommetrics
 
 import (

pkg/common/prommetrics/grpc_msggateway.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 prommetrics
 
 import (

pkg/common/prommetrics/grpc_push.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 prommetrics
 
 import (

pkg/common/prommetrics/prommetrics.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 prommetrics
 
 import (

pkg/common/prommetrics/prommetrics_test.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 prommetrics
 
 import (

pkg/common/prommetrics/transfer.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 prommetrics
 
 import (

pkg/common/startrpc/start_test.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 startrpc
 
 import (

pkg/common/version/base.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 version
 
 // Base version information.
@@ -15,7 +29,7 @@ package version
 // When releasing a new Kubernetes version, this file is updated by
 // build/mark_new_version.sh to reflect the new version, and then a
 // git annotated tag (using format vX.Y where X == Major version and Y
-// == Minor version) is created to point to the commit that updates
+// == Minor version) is created to point to the commit that updates.
 var (
 	// TODO: Deprecate gitMajor and gitMinor, use only gitVersion
 	// instead. First step in deprecation, keep the fields but make

pkg/common/version/types.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 version
 
 // Info contains versioning information.

pkg/common/version/version.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed 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 version
 
 import (
@@ -25,7 +39,7 @@ func Get() Info {
 	}
 }
 
-// GetClientVersion returns the git version of the OpenIM client repository
+// GetClientVersion returns the git version of the OpenIM client repository.
 func GetClientVersion() (*OpenIMClientVersion, error) {
 	clientVersion, err := getClientVersion()
 	if err != nil {
@@ -52,7 +66,7 @@ func getClientVersion() (string, error) {
 	return ref.Hash().String(), nil
 }
 
-// GetSingleVersion returns single version of sealer
+// GetSingleVersion returns single version of sealer.
 func GetSingleVersion() string {
 	return gitVersion
 }