feat(console): support custom config

cmd/tke-auth-api/app/config/config.go

@@ -26,6 +26,7 @@ import (
 	"regexp"
 	"strings"
 	"time"
+
 	"tkestack.io/tke/pkg/auth/authentication/oidc/identityprovider/cloudindustry"
 
 	"github.com/casbin/casbin/v2"
@@ -76,8 +77,10 @@ import (
 )
 
 const (
-	license = "Apache 2.0"
-	title   = "Tencent Kubernetes Engine Auth API"
+	license        = "Apache 2.0"
+	title          = "Tencent Kubernetes Engine Auth API"
+	defaultTitle   = "TKEStack"
+	defaultLogoDir = "default"
 )
 
 // Config is the running configuration structure of the TKE controller manager.
@@ -96,6 +99,7 @@ type Config struct {
 	Authorizer           authorizer.Authorizer
 	CasbinReloadInterval time.Duration
 	PrivilegedUsername   string
+	ConsoleConfig        *apiserver.ConsoleConfig
 }
 
 // CreateConfigFromOptions creates a running configuration instance based
@@ -200,6 +204,8 @@ func CreateConfigFromOptions(serverName string, opts *options.Options) (*Config,
 		return nil, err
 	}
 
+	setupDefaultConsoleConfig(opts.ConsoleConfig)
+
 	return &Config{
 		ServerName:                     serverName,
 		OIDCExternalAddress:            dexConfig.Issuer,
@@ -214,9 +220,19 @@ func CreateConfigFromOptions(serverName string, opts *options.Options) (*Config,
 		Authorizer:                     aggregateAuthz,
 		PrivilegedUsername:             opts.Authentication.PrivilegedUsername,
 		CasbinReloadInterval:           opts.Authorization.CasbinReloadInterval,
+		ConsoleConfig:                  opts.ConsoleConfig,
 	}, nil
 }
 
+func setupDefaultConsoleConfig(consoleConfig *apiserver.ConsoleConfig) {
+	if len(consoleConfig.Title) == 0 {
+		consoleConfig.Title = defaultTitle
+	}
+	if len(consoleConfig.LogoDir) == 0 {
+		consoleConfig.LogoDir = defaultLogoDir
+	}
+}
+
 func setupAuthentication(genericAPIServerConfig *genericapiserver.Config, opts *apiserveroptions.AuthenticationWithAPIOptions, tokenAuthenticators []genericauthenticator.Token) error {
 	if err := authentication.SetupAuthentication(genericAPIServerConfig, opts); err != nil {
 		return nil

cmd/tke-auth-api/app/options/options.go

@@ -25,6 +25,7 @@ import (
 	genericapiserveroptions "k8s.io/apiserver/pkg/server/options"
 	apiserveroptions "tkestack.io/tke/pkg/apiserver/options"
 	storageoptions "tkestack.io/tke/pkg/apiserver/storage/options"
+	"tkestack.io/tke/pkg/auth/apiserver"
 	"tkestack.io/tke/pkg/util/cachesize"
 	"tkestack.io/tke/pkg/util/log"
 )
@@ -40,6 +41,7 @@ type Options struct {
 	ETCD           *storageoptions.ETCDStorageOptions
 	Auth           *AuthOptions
 	Audit          *genericapiserveroptions.AuditOptions
+	ConsoleConfig  *apiserver.ConsoleConfig
 }
 
 // NewOptions creates a new Options with a default config.
@@ -54,6 +56,7 @@ func NewOptions(serverName string) *Options {
 		ETCD:           storageoptions.NewETCDStorageOptions("/tke/auth-api"),
 		Auth:           NewAuthOptions(),
 		Audit:          genericapiserveroptions.NewAuditOptions(),
+		ConsoleConfig:  apiserver.NewConsoleConfigOptions(),
 	}
 }
 
@@ -68,6 +71,7 @@ func (o *Options) AddFlags(fs *pflag.FlagSet) {
 	o.Authorization.AddFlags(fs)
 	o.Auth.AddFlags(fs)
 	o.Audit.AddFlags(fs)
+	o.ConsoleConfig.AddFlags(fs)
 }
 
 // ApplyFlags parsing parameters from the command line or configuration file
@@ -83,6 +87,7 @@ func (o *Options) ApplyFlags() []error {
 	errs = append(errs, o.Authentication.ApplyFlags()...)
 	errs = append(errs, o.Authorization.ApplyFlags()...)
 	errs = append(errs, o.Auth.ApplyFlags()...)
+	errs = append(errs, o.ConsoleConfig.ApplyFlags()...)
 
 	return errs
 }

cmd/tke-auth-api/app/server.go

@@ -71,6 +71,7 @@ func createAPIServerConfig(cfg *config.Config) *apiserver.Config {
 			Authorizer:              cfg.Authorizer,
 			CasbinReloadInterval:    cfg.CasbinReloadInterval,
 			PrivilegedUsername:      cfg.PrivilegedUsername,
+			ConsoleConfig:           cfg.ConsoleConfig,
 		},
 	}
 }

