Merge 'feature/yg/meego-6781455548-auto-addressing' into 'master'

feat(endpoint): cli endpoint support auto-addressing

See merge request: !57

Author: bytestarter

README.EN.MD

@@ -65,7 +65,9 @@ To invoke the service, you must provide AK, SK, and region. These parameters can
 	region: Geographic area, such as cn-beijing 
 	session-token: Required if role-playing is used. 
 	disable-ssl: Specifies whether to disable SSL. The default value is false. 
-	endpoint: Optional; the default value is open.volcengineapi.com.
+	endpoint: Optional; the default value is open.volcengineapi.com. Ignored when endpoint-resolver is standard.
+    endpoint-resolver: Optional; set to standard (case-insensitive) to use the standard resolver. Otherwise, the CLI uses endpoint when provided.
+    use-dual-stack: Optional; enable dual-stack endpoints when true. The default value is false.
     ```
 
 2.  If no configuration is specified in the configuration file, an attempt will be made to read the configuration from environment variables set via export.
@@ -77,6 +79,15 @@ To invoke the service, you must provide AK, SK, and region. These parameters can
 	# Whether to disable SSL; if not set, the default is false. 
 	export VOLCENGINE_DISABLE_SSL=false 
 
+	# Optional: custom endpoint. Ignored when VOLCENGINE_ENDPOINT_RESOLVER is standard.
+	export VOLCENGINE_ENDPOINT=open.volcengineapi.com
+
+	# Optional: endpoint resolver; set to standard (case-insensitive) to use the standard resolver.
+	export VOLCENGINE_ENDPOINT_RESOLVER=standard
+
+	# Optional: enable dual-stack endpoints; accepts true/false.
+	export VOLCENGINE_USE_DUALSTACK=false 
+
 	# If role-playing is employed, the following must be provided 
 	export VOLCENGINE_SESSION_TOKEN=sessionToken
     ```
@@ -130,6 +141,9 @@ Other fields that can be specified:
 -   region
 -   session-token
 -   disable-ssl
+-   endpoint
+-   endpoint-resolver
+-   use-dual-stack
 
 For information on the function of each field, please refer to the 'Supported Parameters and Related Descriptions' section in the previous section.
 
@@ -210,6 +224,16 @@ The ve disable-color command can be used to disable the color display feature.
     ve ecs [-h|--help]
     ```
 
+#### Show CLI version
+
+```shell
+ve version
+```
+
+```shell
+ve -v
+```
+
 #### Call the API
 
 When using the VolcEngine CLI to invoke an API, the basic command structure is as follows:

README.MD

@@ -64,14 +64,25 @@
    region: 地域，如 cn-beijing
    session-token: 如果使用角色扮演，需要提供
    disable-ssl: 是否禁用 ssl，默认为 false
-   endpoint: 可以不填，默认值为 open.volcengineapi.com
+   endpoint: 可以不填，默认值为 open.volcengineapi.com；当 endpoint-resolver 为 standard 时该值会被忽略
+   endpoint-resolver: 可选；指定 endpoint 解析器。设置为 standard（不区分大小写）时使用标准解析器；否则当 endpoint 非空时使用 endpoint
+   use-dual-stack: 可选；是否启用双栈，默认为 false
    ```
 
 2. 若配置文件中无配置，则会尝试从 export 的环境变量中读取配置
    ```shell
    export VOLCENGINE_ACCESS_KEY=AK
    export VOLCENGINE_SECRET_KEY=SK
    export VOLCENGINE_REGION=cn-bejing
+
+   # 可选：自定义 endpoint；当 VOLCENGINE_ENDPOINT_RESOLVER=standard 时会忽略
+   export VOLCENGINE_ENDPOINT=open.volcengineapi.com
+
+   # 可选：endpoint 解析器；设置为 standard（不区分大小写）使用标准解析器
+   export VOLCENGINE_ENDPOINT_RESOLVER=standard
+
+   # 可选：是否启用双栈，true/false
+   export VOLCENGINE_USE_DUALSTACK=false
    
    # 是否禁用SSL, 不设置的话默认为false
    export VOLCENGINE_DISABLE_SSL=false
@@ -134,6 +145,9 @@ ve configure set --profile [配置名] --region [地区] --access-key [用户的
 - region
 - session-token
 - disable-ssl
+- endpoint
+- endpoint-resolver
+- use-dual-stack
 
 各个字段的作用您可以参考上节中 "支持参数及相关说明" 部分
 
@@ -228,6 +242,16 @@ ve configure delete --profile [配置名]
    ve ecs [-h|--help]
    ```
 
