use env var instead of config file

Signed-off-by: mornyx <[email protected]>
baurine · Sep 9, 2024 · 2b595a9 · 2b595a9
1 parent e365041
commit 2b595a9
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 12 deletions.
diff --git a/conf/config.toml b/conf/config.toml
@@ -200,6 +200,3 @@
 
 ## When enabled, usage data will be sent to PingCAP for improving user experience.
 # enable-telemetry = false
-
-## When enabled, configuring a custom prometheus address through Dashboard will not be allowed.
-# disable-custom-prom-addr = false
diff --git a/pkg/dashboard/adapter/config.go b/pkg/dashboard/adapter/config.go
@@ -15,11 +15,18 @@
 package adapter
 
 import (
+	"os"
+	"strings"
+
 	"github.com/pingcap/tidb-dashboard/pkg/config"
 
 	"github.com/tikv/pd/server"
 )
 
+const (
+	envTidbDashboardDisableCustomPromAddr = "TIDB_DASHBOARD_DISABLE_CUSTOM_PROM_ADDR"
+)
+
 // GenDashboardConfig generates a configuration for Dashboard Server.
 func GenDashboardConfig(srv *server.Server) (*config.Config, error) {
 	cfg := srv.GetConfig()
@@ -35,7 +42,6 @@ func GenDashboardConfig(srv *server.Server) (*config.Config, error) {
 	dashboardCfg.PublicPathPrefix = cfg.Dashboard.PublicPathPrefix
 	dashboardCfg.EnableTelemetry = cfg.Dashboard.EnableTelemetry
 	dashboardCfg.EnableExperimental = cfg.Dashboard.EnableExperimental
-	dashboardCfg.DisableCustomPromAddr = cfg.Dashboard.DisableCustomPromAddr
 	if dashboardCfg.ClusterTLSConfig, err = cfg.Security.ToTLSConfig(); err != nil {
 		return nil, err
 	}
@@ -48,5 +54,11 @@ func GenDashboardConfig(srv *server.Server) (*config.Config, error) {
 
 	dashboardCfg.NormalizePublicPathPrefix()
 
+	// Allow setting DisableCustomPromAddr via environment variable.
+	disableCustomPromAddr := strings.ToLower(os.Getenv(envTidbDashboardDisableCustomPromAddr))
+	if disableCustomPromAddr == "true" || disableCustomPromAddr == "1" {
+		dashboardCfg.DisableCustomPromAddr = true
+	}
+
 	return dashboardCfg, nil
 }
diff --git a/server/config/config.go b/server/config/config.go
@@ -1362,14 +1362,13 @@ func (c *Config) GenEmbedEtcdConfig() (*embed.Config, error) {
 
 // DashboardConfig is the configuration for tidb-dashboard.
 type DashboardConfig struct {
-	TiDBCAPath            string `toml:"tidb-cacert-path" json:"tidb-cacert-path"`
-	TiDBCertPath          string `toml:"tidb-cert-path" json:"tidb-cert-path"`
-	TiDBKeyPath           string `toml:"tidb-key-path" json:"tidb-key-path"`
-	PublicPathPrefix      string `toml:"public-path-prefix" json:"public-path-prefix"`
-	InternalProxy         bool   `toml:"internal-proxy" json:"internal-proxy"`
-	EnableTelemetry       bool   `toml:"enable-telemetry" json:"enable-telemetry"`
-	EnableExperimental    bool   `toml:"enable-experimental" json:"enable-experimental"`
-	DisableCustomPromAddr bool   `toml:"disable-custom-prom-addr" json:"disable-custom-prom-addr"`
+	TiDBCAPath         string `toml:"tidb-cacert-path" json:"tidb-cacert-path"`
+	TiDBCertPath       string `toml:"tidb-cert-path" json:"tidb-cert-path"`
+	TiDBKeyPath        string `toml:"tidb-key-path" json:"tidb-key-path"`
+	PublicPathPrefix   string `toml:"public-path-prefix" json:"public-path-prefix"`
+	InternalProxy      bool   `toml:"internal-proxy" json:"internal-proxy"`
+	EnableTelemetry    bool   `toml:"enable-telemetry" json:"enable-telemetry"`
+	EnableExperimental bool   `toml:"enable-experimental" json:"enable-experimental"`
 }
 
 // ToTiDBTLSConfig generates tls config for connecting to TiDB, used by tidb-dashboard.