cli,ui: make CRDB recognize the CC cluster name in configuration and display it in DB Console and other places

cockroachdb / cockroach

CockroachDB — the cloud native, distributed SQL database designed for high availability, effortless scale, and control over data placement.

https://www.cockroachlabs.com

Other

30.11k stars 3.81k forks source link

cli,ui: make CRDB recognize the CC cluster name in configuration and display it in DB Console and other places #44494

Open knz opened 4 years ago

knz commented 4 years ago

In CC it is customary when raising a support case to share the CC "cluster name" ("friendly ID") with the team. However, when in front of DB console that cluster name is not displayed anywhere.

It would be useful to make CRDB recognize an optional and configurable "cluster name" for display purposes and this would be reported:

at the start of a SQL shell, alongside the cluster ID
as an info message upon cockroach node, cockroach init
in the UI page next to the cluster ID

Note: this feature is different from the (internal) "cluster name" used by the RPC protocol authentication, which is immutable and should remain relatively secret. Perhaps the internal value could be renamed to "cluster key" for clarity.

cc @awoods187 who was asking about it

Jira issue: CRDB-5223

knz commented 4 years ago

Caveat: the "cluster name" introduced in 19.2 is non-customizable.

If users want a customizable strings, that would be a different feature.

knz commented 4 years ago

Discussed this with the CockroachCloud team: in CC the (logical) cluster name is prominently displayed in the URL bar of the browser, because CC uses the cluster name in the hostname of the admin UI.

From a UX perspective this is already a great step forward to achieve the goal (distinguishing diffrent clusters in the browser).

I still think we should display the value of --cluster-name and perhaps introduce a user-customizable "cluster label" for the UI, but given that CC already has a solution for this perhaps we can de-prioritize this for 20.1 ("cloud-first" strategy)

piyush-singh commented 4 years ago

Bumping this for 20.2, we have heard several points of feedback that users would prefer to see the cluster name in the Admin UI instead of cluster ID. cc @Annebirzin

knz commented 4 years ago

Note that we probably need a new concept (customizable cluster label) separate from the "cluster name" functionality which cannot easily be customized after the cluster is started.

knz commented 1 year ago

This came up again today from @smcvey . (slack thread)