Polaris CLI should support specifying the realm

[rukor2]

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

This is useful if you have a non-default realm name. At the moment, it is impossible to use the CLI as it can either not generate a token or if you generate the token externally, you cant use it because it will complain that a Polaris-Realm header is not supplied.

Describe the solution you'd like

Allow for the CLI to support custom realms

Describe alternatives you've considered

No response

Additional context

No response

[dimas-b]

Thanks for reporting this, @rukor2 !

I added the "bug" label because Polaris Servers and the admin tool support realms as a first-class concept, therefore the CLI should be able to interact with any realm that a Polaris Server has.

[binarycat0]

I briefly checked the existing CLI doc https://polaris.apache.org/in-dev/unreleased/command-line-interface/
It seems there is no options to specify REALM really.

I will try to help with that. As I understand Polaris CLI is written on python based on click framework so it should NOT be hard.

[dimas-b]

"should NOT be hard"? 😉

[binarycat0]

I checked closely and as I see it uses custom ArgumentParser instead of click, but anyway it should NOT be hard

[binarycat0]

I can't find any reference to REALM in API specs - https://polaris.apache.org/in-dev/unreleased/polaris-api-specs/ 🤷‍♂️

The REALM documentation says - a realm is resolved from request headers but I can't find it in codebase 🤔

@rukor2 could you share an example how to use it in API calls?

[dimas-b]

Clients indicate the desired realm via a header, e.g. as in obtain-token.sh

[binarycat0]

I see that token scope is hardcoded also

polaris/client/python/cli/polaris_cli.py

Line 135 in 596239c

post_params={

[dimas-b]

PRINCIPAL_ROLE:ALL is fine for CLI to use for now, I think. We can make it user-settable later.

[rukor2]

I can't find any reference to REALM in API specs - https://polaris.apache.org/in-dev/unreleased/polaris-api-specs/ 🤷‍♂️

The REALM documentation says - a realm is resolved from request headers but I can't find it in codebase 🤔

@rukor2 could you share an example how to use it in API calls?

From the examples, I would do something like this to get access token for instance:

export ACCESS_TOKEN=$(curl -X POST \ ${POLARIS_URL}/api/catalog/v1/oauth/tokens \ -H 'Polaris-Realm:<realm name>' \ -d "grant_type=client_credentials&client_id=$ROOT_CLIENT_ID&client_secret=$ROOT_CLIENT_SECRET&scope=PRINCIPAL_ROLE:ALL" \ | jq -r '.access_token')