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

Polaris CLI: add options for entities relation overview #989

Open
MonkeyCanCode opened this issue Feb 12, 2025 · 5 comments
Open

Polaris CLI: add options for entities relation overview #989

MonkeyCanCode opened this issue Feb 12, 2025 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@MonkeyCanCode
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Currently an user can use polaris cli to list entities (e.g. list principal, principal role, catalog, catalog role, privileges, etc.). This is great but seems to be really tedious for some common administration tasks such as

  1. what access does user X has and show the linked entities in an easy to read representation (e.g. https://polaris.apache.org/img/quickstart/privilege-illustration-2.png but on terminal)
  2. which entities are orphans
  3. what is the difference between two principals or catalog roles

Describe the solution you'd like

If there is no plan to add those as new API endpoints, we can always create wrapper function in existed CLI to invoke diff API endpoints and come up with the result for the above questions.

One concern I have with this approach is currently we have two "admin tools":

  1. java version for backend management (bootstrap and purge only)
  2. python version for polaris entities management (needed bootstrapped backend and doesn't support functionalities in java version)

Do we still want to proceed with above separation or move those into one instead?

Describe alternatives you've considered

No response

Additional context

No response

@MonkeyCanCode MonkeyCanCode added the enhancement New feature or request label Feb 12, 2025
@MonkeyCanCode
Copy link
Contributor Author

@HonahX @collado-mike @adutra @eric-maynard may I get some inputs on this and determine if this is something we would like to support?

@MonkeyCanCode MonkeyCanCode changed the title Polaris CLI: add option for entities relation overview Polaris CLI: add options for entities relation overview Feb 12, 2025
@eric-maynard
Copy link
Contributor

I'm very supportive of adding more subcommands, e.g. what is the difference between two principals or catalog roles.

However I do hope that we can keep the output of the CLI machine-parsable across the board. That can mean pretty JSON but I'd be anxious about a "diagram" kind of output.

@MonkeyCanCode
Copy link
Contributor Author

I'm very supportive of adding more subcommands, e.g. what is the difference between two principals or catalog roles.

However I do hope that we can keep the output of the CLI machine-parsable across the board. That can mean pretty JSON but I'd be anxious about a "diagram" kind of output.

Thanks for the feedback. Let me think about it then I will see what I can do.

@MonkeyCanCode
Copy link
Contributor Author

Sample PR for item 1: #1019

@MonkeyCanCode MonkeyCanCode self-assigned this Feb 24, 2025
@MonkeyCanCode
Copy link
Contributor Author

I will PR more to fill the gaps later this week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants