Skip to content

HDDS-11436. Minor update in Recon API handling. #7178

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
devmadhuu merged 3 commits into from
Sep 10, 2024
Merged

HDDS-11436. Minor update in Recon API handling. #7178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dfa5eda
HDDS-11436. Minor update in Recon API handling.
ArafatKhan2198 Sep 9, 2024
0e31370
Fixed checkstyle
ArafatKhan2198 Sep 9, 2024
8b0ff62
Fixed comment
ArafatKhan2198 Sep 10, 2024
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
1 change: 1 addition & 0 deletions ...op-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/TriggerDBSyncEndpoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
*/
@Path("/triggerdbsync")
@Produces(MediaType.APPLICATION_JSON)
@AdminOnly
public class TriggerDBSyncEndpoint {

private OzoneManagerServiceProvider ozoneManagerServiceProvider;
Expand Down
12 changes: 8 additions & 4 deletions ...-ozone/recon/src/test/java/org/apache/hadoop/ozone/recon/api/filters/TestAdminFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
import org.apache.hadoop.ozone.recon.api.NodeEndpoint;
import org.apache.hadoop.ozone.recon.api.PipelineEndpoint;
import org.apache.hadoop.ozone.recon.api.TaskStatusService;
import org.apache.hadoop.ozone.recon.api.TriggerDBSyncEndpoint;
import org.apache.hadoop.ozone.recon.api.UtilizationEndpoint;
import org.apache.hadoop.security.UserGroupInformation;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -70,16 +69,21 @@ public void testAdminOnlyEndpoints() {

assertThat(allEndpoints).isNotEmpty();

// If an endpoint is added, it must be explicitly added to this set or be
// marked with @AdminOnly for this test to pass.
// If an endpoint is added, it must either require admin privileges by being
// marked with the `@AdminOnly` annotation, or be added to this set to exclude it.
// - Any endpoint that displays information related to the filesystem namespace
// (including aggregate counts), user information, or allows modification to the
// cluster's state should be marked as `@AdminOnly`.
// - Read-only endpoints that only return information about node status or
// cluster state do not require the `@AdminOnly` annotation and can be excluded
// from admin requirements by adding them to this set.
Set<Class<?>> nonAdminEndpoints = new HashSet<>();
nonAdminEndpoints.add(UtilizationEndpoint.class);
nonAdminEndpoints.add(ClusterStateEndpoint.class);
nonAdminEndpoints.add(MetricsProxyEndpoint.class);
nonAdminEndpoints.add(NodeEndpoint.class);
nonAdminEndpoints.add(PipelineEndpoint.class);
nonAdminEndpoints.add(TaskStatusService.class);
nonAdminEndpoints.add(TriggerDBSyncEndpoint.class);

assertThat(allEndpoints).containsAll(nonAdminEndpoints);

Expand Down