[gateway] add bootstrap gateway service command

Author: jackblack369

cli/cli/cli.go

@@ -341,6 +341,18 @@ func (curveadm *CurveAdm) FilterDeployConfig(deployConfigs []*topology.DeployCon
 	return dcs
 }
 
+func (curveadm *CurveAdm) FilterDeployConfigByGateway(deployConfigs []*topology.DeployConfig,
+	options topology.FilterOption) *topology.DeployConfig {
+	for _, dc := range deployConfigs {
+		host := dc.GetHost()
+		if options.Host == host {
+			return dc
+		}
+	}
+
+	return nil
+}
+
 func (curveadm *CurveAdm) FilterDeployConfigByRole(dcs []*topology.DeployConfig,
 	role string) []*topology.DeployConfig {
 	options := topology.FilterOption{Id: "*", Role: role, Host: "*"}

cli/command/cmd.go

@@ -26,6 +26,7 @@ package command
 
 import (
 	"fmt"
+	"github.com/dingodb/curveadm/cli/command/gateway"
 
 	"github.com/dingodb/curveadm/cli/cli"
 	"github.com/dingodb/curveadm/cli/command/client"
@@ -66,6 +67,7 @@ func addSubCommands(cmd *cobra.Command, curveadm *cli.CurveAdm) {
 		target.NewTargetCommand(curveadm),         // curveadm target ...
 		pfs.NewPFSCommand(curveadm),               // curveadm pfs ...
 		monitor.NewMonitorCommand(curveadm),       // curveadm monitor ...
+		gateway.NewGatewayCommand(curveadm),       // curveadm gateway ...
 
 		NewAuditCommand(curveadm),      // curveadm audit
 		NewCleanCommand(curveadm),      // curveadm clean

cli/command/gateway/cmd.go

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2024 dingodb.com, Inc. 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.
+ */
+
+/*
+ * Project: DingoFS
+ * Created Date: 2024-10-28
+ * Author: Wei Dong (jackblack369)
+ */
+
+package gateway
+
+import (
+	"github.com/dingodb/curveadm/cli/cli"
+	cliutil "github.com/dingodb/curveadm/internal/utils"
+	"github.com/spf13/cobra"
+)
+
+func NewGatewayCommand(curveadm *cli.CurveAdm) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "gateway",
+		Short: "Manage gateway",
+		Args:  cliutil.NoArgs,
+		RunE:  cliutil.ShowHelp(curveadm.Err()),
+	}
+
+	cmd.AddCommand(
+		NewStartGatewayCommand(curveadm),
+	)
+	return cmd
+}

cli/command/gateway/start.go

@@ -0,0 +1,140 @@
+/*
+ * Copyright (c) 2024 dingodb.com, Inc. 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.
+ */
+
+/*
+ * Project: DingoFS
+ * Created Date: 2024-10-28
+ * Author: Wei Dong (jackblack369)
+ */
+
+package gateway
+
+import (
+	"github.com/dingodb/curveadm/cli/cli"
+	comm "github.com/dingodb/curveadm/internal/common"
+	"github.com/dingodb/curveadm/internal/configure"
+	"github.com/dingodb/curveadm/internal/errno"
+	"github.com/dingodb/curveadm/internal/playbook"
+	cliutil "github.com/dingodb/curveadm/internal/utils"
+	"github.com/spf13/cobra"
+)
+
+const (
+	START_GATEWAY_EXAMPLE = `Examples:
+  $ curveadm gateway start --host dingfs1 --listen-address=:9000 --console-address=:9001 --mountpoint=/home/dingofs/client`
+)
+
+type startOptions struct {
+	name       string
+	host       string
+	fileName   string
+	mountPoint string
+}
+
+var (
+	START_GATEWAY_PLAYBOOK_STEPS = []int{
+		playbook.START_GATEWAY,
+	}
+)
+
+func NewStartGatewayCommand(curveadm *cli.CurveAdm) *cobra.Command {
+	var options startOptions
+
+	cmd := &cobra.Command{
+		// Use:     "start --host={hostName} --listen-address={listenAddr} --console-address={consoleAddr} --mountpoint={path} ",
+		Use:     "start {name} {mountpoint} --host dingo7232 -c gateway.yaml ",
+		Short:   "start s3 gateway",
+		Args:    cliutil.ExactArgs(2),
+		Example: START_GATEWAY_EXAMPLE,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			options.name = args[0]
+			options.mountPoint = args[1]
+			return runStart(curveadm, options)
+		},
+		DisableFlagsInUseLine: true,
+	}
+
+	flags := cmd.Flags()
+	flags.StringVar(&options.host, "host", "localhost", "Specify target host")
+	flags.StringVarP(&options.fileName, "conf", "c", "gateway.yaml", "Specify gateway configuration file")
+
+	return cmd
+}
+
+func runStart(curveadm *cli.CurveAdm, options startOptions) error {
+
+	// 1) generate mount playbook
+	pb, err := genStartPlaybook(curveadm, options)
+	if err != nil {
+		return err
+	}
+
+	// 2) run playground
+	err = pb.Run()
+	if err != nil {
+		return err
+	}
+
+	// 3) print success prompt
+	// curveadm.WriteOutln(color.GreenString("start gateway success !\n gateway listen address: %s%s \n gateway console address: %s%s \n"),
+	//	options.host, options.listenAddress, options.host, options.consoleAddress)
+
+	return nil
+}
+
+func genStartPlaybook(curveadm *cli.CurveAdm, options startOptions) (*playbook.Playbook, error) {
+	steps := START_GATEWAY_PLAYBOOK_STEPS
+	pb := playbook.NewPlaybook(curveadm)
+
+	// parse client configure
+	gc, err := configure.ParseGatewayConfig(options.fileName)
+	if err != nil {
+		return nil, err
+	}
+	listenPort := gc.GetListenPort()
+	if listenPort == "" {
+		listenPort = "19000"
+	}
+	gatewayListenAddr := ":" + listenPort
+
+	consolePort := gc.GetConsolePort()
+	if consolePort == "" {
+		consolePort = "19001"
+	}
+	gatewayConsoleAddr := ":" + consolePort
+
+	mdsAddr := gc.GetDingofsMDSAddr()
+	if mdsAddr == "" {
+		return nil, errno.ERR_GATEWAY_MDSADDR_EMPTY
+	}
+
+	for _, step := range steps {
+
+		pb.AddStep(&playbook.PlaybookStep{
+			Type:    step,
+			Configs: gc,
+			Options: map[string]interface{}{
+				comm.GATEWAY_NAME:         options.name,
+				comm.GATEWAY_HOST:         options.host,
+				comm.GATEWAY_LISTEN_ADDR:  gatewayListenAddr,
+				comm.GATEWAY_CONSOLE_ADDR: gatewayConsoleAddr,
+				comm.GATEWAY_MOUNTPOINT:   options.mountPoint,
+				comm.MDSADDR:              mdsAddr,
+			},
+		})
+	}
+	return pb, nil
+}

