kyuubi icon indicating copy to clipboard operation
kyuubi copied to clipboard

support list server configs by admin cli tool

Open bowenliang123 opened this issue 1 year ago โ€ข 2 comments

:mag: Description

Issue References ๐Ÿ”—

This pull request fixes #

Describe Your Solution ๐Ÿ”ง

  • add command list config in admin cli tool , for listing all the server configs, which is useful for checking runtime configs when before/after refreshing the configs of user-defaults or non-user-defaults

Types of changes :bookmark:

  • [ ] Bugfix (non-breaking change which fixes an issue)
  • [x] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Test Plan ๐Ÿงช

Behavior Without This Pull Request :coffin:

Behavior With This Pull Request :tada:

Related Unit Tests


Checklist ๐Ÿ“

Be nice. Be informative.

bowenliang123 avatar Sep 18 '24 02:09 bowenliang123

Codecov Report

Attention: Patch coverage is 0% with 45 lines in your changes missing coverage. Please review.

Project coverage is 0.00%. Comparing base (8056235) to head (1c1d58d). Report is 99 commits behind head on master.

Files with missing lines Patch % Lines
...g/apache/kyuubi/client/api/v1/dto/ConfigEntry.java 0.00% 17 Missing :warning:
...e/kyuubi/ctl/cmd/list/AdminListConfigCommand.scala 0.00% 7 Missing :warning:
...rg/apache/kyuubi/server/api/v1/AdminResource.scala 0.00% 6 Missing :warning:
...in/java/org/apache/kyuubi/client/AdminRestApi.java 0.00% 5 Missing :warning:
...main/scala/org/apache/kyuubi/ctl/util/Render.scala 0.00% 4 Missing :warning:
...in/scala/org/apache/kyuubi/config/KyuubiConf.scala 0.00% 3 Missing :warning:
...a/org/apache/kyuubi/ctl/opt/AdminCommandLine.scala 0.00% 2 Missing :warning:
...ache/kyuubi/ctl/cli/AdminControlCliArguments.scala 0.00% 1 Missing :warning:
Additional details and impacted files
@@          Coverage Diff           @@
##           master   #6702   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files         684     686    +2     
  Lines       42279   42324   +45     
  Branches     5765    5770    +5     
======================================
- Misses      42279   42324   +45     
Flag Coverage ฮ”
0.00% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Sep 18 '24 03:09 codecov-commenter

listing configurations should be restricted to admin only. additionally, we may need to have another parameter to define the display mode for configuration values, e.g.

  • ALL - display all configuration values as-is
  • REDACTED - to avoid displaying password/secret values

PS: I remember there was a similar request to have a configuration display mode of configurations for retrieving batch info

pan3793 avatar Sep 22 '24 17:09 pan3793

Thanks for the PR! This PR is being closed due to inactivity. This isn't a judgement on the merit of the PR in any way. If this is still an issue with the latest version of Kyuubi, please reopen it and ask a committer to remove the Stale tag!

Thank you for using Kyuubi!

github-actions[bot] avatar Jan 16 '25 00:01 github-actions[bot]