feat: Add the help chart script to support k8s deployment (#1145)

* Code adaptation k8s: service discovery and registration adaptation, configuration adaptation

* Initial submission of the help charts script for openim API

* change the help charts script

* change the help charts script

* change helm chart codes

* change dockerfiles script

* change chart script:add configmap mounts

* change chart script:change repository

* change chart script:msggateway add one service

* change config.yaml

* roll back some config values

* change chart script:change Ingress rule with a rewrite annotation

* add mysql charts scrible

* change chart script:add mysql.config.yaml

* add nfs provisioner charts

* change chart script:add nfs.config.yaml

* add ingress-nginx charts

* change chart script:add ingress-nginx.config.yaml

* add redis &mongodb charts

* add kafka&minio charts

* change chart script:change redis.values.yaml

* change chart script:add redis.config.yaml

* change chart script:change redis.config.yaml

* change chart script:change mongodb.value.yaml

* change chart script:change mongodb.value.yaml

* change chart script:add mongodb.config.yaml

* change chart script:change minio.values.yaml

* change chart script:add minio.config.yaml

* change chart script:change kafka.values.yaml

* change chart script:add kafka.config.yaml

* change chart script:change services.config.yaml

* bug fix:Delete websocket's Port restrictions

* bug fix:change port value

* change chart script:Submit a stable version script

* fix bug:Implement option interface

* fix bug:change K8sDR.Register

* change config.yaml

* change chats script:minio service add ingress

* change chats script:minio service add ingress

* change chats script:kafka.replicaCount=3& change minio.api ingress

* delete change chats script

* change config.yaml

* change openim.yaml

---------

Co-authored-by: lin.huang <lin.huang@apulis.com>

pkg/common/cmd/api.go

@@ -14,14 +14,21 @@
 
 package cmd
 
-import "github.com/spf13/cobra"
+import (
+	"fmt"
+	"github.com/OpenIMSDK/protocol/constant"
+	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/spf13/cobra"
+)
 
 type ApiCmd struct {
 	*RootCmd
 }
 
 func NewApiCmd() *ApiCmd {
-	return &ApiCmd{NewRootCmd("api")}
+	ret := &ApiCmd{NewRootCmd("api")}
+	ret.SetRootCmdPt(ret)
+	return ret
 }
 
 func (a *ApiCmd) AddApi(f func(port int) error) {
@@ -29,3 +36,11 @@ func (a *ApiCmd) AddApi(f func(port int) error) {
 		return f(a.getPortFlag(cmd))
 	}
 }
+func (a *ApiCmd) GetPortFromConfig(portType string) int {
+	fmt.Println("GetPortFromConfig:", portType)
+	if portType == constant.FlagPort {
+		return config2.Config.Api.OpenImApiPort[0]
+	} else {
+		return 0
+	}
+}

pkg/common/cmd/constant.go

@@ -0,0 +1,12 @@
+package cmd
+
+const (
+	RpcPushServer         = "push"
+	RpcAuthServer         = "auth"
+	RpcConversationServer = "conversation"
+	RpcFriendServer       = "friend"
+	RpcGroupServer        = "group"
+	RpcMsgServer          = "msg"
+	RpcThirdServer        = "third"
+	RpcUserServer         = "user"
+)

pkg/common/cmd/cron_task.go

@@ -21,7 +21,9 @@ type CronTaskCmd struct {
 }
 
 func NewCronTaskCmd() *CronTaskCmd {
-	return &CronTaskCmd{NewRootCmd("cronTask", WithCronTaskLogName())}
+	ret := &CronTaskCmd{NewRootCmd("cronTask", WithCronTaskLogName())}
+	ret.SetRootCmdPt(ret)
+	return ret
 }
 
 func (c *CronTaskCmd) addRunE(f func() error) {

pkg/common/cmd/msg_gateway.go

@@ -16,6 +16,8 @@ package cmd
 
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/msggateway"
+	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
+
 	//"github.com/openimsdk/open-im-server/internal/msggateway".
 	"github.com/spf13/cobra"
 
@@ -26,8 +28,10 @@ type MsgGatewayCmd struct {
 	*RootCmd
 }
 
-func NewMsgGatewayCmd() MsgGatewayCmd {
-	return MsgGatewayCmd{NewRootCmd("msgGateway")}
+func NewMsgGatewayCmd() *MsgGatewayCmd {
+	ret := &MsgGatewayCmd{NewRootCmd("msgGateway")}
+	ret.SetRootCmdPt(ret)
+	return ret
 }
 
 func (m *MsgGatewayCmd) AddWsPortFlag() {
@@ -36,6 +40,9 @@ func (m *MsgGatewayCmd) AddWsPortFlag() {
 
 func (m *MsgGatewayCmd) getWsPortFlag(cmd *cobra.Command) int {
 	port, _ := cmd.Flags().GetInt(constant.FlagWsPort)
+	if port == 0 {
+		port = m.PortFromConfig(constant.FlagWsPort)
+	}
 	return port
 }
 
@@ -49,3 +56,14 @@ func (m *MsgGatewayCmd) Exec() error {
 	m.addRunE()
 	return m.Execute()
 }
+func (m *MsgGatewayCmd) GetPortFromConfig(portType string) int {
+	if portType == constant.FlagWsPort {
+		return config2.Config.LongConnSvr.OpenImWsPort[0]
+	} else if portType == constant.FlagPort {
+		return config2.Config.LongConnSvr.OpenImMessageGatewayPort[0]
+	} else if portType == constant.FlagPrometheusPort {
+		return 0
+	} else {
+		return 0
+	}
+}

pkg/common/cmd/msg_transfer.go

@@ -24,8 +24,10 @@ type MsgTransferCmd struct {
 	*RootCmd
 }
 
-func NewMsgTransferCmd() MsgTransferCmd {
-	return MsgTransferCmd{NewRootCmd("msgTransfer")}
+func NewMsgTransferCmd() *MsgTransferCmd {
+	ret := &MsgTransferCmd{NewRootCmd("msgTransfer")}
+	ret.SetRootCmdPt(ret)
+	return ret
 }
 
 func (m *MsgTransferCmd) addRunE() {

pkg/common/cmd/root.go

@@ -26,11 +26,15 @@ import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
+type RootCmdPt interface {
+	GetPortFromConfig(portType string) int
+}
 type RootCmd struct {
 	Command        cobra.Command
 	Name           string
 	port           int
 	prometheusPort int
+	cmdItf         RootCmdPt
 }
 
 type CmdOpts struct {
@@ -76,7 +80,9 @@ func NewRootCmd(name string, opts ...func(*CmdOpts)) (rootCmd *RootCmd) {
 	rootCmd.addConfFlag()
 	return rootCmd
 }
-
+func (r *RootCmd) SetRootCmdPt(cmdItf RootCmdPt) {
+	r.cmdItf = cmdItf
+}
 func (r *RootCmd) addConfFlag() {
 	r.Command.Flags().StringP(constant.FlagConf, "c", "", "Path to config file folder")
 }
@@ -87,6 +93,9 @@ func (r *RootCmd) AddPortFlag() {
 
 func (r *RootCmd) getPortFlag(cmd *cobra.Command) int {
 	port, _ := cmd.Flags().GetInt(constant.FlagPort)
+	if port == 0 {
+		port = r.PortFromConfig(constant.FlagPort)
+	}
 	return port
 }
 
@@ -100,6 +109,9 @@ func (r *RootCmd) AddPrometheusPortFlag() {
 
 func (r *RootCmd) getPrometheusPortFlag(cmd *cobra.Command) int {
 	port, _ := cmd.Flags().GetInt(constant.FlagPrometheusPort)
+	if port == 0 {
+		port = r.PortFromConfig(constant.FlagPrometheusPort)
+	}
 	return port
 }
 
@@ -120,3 +132,12 @@ func (r *RootCmd) Execute() error {
 func (r *RootCmd) AddCommand(cmds ...*cobra.Command) {
 	r.Command.AddCommand(cmds...)
 }
+
+func (r *RootCmd) GetPortFromConfig(portType string) int {
+	fmt.Println("RootCmd.GetPortFromConfig:", portType)
+	return 0
+}
+func (r *RootCmd) PortFromConfig(portType string) int {
+	fmt.Println("PortFromConfig:", portType)
+	return r.cmdItf.GetPortFromConfig(portType)
+}

pkg/common/cmd/rpc.go

@@ -16,7 +16,8 @@ package cmd
 
 import (
 	"errors"
-
+	"github.com/OpenIMSDK/protocol/constant"
+	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
 	"github.com/spf13/cobra"
 	"google.golang.org/grpc"
 
@@ -30,8 +31,9 @@ type RpcCmd struct {
 }
 
 func NewRpcCmd(name string) *RpcCmd {
-	authCmd := &RpcCmd{NewRootCmd(name)}
-	return authCmd
+	ret := &RpcCmd{NewRootCmd(name)}
+	ret.SetRootCmdPt(ret)
+	return ret
 }
 
 func (a *RpcCmd) Exec() error {
@@ -51,3 +53,40 @@ func (a *RpcCmd) StartSvr(
 	}
 	return startrpc.Start(a.GetPortFlag(), name, a.GetPrometheusPortFlag(), rpcFn)
 }
+func (a *RpcCmd) GetPortFromConfig(portType string) int {
+	switch a.Name {
+	case RpcPushServer:
+		if portType == constant.FlagPort {
+			return config2.Config.RpcPort.OpenImPushPort[0]
+		}
+	case RpcAuthServer:
+		if portType == constant.FlagPort {
+			return config2.Config.RpcPort.OpenImAuthPort[0]
+		}
+	case RpcConversationServer:
+		if portType == constant.FlagPort {
+			return config2.Config.RpcPort.OpenImConversationPort[0]
+		}
+	case RpcFriendServer:
+		if portType == constant.FlagPort {
+			return config2.Config.RpcPort.OpenImFriendPort[0]
+		}
+	case RpcGroupServer:
+		if portType == constant.FlagPort {
+			return config2.Config.RpcPort.OpenImGroupPort[0]
+		}
+	case RpcMsgServer:
+		if portType == constant.FlagPort {
+			return config2.Config.RpcPort.OpenImMessagePort[0]
+		}
+	case RpcThirdServer:
+		if portType == constant.FlagPort {
+			return config2.Config.RpcPort.OpenImThirdPort[0]
+		}
+	case RpcUserServer:
+		if portType == constant.FlagPort {
+			return config2.Config.RpcPort.OpenImUserPort[0]
+		}
+	}
+	return 0
+}

pkg/common/config/config.go

@@ -46,6 +46,9 @@ type POfflinePush struct {
 }
 
 type configStruct struct {
+	Envs struct {
+		Discovery string `yaml:"discovery"`
+	}
 	Zookeeper struct {
 		Schema   string   `yaml:"schema"`
 		ZkAddr   []string `yaml:"address"`
@@ -185,10 +188,11 @@ type configStruct struct {
 	} `yaml:"log"`
 
 	LongConnSvr struct {
-		OpenImWsPort        []int `yaml:"openImWsPort"`
-		WebsocketMaxConnNum int   `yaml:"websocketMaxConnNum"`
-		WebsocketMaxMsgLen  int   `yaml:"websocketMaxMsgLen"`
-		WebsocketTimeout    int   `yaml:"websocketTimeout"`
+		OpenImMessageGatewayPort []int `yaml:"openImMessageGatewayPort"`
+		OpenImWsPort             []int `yaml:"openImWsPort"`
+		WebsocketMaxConnNum      int   `yaml:"websocketMaxConnNum"`
+		WebsocketMaxMsgLen       int   `yaml:"websocketMaxMsgLen"`
+		WebsocketTimeout         int   `yaml:"websocketTimeout"`
 	} `yaml:"longConnSvr"`
 
 	Push struct {

pkg/common/discovery_register/k8s_discovery_register.go

@@ -0,0 +1,88 @@
+package discovery_register
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"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"
+	"google.golang.org/grpc"
+	"time"
+)
+
+func NewDiscoveryRegister(envType string) (discoveryregistry.SvcDiscoveryRegistry, error) {
+	var client discoveryregistry.SvcDiscoveryRegistry
+	var err error
+	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()))
+	case "k8s":
+		client, err = 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 {
+	cli.rpcRegisterAddr = serviceName
+	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) GetConns(ctx context.Context, serviceName string, opts ...grpc.DialOption) ([]*grpc.ClientConn, error) {
+
+	conn, err := grpc.DialContext(ctx, serviceName, append(cli.options, opts...)...)
+	return []*grpc.ClientConn{conn}, err
+}
+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
+}

pkg/common/startrpc/start.go

@@ -16,19 +16,16 @@ package startrpc
 
 import (
 	"fmt"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/discovery_register"
 	"net"
 	"strconv"
-	"time"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 
 	grpcprometheus "github.com/grpc-ecosystem/go-grpc-prometheus"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
 
 	"github.com/OpenIMSDK/tools/discoveryregistry"
-	"github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
-	"github.com/OpenIMSDK/tools/log"
 	"github.com/OpenIMSDK/tools/mw"
 	"github.com/OpenIMSDK/tools/network"
 	"github.com/OpenIMSDK/tools/prome"
@@ -60,15 +57,17 @@ func Start(
 		return err
 	}
 	defer listener.Close()
-	zkClient, err := zookeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
-		zookeeper.WithFreq(time.Hour), zookeeper.WithUserNameAndPassword(
-			config.Config.Zookeeper.Username,
-			config.Config.Zookeeper.Password,
-		), zookeeper.WithRoundRobin(), zookeeper.WithTimeout(10), zookeeper.WithLogger(log.NewZkLogger()))
+	zkClient, err := discovery_register.NewDiscoveryRegister(config.Config.Envs.Discovery)
+	/*
+		zkClient, err := zookeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
+			zookeeper.WithFreq(time.Hour), zookeeper.WithUserNameAndPassword(
+				config.Config.Zookeeper.Username,
+				config.Config.Zookeeper.Password,
+			), zookeeper.WithRoundRobin(), zookeeper.WithTimeout(10), zookeeper.WithLogger(log.NewZkLogger()))*/
 	if err != nil {
 		return utils.Wrap1(err)
 	}
-	defer zkClient.CloseZK()
+	//defer zkClient.CloseZK()
 	zkClient.AddOption(mw.GrpcClient(), grpc.WithTransportCredentials(insecure.NewCredentials()))
 	registerIP, err := network.GetRpcRegisterIP(config.Config.Rpc.RegisterIP)
 	if err != nil {