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

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

Open
knz opened this issue Jan 29, 2020 · 5 comments
Open

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

knz opened this issue Jan 29, 2020 · 5 comments
Labels
A-observability-inf A-webui Triage label for DB Console (fka admin UI) issues. Add this if nothing else is clear. C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) T-observability
Projects
Cluster UI

Comments

@knz
Copy link
Contributor

knz commented Jan 29, 2020 •
edited

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 knz added C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) A-webui Triage label for DB Console (fka admin UI) issues. Add this if nothing else is clear. A-cli labels Jan 29, 2020
@knz knz added this to To do in DB Server & Security via automation Jan 29, 2020
@knz
Copy link
Contributor Author

knz commented Jan 29, 2020

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

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

@knz knz changed the title cli/ui: more prominently report the cluster name cli,ui: more prominently report the cluster name Jan 29, 2020
@knz knz moved this from To do to 20.1 in DB Server & Security Jan 29, 2020
@knz
Copy link
Contributor Author

knz commented Feb 3, 2020

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)

@knz knz moved this from 20.1 to Cold storage in DB Server & Security Feb 3, 2020
@piyush-singh piyush-singh added this to Backlog in Cluster UI Apr 6, 2020
@knz knz moved this from Cold storage to To do in DB Server & Security Apr 17, 2020
@knz knz moved this from To do to Cold storage in DB Server & Security Apr 17, 2020
@piyush-singh
Copy link

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
Copy link
Contributor Author

knz commented May 12, 2020

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 knz removed the A-cli label Mar 20, 2021
@jlinder jlinder added the T-server-and-security DB Server & Security label Jun 16, 2021
@knz knz added the A-server-networking Pertains to network addressing,routing,initialization label Jul 29, 2021
@knz knz changed the title cli,ui: more prominently report the cluster name cli,ui: make CRDB recognize the CC cluster name in configuration and display it in DB Console and other places Jul 31, 2023
@knz knz added T-observability-inf and removed T-server-and-security DB Server & Security A-server-networking Pertains to network addressing,routing,initialization labels Jul 31, 2023
@knz knz removed this from Cold storage in DB Server & Security Jul 31, 2023
@knz
Copy link
Contributor Author

knz commented Jul 31, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-observability-inf A-webui Triage label for DB Console (fka admin UI) issues. Add this if nothing else is clear. C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) T-observability
Projects
No open projects
Cluster UI
  
Backlog
Milestone
No milestone
Development

No branches or pull requests
5 participants
@kenliu @jlinder @knz @piyush-singh @elinorgarcia