Skip to content

HDDS-499. Display descriptions for properties on the configuration page#9152

Merged
adoroszlai merged 4 commits intoapache:masterfrom
ptlrs:HDDS-499-Configuration-page-does-not-show-description
Nov 19, 2025
Merged

HDDS-499. Display descriptions for properties on the configuration page#9152
adoroszlai merged 4 commits intoapache:masterfrom
ptlrs:HDDS-499-Configuration-page-does-not-show-description

Conversation

@ptlrs
Copy link
Contributor

@ptlrs ptlrs commented Oct 14, 2025

What changes were proposed in this pull request?

When the properties are read by the internal hadoop libraries from the config files, they return a simple hashmap of keys and values. It maybe more complex to update that code to also return descriptions. As a workaround, we reads the config files and extract the configuration descriptions separately.

This PR:

  1. Reads config files and extracts the configuration descriptions
  2. Returns a JSON with the descriptions
  3. Updates the javascript template to set the description field
  4. Adds monospace font for keys and values to improve readability

Note: You may need to disable the cache from developer tools to see the effect of these changes locally.

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-499

How was this patch tested?

CI: https://github.com/ptlrs/ozone/actions/runs/18490389759

Screenshot 2025-10-14 at 1 37 13 AM Screenshot 2025-10-14 at 1 37 37 AM

@ptlrs ptlrs marked this pull request as ready for review October 17, 2025 17:32
@ptlrs
Copy link
Contributor Author

ptlrs commented Oct 28, 2025

Hi @devabhishekpal, can you please review this PR?

Copy link
Contributor

@devabhishekpal devabhishekpal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the change @ptlrs
This LGTM, +1

@ptlrs
Copy link
Contributor Author

ptlrs commented Nov 6, 2025

Thanks for the review @devabhishekpal.

@errose28 @adoroszlai can you please take a look and help to merge this?

Copy link
Contributor

@adoroszlai adoroszlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ptlrs for the patch.

ptlrs added 2 commits November 8, 2025 10:34
…y description display on the configuration page
…ation-page-does-not-show-description

# Conflicts:
#	hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/conf/HddsConfServlet.java
@ptlrs
Copy link
Contributor Author

ptlrs commented Nov 8, 2025

Thanks for the review @adoroszlai. I have updated the code with the changes.

@ptlrs ptlrs requested a review from adoroszlai November 8, 2025 18:52
@adoroszlai adoroszlai requested a review from errose28 November 9, 2025 17:04
@adoroszlai adoroszlai merged commit 39e4673 into apache:master Nov 19, 2025
83 of 84 checks passed
@adoroszlai
Copy link
Contributor

thanks @ptlrs for the patch, @devabhishekpal for the review.

@ptlrs ptlrs deleted the HDDS-499-Configuration-page-does-not-show-description branch November 24, 2025 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants