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.

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

server, ui: Merge Admin and Status endpoints #24989

Closed
BramGruneir opened this issue Apr 23, 2018 · 4 comments
Closed

server, ui: Merge Admin and Status endpoints #24989

BramGruneir opened this issue Apr 23, 2018 · 4 comments
Labels
A-kv-server Relating to the KV-level RPC server A-server-architecture Relates to the internal APIs and src org for server code A-webui-general Issues on the DB Console that span multiple areas or don't have another clear category. C-cleanup Tech debt, refactors, loose ends, etc. Solution not expected to significantly change behavior.

Comments

@BramGruneir
Copy link
Member

BramGruneir commented Apr 23, 2018

We have, for historical reasons, two different main endpoints for UI and Status data.

Originally, as we were upgrading the UI, the admin endpoint was supposed to handle all requests that were destined for the admin ui, as opposed to other misc endpoints. But that distinction is no longer true and never really was.

We also have to make sure that permissions are clear for every endpoint. And having the two endpoints is clearly just complicating that.

For anyone looking to add a new endpoint, there is no clear guidance, this makes doing any admin ui work more complicated.

I started auditing both and here are the endpoints in both right now:

Admin

  • Users
  • Databases
  • Database Detail
  • Tables
  • Table Stats
  • Non-Table Stats
  • Events
  • UI Data
  • Cluster Metadata
  • Cluster Settings
  • Diagnostics Report
  • Health
  • Liveness
  • Jobs
  • Locations
  • Query Plan
  • Drain

Status:

  • Certs
  • Node Details
  • Nodes
  • Raft
  • Ranges
  • Gossip
  • Allocator Simulation
  • Sessions
  • Sessions (Local)
  • Cancel Query
  • Cancel Session
  • Span
  • Stacks
  • Profile
  • Metrics
  • Log Files List
  • Log File
  • Logs
  • Problem Ranges
  • Range
  • Command Queue

It's obvious that there is no clear division between the two endpoints and I recommend that we move all into Status, just because there is less code movement. We should of course maintain the old links, at least until v2.2 or even v3.0.

Jira issue: CRDB-5737

@BramGruneir BramGruneir added this to the 2.1 milestone Apr 23, 2018
@BramGruneir
Copy link
Member Author

Assigning this to @couchand for triage.

@knz knz added C-cleanup Tech debt, refactors, loose ends, etc. Solution not expected to significantly change behavior. and removed refactoring labels Apr 24, 2018
@couchand couchand changed the title ui: Merge Admin and Status endpoints server, ui: Merge Admin and Status endpoints Apr 24, 2018
@couchand couchand added the A-webui-general Issues on the DB Console that span multiple areas or don't have another clear category. label Apr 24, 2018
@couchand
Copy link
Contributor

couchand commented May 15, 2018

My proposal, in light of the login work, is that status house endpoints that are accessible anonymously, and admin the endpoints that are not. (see #25526)

@piyush-singh
Copy link

We will not get to this in 2.1, bumping to Later. We can pull it into 2.2 depending on other priorities.

@couchand couchand added the A-kv-server Relating to the KV-level RPC server label Sep 20, 2018
@petermattis petermattis removed this from the Later milestone Oct 5, 2018
@knz
Copy link
Contributor

knz commented Sep 9, 2020

cc @thtruo @piyush-singh for tracking. This becomes highly relevant with our new transition to API-first

@jlinder jlinder added the T-server-and-security DB Server & Security label Jun 16, 2021
@knz knz added the A-server-architecture Relates to the internal APIs and src org for server code label Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-kv-server Relating to the KV-level RPC server A-server-architecture Relates to the internal APIs and src org for server code A-webui-general Issues on the DB Console that span multiple areas or don't have another clear category. C-cleanup Tech debt, refactors, loose ends, etc. Solution not expected to significantly change behavior.
Projects
None yet
Development

No branches or pull requests

7 participants