internal/common/common.go

@@ -116,6 +116,14 @@ const (
 	KEY_SERVICE_HOSTS    = "SERVICE_HOSTS"
 	KEY_MONITOR_STATUS   = "MONITOR_STATUS"
 	CLEANED_MONITOR_CONF = "-"
+
+	// gateway
+	GATEWAY_NAME         = "GATEWAY_NAME"
+	GATEWAY_HOST         = "GATEWAY_HOST"
+	GATEWAY_LISTEN_ADDR  = "GATEWAY_LISTEN_ADDR"
+	GATEWAY_CONSOLE_ADDR = "GATEWAY_CONSOLE_ADDR"
+	GATEWAY_MOUNTPOINT   = "GATEWAY_MOUNTPOINT"
+	MDSADDR              = "mdsaddr"
 )
 
 // others

internal/configure/gateway.go

@@ -0,0 +1,116 @@
+package configure
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/dingodb/curveadm/internal/errno"
+	"github.com/dingodb/curveadm/internal/utils"
+	"github.com/spf13/viper"
+)
+
+const (
+	KEY_GATEWAY_S3_ROOT_USER                = "s3.root_user"
+	KEY_GATEWAY_S3_ROOT_PASSWORD            = "s3.root_password"
+	KEY_GATEWAY_LISTEN_PORT                 = "gateway.listen_port"
+	KEY_GATEWAY_CONSOLE_PORT                = "gateway.console_port"
+	KEY_DINGOFS_MDS_ADDRS                   = "dingofs.mdsaddr"
+	KEY_GATEWAY_CONTAINER_IMAGE             = "container_image"
+	KEY_GATEWAY_LOG_DIR                     = "log_dir"
+	KEY_GATEWAY_DATA_DIR                    = "data_dir"
+	KEY_GATEWAY_CORE_DIR                    = "core_dir"
+	DEFAULT_DINGOFS_GATEWAY_CONTAINER_IMAGE = "dingodatabase/dingofs:latest"
+)
+
+type (
+	GatewayConfig struct {
+		configMap map[string]interface{}
+		data      string // configure file content
+	}
+)
+
+func NewGatewayConfig(config map[string]interface{}) (*GatewayConfig, error) {
+	gc := &GatewayConfig{
+		configMap: config,
+	}
+
+	return gc, nil
+}
+
+func ParseGatewayConfig(filename string) (*GatewayConfig, error) {
+	// 1. read file content
+	data, err := utils.ReadFile(filename)
+	if err != nil {
+		return nil, errno.ERR_PARSE_GATEWAY_CONFIGURE_FAILED.E(err)
+	}
+
+	// 2. new parser
+	parser := viper.NewWithOptions(viper.KeyDelimiter("::"))
+	parser.SetConfigFile(filename)
+	parser.SetConfigType("yaml")
+	err = parser.ReadInConfig()
+	if err != nil {
+		return nil, errno.ERR_PARSE_GATEWAY_CONFIGURE_FAILED.E(err)
+	}
+
+	// 3. parse
+	m := map[string]interface{}{}
+	err = parser.Unmarshal(&m)
+	if err != nil {
+		return nil, errno.ERR_PARSE_GATEWAY_CONFIGURE_FAILED.E(err)
+	}
+
+	// 4. new config
+	cfg, err := NewGatewayConfig(m)
+	if err != nil {
+		return nil, err
+	}
+
+	cfg.data = data
+	return cfg, nil
+}
+
+func (gc *GatewayConfig) getString(key string) string {
+	v := gc.configMap[strings.ToLower(key)]
+	if v == nil {
+		return ""
+	}
+	return fmt.Sprintf("%v", v)
+}
+
+func (gc *GatewayConfig) getBool(key string) bool {
+	v := gc.configMap[strings.ToLower(key)]
+	if v == nil {
+		return false
+	}
+	return v.(bool)
+}
+
+func (gc *GatewayConfig) GetS3RootUser() string { return gc.getString(KEY_GATEWAY_S3_ROOT_USER) }
+func (gc *GatewayConfig) GetS3RootPassword() string {
+	return gc.getString(KEY_GATEWAY_S3_ROOT_PASSWORD)
+}
+
+func (gc *GatewayConfig) GetListenPort() string {
+	return gc.getString(KEY_GATEWAY_LISTEN_PORT)
+}
+
+func (gc *GatewayConfig) GetConsolePort() string {
+	return gc.getString(KEY_GATEWAY_CONSOLE_PORT)
+}
+
+func (gc *GatewayConfig) GetDataDir() string { return gc.getString(KEY_GATEWAY_DATA_DIR) }
+func (gc *GatewayConfig) GetLogDir() string  { return gc.getString(KEY_GATEWAY_LOG_DIR) }
+func (gc *GatewayConfig) GetCoreDir() string { return gc.getString(KEY_GATEWAY_CORE_DIR) }
+func (gc *GatewayConfig) GetData() string    { return gc.data }
+func (gc *GatewayConfig) GetContainerImage() string {
+	containerImage := gc.getString(KEY_GATEWAY_CONTAINER_IMAGE)
+	if len(containerImage) == 0 {
+		containerImage = DEFAULT_DINGOFS_GATEWAY_CONTAINER_IMAGE
+	}
+	return containerImage
+}
+
+func (gc *GatewayConfig) GetDingofsMDSAddr() string {
+	return gc.getString(KEY_DINGOFS_MDS_ADDRS)
+}

