Skip to content

#686 - Add verbose option for config show POOL #690

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

Merged
RyaliNvidia merged 2 commits into from
Mar 11, 2026
Merged

#686 - Add verbose option for config show POOL #690

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58fdb99
Add verbose mode for config show
ecolternv Mar 11, 2026
a863312
Fix for past revisions
ecolternv Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions src/cli/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,20 +324,25 @@ def _fetch_data_from_config(config_info: Any) -> Any:
return config_info


def _get_current_config(service_client: client.ServiceClient, config_type: str) -> Any:
def _get_current_config(
service_client: client.ServiceClient,
config_type: str,
params: Dict[str, Any] | None = None,
) -> Any:
"""
Get the current config
Args:
service_client: The service client instance
config_type: The string config type from parsed arguments
params: Optional query parameters to include in the request
"""
if config_type not in [t.value for t in config_history.ConfigHistoryType]:
raise osmo_errors.OSMOUserError(
f'Invalid config type "{config_type}". '
f'Available types: {CONFIG_TYPES_STRING}'
)
return service_client.request(
client.RequestMethod.GET, f'api/configs/{config_type.lower()}'
client.RequestMethod.GET, f'api/configs/{config_type.lower()}', params=params
)


Expand All @@ -351,6 +356,10 @@ def _run_show_command(service_client: client.ServiceClient, args: argparse.Names
# Parse the config identifier
if ':' in args.config:
# Format is <CONFIG_TYPE>:<revision>
if args.verbose:
raise osmo_errors.OSMOUserError(
'--verbose is not supported for historical revisions'
)
revision = config_history.ConfigHistoryRevision(args.config)
params: Dict[str, Any] = {
'config_types': [revision.config_type.value],
Expand All @@ -369,7 +378,12 @@ def _run_show_command(service_client: client.ServiceClient, args: argparse.Names
data = result['configs'][0]['data']
else:
# Format is <CONFIG_TYPE>
data = _get_current_config(service_client, args.config)
if args.verbose and args.config != config_history.ConfigHistoryType.POOL.value:
raise osmo_errors.OSMOUserError(
f'--verbose is only supported for POOL configs, not {args.config}'
)
request_params: Dict[str, Any] | None = {'verbose': True} if args.verbose else None
data = _get_current_config(service_client, args.config, params=request_params)

# Handle multiple name arguments for indexing
if args.names:
Expand Down Expand Up @@ -897,6 +911,12 @@ def setup_parser(parser: argparse._SubParsersAction):
Show the ``user_workflow_limits`` workflow configuration in a previous revision::

osmo config show WORKFLOW:3 user_workflow_limits

Show a pool configuration with parsed pod templates, group templates, and resource validations::

osmo config show POOL --verbose

osmo config show POOL my-pool --verbose
'''
)
show_parser.add_argument(
Expand All @@ -909,6 +929,12 @@ def setup_parser(parser: argparse._SubParsersAction):
nargs='*',
help='Optional names/indices to index into the config. Can be used to show a named config.'
)
show_parser.add_argument(
'--verbose', '-v',
action='store_true',
help='Show verbose output including parsed pod templates, group templates, and resource '
'validations. Only applicable when CONFIG_TYPE is POOL.',
)

show_parser.set_defaults(func=_run_show_command)

Expand Down
Loading