+#### 查看版本
+
+```shell
+ve version
+```
+
+```shell
+ve -v
+```
+
 
 
 #### 调用API

cmd/cmd_configure.go

@@ -77,9 +77,11 @@ func newConfigureSetCmd() *cobra.Command {
 	cmd.Flags().StringVar(&profileFlags.SecretKey, "secret-key", "", "your secret key(SK)")
 	cmd.Flags().StringVar(&profileFlags.Region, "region", "", "your region")
 	cmd.Flags().StringVar(&profileFlags.Endpoint, "endpoint", "", "endpoint bind with region")
+	cmd.Flags().StringVar(&profileFlags.EndpointResolver, "endpoint-resolver", "", "endpoint resolver (auto-addressing)")
 	cmd.Flags().StringVar(&profileFlags.SessionToken, "session-token", "", "your session token")
 
 	profileFlags.DisableSSL = cmd.Flags().Bool("disable-ssl", false, "disable ssl")
+	profileFlags.UseDualStack = cmd.Flags().Bool("use-dual-stack", false, "use dual-stack endpoints")
 	cmd.Flags().BoolP("help", "h", false, "")
 
 	cmd.MarkFlagRequired("profile")

cmd/cmd_root.go

@@ -26,10 +26,27 @@ func initRootCmd() {
 
 	rootCmd.Flags().BoolP("help", "h", false, "")
 
+	rootCmd.Flags().BoolP("version", "v", false, "Show CLI version")
+
+	rootCmd.PreRunE = func(cmd *cobra.Command, args []string) error {
+		showVersion, _ := cmd.Flags().GetBool("version")
+		if showVersion {
+			fmt.Fprintln(cmd.OutOrStdout(), clientVersion)
+			os.Exit(0)
+		}
+		return nil
+	}
+
 	// todo enable color?
 	rootCmd.SetUsageTemplate(rootUsageTemplate())
 
 	rootCmd.AddCommand(&cobra.Command{
+		Use:   "version",
+		Short: "Show CLI version",
+		Run: func(cmd *cobra.Command, args []string) {
+			fmt.Fprintln(cmd.OutOrStdout(), clientVersion)
+		},
+	}, &cobra.Command{
 		Use: "enable-color",
 		Run: func(cmd *cobra.Command, args []string) {
 			config.EnableColor = true

cmd/configure.go

@@ -26,6 +26,8 @@ type Profile struct {
 	SecretKey    string `json:"secret-key"`
 	Region       string `json:"region"`
 	Endpoint     string `json:"endpoint"`
+	EndpointResolver string `json:"endpoint-resolver,omitempty"`
+	UseDualStack *bool  `json:"use-dual-stack,omitempty"`
 	SessionToken string `json:"session-token"`
 	DisableSSL   *bool  `json:"disable-ssl"`
 }
@@ -125,11 +127,13 @@ func setConfigProfile(profile *Profile) error {
 	// otherwise create a new profileFlags
 	if currentProfile, exist = cfg.Profiles[profile.Name]; !exist {
 		currentProfile = &Profile{
-			Name:       profile.Name,
-			Mode:       "AK",
-			DisableSSL: new(bool),
+			Name:           profile.Name,
+			Mode:           "AK",
+			DisableSSL:     new(bool),
+			UseDualStack:   new(bool),
 		}
 		*currentProfile.DisableSSL = false
+		*currentProfile.UseDualStack = false
 	}
 
 	if profile.AccessKey != "" {
@@ -144,12 +148,21 @@ func setConfigProfile(profile *Profile) error {
 	if profile.Endpoint != "" {
 		currentProfile.Endpoint = profile.Endpoint
 	}
+	if profile.EndpointResolver != "" {
+		currentProfile.EndpointResolver = profile.EndpointResolver
+	}
 	if profile.SessionToken != "" {
 		currentProfile.SessionToken = profile.SessionToken
 	}
 	if profile.DisableSSL != nil {
 		*currentProfile.DisableSSL = *profile.DisableSSL
 	}
+	if profile.UseDualStack != nil {
+		if currentProfile.UseDualStack == nil {
+			currentProfile.UseDualStack = new(bool)
+		}
+		*currentProfile.UseDualStack = *profile.UseDualStack
+	}
 
 	cfg.Profiles[currentProfile.Name] = currentProfile
 	cfg.Current = currentProfile.Name

cmd/sdk_client.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"fmt"
+	"github.com/volcengine/volcengine-go-sdk/volcengine/endpoints"
 	"os"
 	"strconv"
 	"strings"
@@ -32,7 +33,9 @@ type SdkClientInfo struct {
 func NewSimpleClient(ctx *Context) (*SdkClient, error) {
 	var (
 		ak, sk, sessionToken, region, endpoint string
+		endpointResolver                       string
 		disableSSl                             bool
+		useDualStack                           bool
 	)
 
 	// first try to get ak/sk/region from config file
@@ -43,8 +46,12 @@ func NewSimpleClient(ctx *Context) (*SdkClient, error) {
 			sk = currentProfile.SecretKey
 			region = currentProfile.Region
 			endpoint = currentProfile.Endpoint
+			endpointResolver = currentProfile.EndpointResolver
 			sessionToken = currentProfile.SessionToken
 			disableSSl = *currentProfile.DisableSSL
+			if currentProfile.UseDualStack != nil {
+				useDualStack = *currentProfile.UseDualStack
+			}
 
 			if ak == "" {
 				return nil, fmt.Errorf("profile AccessKey not set")
@@ -64,11 +71,16 @@ func NewSimpleClient(ctx *Context) (*SdkClient, error) {
 		sk = os.Getenv("VOLCENGINE_SECRET_KEY")
 		region = os.Getenv("VOLCENGINE_REGION")
 		endpoint = os.Getenv("VOLCENGINE_ENDPOINT")
+		endpointResolver = os.Getenv("VOLCENGINE_ENDPOINT_RESOLVER")
 		sessionToken = os.Getenv("VOLCENGINE_SESSION_TOKEN")
 		ssl := os.Getenv("VOLCENGINE_DISABLE_SSL")
 		if ssl == "true" || ssl == "false" {
 			disableSSl, _ = strconv.ParseBool(ssl)
 		}
+		dualStack := os.Getenv("VOLCENGINE_USE_DUALSTACK")
+		if dualStack == "true" || dualStack == "false" {
+			useDualStack, _ = strconv.ParseBool(dualStack)
+		}
 
 		if ak == "" {
 			return nil, fmt.Errorf("VOLCENGINE_ACCESS_KEY not set")
@@ -86,8 +98,18 @@ func NewSimpleClient(ctx *Context) (*SdkClient, error) {
 		WithCredentials(credentials.NewStaticCredentials(ak, sk, sessionToken)).
 		WithDisableSSL(disableSSl)
 
-	if endpoint != "" {
-		config.WithEndpoint(endpoint)
+	resolverValue := strings.ToLower(strings.TrimSpace(endpointResolver))
+	switch resolverValue {
+	case "standard":
+		config.WithEndpointResolver(endpoints.NewStandardEndpointResolver())
+	default:
+		if endpoint != "" {
+			config.WithEndpoint(endpoint)
+		}
+	}
+
+	if useDualStack {
+		config.WithUseDualStack(true)
 	}
 
 	sess, _ := session.NewSession(config)

cmd/version.go

@@ -12,4 +12,4 @@ var clientVersionAndUserAgentHandler = request.NamedHandler{
 }
 
 const clientName = "volcengine-cli"
-const clientVersion = "1.0.37"
+const clientVersion = "1.0.38"

go.mod

@@ -5,5 +5,5 @@ go 1.12
 require (
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/spf13/cobra v1.6.1
-	github.com/volcengine/volcengine-go-sdk v1.1.7
+	github.com/volcengine/volcengine-go-sdk v1.1.54
 )

go.sum

@@ -20,11 +20,13 @@ github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:W
 github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0=
 github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8=
 github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI=
+github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
 github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
 github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
 github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
 github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
@@ -54,6 +56,8 @@ github.com/volcengine/volc-sdk-golang v1.0.23 h1:anOslb2Qp6ywnsbyq9jqR0ljuO63kg9
 github.com/volcengine/volc-sdk-golang v1.0.23/go.mod h1:AfG/PZRUkHJ9inETvbjNifTDgut25Wbkm2QoYBTbvyU=
 github.com/volcengine/volcengine-go-sdk v1.1.7 h1:5ElF1inqX1QUKX8/XGk+HGpG+F01W+m73cLQH+0x50s=
 github.com/volcengine/volcengine-go-sdk v1.1.7/go.mod h1:EyKoi6t6eZxoPNGr2GdFCZti2Skd7MO3eUzx7TtSvNo=
+github.com/volcengine/volcengine-go-sdk v1.1.54 h1:5gHiDux021kxrhEpCPPGuFmDyp0LL/xO3lJT27ZGldE=
+github.com/volcengine/volcengine-go-sdk v1.1.54/go.mod h1:oxoVo+A17kvkwPkIeIHPVLjSw7EQAm+l/Vau1YGHN+A=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
@@ -92,6 +96,8 @@ google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2
 google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
 google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
 google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=
+google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
+google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=