internal/configure/gateway_test.go

@@ -0,0 +1,12 @@
+package configure
+
+import "testing"
+
+func TestParseGatewayFile(t *testing.T) {
+	fileName := "/home/dongw/dingofs/gateway.yaml"
+	gc, err := ParseGatewayConfig(fileName)
+	if err != nil {
+		t.Errorf("parse gateway config file failed: %v", err)
+	}
+	t.Logf("gateway config: %v", gc)
+}

internal/errno/errno.go

@@ -371,6 +371,10 @@ var (
 	ERR_REQUIRE_CURVEFS_KIND_CLIENT_CONFIGURE_FILE = EC(351003, "require curvefs kind client configure file")
 	ERR_INVALID_CLUSTER_LISTEN_MDS_ADDRESS         = EC(351004, "invalid cluster MDS listen address")
 
+	// 360: configure (gateway.yaml: parse failed)
+	ERR_PARSE_GATEWAY_CONFIGURE_FAILED = EC(360000, "parse client configure failed")
+	ERR_GATEWAY_MDSADDR_EMPTY          = EC(360001, "dingofs mdsaddr is empty")
+
 	// 400: common (hosts)
 	ERR_HOST_NOT_FOUND = EC(400000, "host not found")
 
@@ -546,6 +550,10 @@ var (
 	ERR_GET_CONTAINER_LOGS_FAILED        = EC(630013, "get container logs failed")
 	ERR_UPDATE_CONTAINER_FAILED          = EC(630014, "update container failed")
 
+	// 640: gateway (curve gateway)
+	ERR_NO_HOST_FOR_GATEWAY  = EC(640000, "no host found")
+	ERR_START_GATEWAY_FAILED = EC(640001, "start s3 gateway failed")
+
 	// 690: execuetr task (others)
 	ERR_START_CRONTAB_IN_CONTAINER_FAILED = EC(690000, "start crontab in container failed")