Add console endpoint config section and init arg (#361)

* Add console endpoint init arg and config section

Signed-off-by: Andrew Dye <[email protected]>

* Log invalid endpoint

Signed-off-by: Andrew Dye <[email protected]>

Signed-off-by: Andrew Dye <[email protected]>

flytectl/cmd/config/subcommand/config/console_flags.go

@@ -0,0 +1,20 @@
+package config
+
+import "github.com/flyteorg/flytestdlib/config"
+
+//go:generate pflags ConsoleConfig --default-var DefaultConsoleConfig --bind-default-var
+
+var (
+	DefaultConsoleConfig = &ConsoleConfig{}
+
+	cfg = config.MustRegisterSection("console", DefaultConsoleConfig)
+)
+
+// FilesConfig containing flags used for registration
+type ConsoleConfig struct {
+	Endpoint string `json:"endpoint" pflag:",Endpoint of console, if different than flyte admin"`
+}
+
+func GetConfig() *ConsoleConfig {
+	return cfg.GetConfig().(*ConsoleConfig)
+}

flytectl/cmd/config/subcommand/config/init_flags.go

@@ -9,6 +9,7 @@ var (
 
 // Configs
 type Config struct {
+	Console  string `json:"console" pflag:",Endpoint of console, if different than flyte admin"`
 	Host     string `json:"host" pflag:",Endpoint of flyte admin"`
 	Insecure bool   `json:"insecure" pflag:",Enable insecure mode"`
 }

flytectl/cmd/configuration/configuration.go

@@ -34,7 +34,6 @@ Flyte Sandbox is a fully standalone minimal environment for running Flyte.
 Read more about the Sandbox deployment :ref:` + "`here <deploy-sandbox-local>`" + `.
 
 Generate remote cluster config: 
-	
 ::
 
  flytectl config init --host=flyte.myexample.com
@@ -43,11 +42,15 @@ By default, the connection is secure.
 Read more about remote deployment :ref:` + "`here <Deployment>`" + `.
 
 Generate remote cluster config with insecure connection:
-
 ::
 
  flytectl config init --host=flyte.myexample.com --insecure 
 
+ Generate remote cluster config with separate console endpoint:
+ ::
+
+  flytectl config init --host=flyte.myexample.com --console=console.myexample.com
+
 Generate Flytectl config with a storage provider:
 ::
 
@@ -90,11 +93,18 @@ func initFlytectlConfig(reader io.Reader) error {
 	if len(initConfig.DefaultConfig.Host) > 0 {
 		trimHost := trimEndpoint(initConfig.DefaultConfig.Host)
 		if !validateEndpointName(trimHost) {
-			return errors.New("Please use a valid endpoint")
+			return fmt.Errorf("%s invalid, please use a valid admin endpoint", trimHost)
 		}
 		templateValues.Host = fmt.Sprintf("dns:///%s", trimHost)
 		templateValues.Insecure = initConfig.DefaultConfig.Insecure
 	}
+	if len(initConfig.DefaultConfig.Console) > 0 {
+		trimConsole := trimEndpoint(initConfig.DefaultConfig.Console)
+		if !validateEndpointName(trimConsole) {
+			return fmt.Errorf("%s invalid, please use a valid console endpoint", trimConsole)
+		}
+		templateValues.Console = initConfig.DefaultConfig.Console
+	}
 	var _err error
 	if _, err := os.Stat(configutil.ConfigFile); os.IsNotExist(err) {
 		_err = configutil.SetupConfig(configutil.ConfigFile, templateStr, templateValues)

flytectl/config.yaml

@@ -3,6 +3,8 @@ admin:
   endpoint: dns:///localhost:30081
   insecure: true
   authType: Pkce
+console:
+  endpoint: http://localhost:30080
 logger:
   show-source: true
   level: 0

flytectl/pkg/configutil/configutil.go

@@ -13,6 +13,10 @@ const (
   endpoint: {{.Host}}
   authType: Pkce
   insecure: {{.Insecure}}
+{{- if .Console}}
+console:
+  endpoint: {{.Console}}
+{{- end}}
 logger:
   show-source: true
   level: 0`
@@ -21,6 +25,7 @@ logger:
 type ConfigTemplateSpec struct {
 	Host     string
 	Insecure bool
+	Console  string
 }
 
 var (

flytectl/pkg/configutil/configutil_test.go

@@ -7,8 +7,60 @@ import (
 
 	f "github.com/flyteorg/flytectl/pkg/filesystemutils"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
+func TestSetupConfig(t *testing.T) {
+	file, err := os.CreateTemp("", "*.yaml")
+	require.NoError(t, err)
+
+	templateValue := ConfigTemplateSpec{
+		Host:     "dns:///localhost:30081",
+		Insecure: true,
+	}
+	err = SetupConfig(file.Name(), AdminConfigTemplate, templateValue)
+	assert.NoError(t, err)
+	configBytes, err := ioutil.ReadAll(file)
+	assert.NoError(t, err)
+	expected := `admin:
+  # For GRPC endpoints you might want to use dns:///flyte.myexample.com
+  endpoint: dns:///localhost:30081
+  authType: Pkce
+  insecure: true
+logger:
+  show-source: true
+  level: 0`
+	assert.Equal(t, expected, string(configBytes))
+
+	file, err = os.Create(file.Name())
+	require.NoError(t, err)
+	templateValue = ConfigTemplateSpec{
+		Host:     "dns:///admin.example.com",
+		Insecure: true,
+		Console:  "https://console.example.com",
+	}
+	err = SetupConfig(file.Name(), AdminConfigTemplate, templateValue)
+	assert.NoError(t, err)
+	configBytes, err = ioutil.ReadAll(file)
+	assert.NoError(t, err)
+	expected = `admin:
+  # For GRPC endpoints you might want to use dns:///flyte.myexample.com
+  endpoint: dns:///admin.example.com
+  authType: Pkce
+  insecure: true
+console:
+  endpoint: https://console.example.com
+logger:
+  show-source: true
+  level: 0`
+	assert.Equal(t, expected, string(configBytes))
+
+	// Cleanup
+	if file != nil {
+		_ = os.Remove(file.Name())
+	}
+}
+
 func TestConfigCleanup(t *testing.T) {
 	_, err := os.Stat(f.FilePathJoin(f.UserHomeDir(), ".flyte"))
 	if os.IsNotExist(err) {

flytectl/pkg/sandbox/start.go

@@ -168,6 +168,7 @@ func startSandbox(ctx context.Context, cli docker.Docker, g github.GHRepoService
 	templateValues := configutil.ConfigTemplateSpec{
 		Host:     "localhost:30081",
 		Insecure: true,
+		Console:  fmt.Sprintf("http://localhost:%d", consolePort),
 	}
 	if err := configutil.SetupConfig(configutil.FlytectlConfig, configutil.GetTemplate(), templateValues); err != nil {
 		return nil, err