Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(dashboard): update TiDB Dashboard to v6.5.11-9d2b0ce6 [release-6.5] #8601

Merged
merged 3 commits into from
Sep 10, 2024
Merged

chore(dashboard): update TiDB Dashboard to v6.5.11-9d2b0ce6 [release-6.5] #8601

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
831898e
chore(dashboard): update TiDB Dashboard to v6.5.11-9d2b0ce6
baurine Sep 9, 2024
e365041
add config item
mornyx Sep 9, 2024
2b595a9
use env var instead of config file
mornyx Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions conf/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,6 @@

## 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
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ require (
github.com/pingcap/kvproto v0.0.0-20230726063044-73d6d7f3756b
github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3
github.com/pingcap/sysutil v0.0.0-20211208032423-041a72e5860d
github.com/pingcap/tidb-dashboard v0.0.0-20240327052925-0f035e0e22ee
github.com/pingcap/tidb-dashboard v0.0.0-20240830072655-9d2b0ce603a1
github.com/prometheus/client_golang v1.11.1
github.com/prometheus/common v0.26.0
github.com/sasha-s/go-deadlock v0.2.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,8 +394,8 @@ github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3 h1:HR/ylkkLmGdSSDaD8
github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3/go.mod h1:DWQW5jICDR7UJh4HtxXSM20Churx4CQL0fwL/SoOSA4=
github.com/pingcap/sysutil v0.0.0-20211208032423-041a72e5860d h1:k3/APKZjXOyJrFy8VyYwRlZhMelpD3qBLJNsw3bPl/g=
github.com/pingcap/sysutil v0.0.0-20211208032423-041a72e5860d/go.mod h1:7j18ezaWTao2LHOyMlsc2Dg1vW+mDY9dEbPzVyOlaeM=
github.com/pingcap/tidb-dashboard v0.0.0-20240327052925-0f035e0e22ee h1:NRj1mZgcyXxvbvb0eaoI5UZCQfT2kv3oKwlb4bdgXGY=
github.com/pingcap/tidb-dashboard v0.0.0-20240327052925-0f035e0e22ee/go.mod h1:ucZBRz52icb23T/5Z4CsuUHmarYiin7p2MeiVBe+o8c=
github.com/pingcap/tidb-dashboard v0.0.0-20240830072655-9d2b0ce603a1 h1:otd51FMCCJiW7wagKABCeULfcZdMI+WCTH5N6emPGzY=
github.com/pingcap/tidb-dashboard v0.0.0-20240830072655-9d2b0ce603a1/go.mod h1:ucZBRz52icb23T/5Z4CsuUHmarYiin7p2MeiVBe+o8c=
github.com/pingcap/tipb v0.0.0-20220718022156-3e2483c20a9e h1:FBaTXU8C3xgt/drM58VHxojHo/QoG1oPsgWTGvaSpO4=
github.com/pingcap/tipb v0.0.0-20220718022156-3e2483c20a9e/go.mod h1:A7mrd7WHBl1o63LE2bIBGEJMTNWXqhgmYiOvMLxozfs=
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
Expand Down
1 change: 1 addition & 0 deletions pkg/dashboard/adapter/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will the config be lost when we upgrade?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will the config be lost when we upgrade?

This configuration already exists in the master and release-6.5 branches of tidb-dashboard and will not be lost during a normal upgrade.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we set it to true in 6.5.11, then the cluster is upgraded to 7.1.x which doesn't contain this PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I get what you mean. This change will be cherry-picked to all LTS branches later. (At least for now only 6.5.x customers explicitly need to configure this.)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If an upgrade occurs during this period, this configuration will indeed lose its effect.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After losing it, if we upgrade again to a higher version with this config, the config value will be changed to false.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is acceptable and I will doc this behavior. It is expected that this configuration will not work after upgrading to a version that does not support this feature.

if dashboardCfg.ClusterTLSConfig, err = cfg.Security.ToTLSConfig(); err != nil {
return nil, err
}
Expand Down
2 changes: 1 addition & 1 deletion scripts/dashboard-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# This file is updated by running scripts/update-dashboard.sh
# Don't edit it manullay
6.5.9-0f035e0e
6.5.11-9d2b0ce6
15 changes: 8 additions & 7 deletions server/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1362,13 +1362,14 @@ 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"`
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"`
}

// ToTiDBTLSConfig generates tls config for connecting to TiDB, used by tidb-dashboard.
Expand Down
2 changes: 1 addition & 1 deletion tests/client/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ require (
github.com/pingcap/errors v0.11.5-0.20211224045212-9687c2b0f87c // indirect
github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3 // indirect
github.com/pingcap/sysutil v0.0.0-20211208032423-041a72e5860d // indirect
github.com/pingcap/tidb-dashboard v0.0.0-20240327052925-0f035e0e22ee // indirect
github.com/pingcap/tidb-dashboard v0.0.0-20240830072655-9d2b0ce603a1 // indirect
github.com/pingcap/tipb v0.0.0-20220718022156-3e2483c20a9e // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
Expand Down
4 changes: 2 additions & 2 deletions tests/client/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,8 +347,8 @@ github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3 h1:HR/ylkkLmGdSSDaD8
github.com/pingcap/log v1.1.1-0.20221110025148-ca232912c9f3/go.mod h1:DWQW5jICDR7UJh4HtxXSM20Churx4CQL0fwL/SoOSA4=
github.com/pingcap/sysutil v0.0.0-20211208032423-041a72e5860d h1:k3/APKZjXOyJrFy8VyYwRlZhMelpD3qBLJNsw3bPl/g=
github.com/pingcap/sysutil v0.0.0-20211208032423-041a72e5860d/go.mod h1:7j18ezaWTao2LHOyMlsc2Dg1vW+mDY9dEbPzVyOlaeM=
github.com/pingcap/tidb-dashboard v0.0.0-20240327052925-0f035e0e22ee h1:NRj1mZgcyXxvbvb0eaoI5UZCQfT2kv3oKwlb4bdgXGY=
github.com/pingcap/tidb-dashboard v0.0.0-20240327052925-0f035e0e22ee/go.mod h1:ucZBRz52icb23T/5Z4CsuUHmarYiin7p2MeiVBe+o8c=
github.com/pingcap/tidb-dashboard v0.0.0-20240830072655-9d2b0ce603a1 h1:otd51FMCCJiW7wagKABCeULfcZdMI+WCTH5N6emPGzY=
github.com/pingcap/tidb-dashboard v0.0.0-20240830072655-9d2b0ce603a1/go.mod h1:ucZBRz52icb23T/5Z4CsuUHmarYiin7p2MeiVBe+o8c=
github.com/pingcap/tipb v0.0.0-20220718022156-3e2483c20a9e h1:FBaTXU8C3xgt/drM58VHxojHo/QoG1oPsgWTGvaSpO4=
github.com/pingcap/tipb v0.0.0-20220718022156-3e2483c20a9e/go.mod h1:A7mrd7WHBl1o63LE2bIBGEJMTNWXqhgmYiOvMLxozfs=
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
Expand Down
Loading