pkg/auth/apiserver/apiserver.go

@@ -36,6 +36,8 @@ import (
 
 	dexstorage "github.com/dexidp/dex/storage"
 	"github.com/emicklei/go-restful"
+	"github.com/spf13/pflag"
+	"github.com/spf13/viper"
 	"k8s.io/apiserver/pkg/server/mux"
 
 	"github.com/casbin/casbin/v2"
@@ -66,10 +68,12 @@ const (
 	AuthPath           = "/auth/"
 	APIKeyPasswordPath = "/apis/auth.tkestack.io/v1/apikeys/default/password"
 
-	APIKeyPath     = "/apis/auth.tkestack.io/v1/apikeys"
-	defaultTitle   = "TKEStack"
-	defaultLogoDir = ""
-	htmlTmplDir    = "web/auth/templates/"
+	APIKeyPath           = "/apis/auth.tkestack.io/v1/apikeys"
+	htmlTmplDir          = "web/auth/templates/"
+	flagConsoleTitle     = "title"
+	flagConsoleLogoDir   = "logo-dir"
+	configConsoleTitle   = "console_config.title"
+	configConsoleLogoDir = "console_config.logo_dir"
 )
 
 func IgnoreAuthPathPrefixes() []string {
@@ -133,6 +137,34 @@ type ConsoleConfig struct {
 	LogoDir string
 }
 
+// NewAuthOptions creates a AuthOptions object with default parameters.
+func NewConsoleConfigOptions() *ConsoleConfig {
+	return &ConsoleConfig{}
+}
+
+// AddFlags adds flags for console to the specified FlagSet object.
+func (o *ConsoleConfig) AddFlags(fs *pflag.FlagSet) {
+	fs.String(flagConsoleTitle, o.Title,
+		"Custom console title.")
+	_ = viper.BindPFlag(configConsoleTitle, fs.Lookup(flagConsoleTitle))
+
+	fs.String(flagConsoleLogoDir, o.LogoDir,
+		"Custom console logo dir.")
+	_ = viper.BindPFlag(configConsoleLogoDir, fs.Lookup(flagConsoleLogoDir))
+
+}
+
+// ApplyFlags parsing parameters from the command line or configuration file
+// to the options instance.
+func (o *ConsoleConfig) ApplyFlags() []error {
+	var errs []error
+
+	o.Title = viper.GetString(configConsoleTitle)
+	o.LogoDir = viper.GetString(configConsoleLogoDir)
+
+	return errs
+}
+
 // Complete fills in any fields not set that are required to have valid data.
 // It's mutating the receiver.
 func (cfg *Config) Complete() CompletedConfig {
@@ -151,14 +183,6 @@ func (c completedConfig) New(delegationTarget genericapiserver.DelegationTarget)
 		return nil, err
 	}
 
-	consoleConfig := new(ConsoleConfig)
-	if c.ExtraConfig.ConsoleConfig != nil {
-		consoleConfig = c.ExtraConfig.ConsoleConfig
-	} else {
-		consoleConfig.Title = defaultTitle
-		consoleConfig.LogoDir = defaultLogoDir
-	}
-
 	files, err := ioutil.ReadDir(htmlTmplDir)
 	if err != nil {
 		return nil, err
@@ -170,7 +194,7 @@ func (c completedConfig) New(delegationTarget genericapiserver.DelegationTarget)
 		if err != nil {
 			return nil, err
 		}
-		if err = t.Execute(&buf, consoleConfig); err != nil {
+		if err = t.Execute(&buf, c.ExtraConfig.ConsoleConfig); err != nil {
 			return nil, err
 		}
 		// // remove .tmpl in file name

pkg/gateway/gateway.go

@@ -33,13 +33,12 @@ import (
 	"tkestack.io/tke/pkg/gateway/websocket"
 	"tkestack.io/tke/pkg/gateway/webtty"
 
-	// "tkestack.io/tke/pkg/util/template"
 	"html/template"
 )
 
 const (
 	defaultTitle  = "TKEStack"
-	defaultLogDir = ""
+	defaultLogDir = "default"
 )
 
 // ExtraConfig contains the additional configuration of apiserver.