Skip to content
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.

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

Implement the cross-zone-based stoppable check #2680

Merged

Conversation

MarkGaox
Copy link
Contributor

@MarkGaox MarkGaox commented Oct 24, 2023

Issues

Description

  • Here are some details about my PR, including screenshots of any UI changes:
  • Implement the cross-zone-based stoppable check.
  • Add to_be_stopped_instances parameter in the API payload.
  • Modify the checks that will be affected by the to_be_stopped_instances. There are two checks that will be affected:
    • siblingNodesActiveReplicaCheck
    • perPartitionHealthCheck

Tests

  • The following tests are written for this issue:
    mvn test -Dtest=TestInstancesAccessor,TestMaintenanceManagementService,TestInstanceValidationUtilInRest,TestPerInstanceAccessor -pl helix-rest && mvn test -Dtest=TestInstanceValidationUtil -pl helix-core
[INFO] Tests run: 45, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] 
[INFO] --- jacoco:0.8.6:report (generate-code-coverage-report) @ helix-rest ---
[INFO] Loading execution data file /Users/xiaxgao/IdeaProjects/helix_ps/helix-rest/target/jacoco.exec
[INFO] Analyzed bundle 'Apache Helix :: Restful Interface' with 94 classes
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:13 min
[INFO] Finished at: 2023-10-27T00:53:55-07:00
[INFO] ------------------------------------------------------------------------

[INFO] Tests run: 24, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] 
[INFO] --- jacoco:0.8.6:report (generate-code-coverage-report) @ helix-core ---
[INFO] Loading execution data file /Users/xiaxgao/IdeaProjects/helix_ps/helix-core/target/jacoco.exec
[INFO] Analyzed bundle 'Apache Helix :: Core' with 947 classes
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  9.000 s
[INFO] Finished at: 2023-10-24T14:11:11-07:00
[INFO] ------------------------------------------------------------------------

(List the names of added unit/integration tests)

  • The following is the result of the "mvn test" command on the appropriate module:

(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)

Changes that Break Backward Compatibility (Optional)

  • My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:

(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)

Documentation (Optional)

  • In case of new functionality, my PR adds documentation in the following wiki page:

(Link the GitHub wiki you added)

Commits

  • My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Code Quality

  • My diff has been formatted using helix-style.xml
    (helix-style-intellij.xml if IntelliJ IDE is used)

@MarkGaox MarkGaox mentioned this pull request Oct 25, 2023
4 tasks
Copy link
Contributor

@zpinto zpinto left a comment

Choose a reason for hiding this comment

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

Left some comments on backwards incompatible changes, design of selector, and another thing to consider for custom partition health check.

You can change public method signatures in the selector since it isn't merged to master yet, but we should be careful about doing that in MaintenanceManagementService

@@ -745,7 +745,7 @@ protected Map<String, Boolean> getInstanceHealthStatus(String clusterId, String
break;
case MIN_ACTIVE_REPLICA_CHECK_FAILED:
healthStatus.put(HealthCheck.MIN_ACTIVE_REPLICA_CHECK_FAILED.name(),
InstanceValidationUtil.siblingNodesActiveReplicaCheck(_dataAccessor, instanceName));
InstanceValidationUtil.siblingNodesActiveReplicaCheck(_dataAccessor, instanceName, toBeStoppedInstances));
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not necessarily a part of the change, but I think we should re-evaluate whether the EMPTY_RESOURCE_ASSIGNMENT should keep an instance from being stoppable. There could be legitimate reason there is no resource assignment. Why should that block a deployment or other operation?

@@ -114,7 +114,7 @@ public MockMaintenanceManagementService(ZKHelixDataAccessor dataAccessor,

@Override
protected Map<String, Boolean> getInstanceHealthStatus(String clusterId, String instanceName,
List<HealthCheck> healthChecks) {
List<HealthCheck> healthChecks, Set<String> toBeStoppedInstances) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The reason why we still need to change this override is the getInstanceStoppableCheck will eventually call protected Map<String, Boolean> getInstanceHealthStatus(String clusterId, String instanceName, List<HealthCheck> healthChecks, Set<String> toBeStoppedInstances)

Copy link
Contributor

@zpinto zpinto left a comment

Choose a reason for hiding this comment

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

Overall, LGTM. One minor comment

@MarkGaox
Copy link
Contributor Author

MarkGaox commented Oct 30, 2023

Thanks @junkaixue @xyuanlu @zpinto for reviewing the PR. It's approved by @xyuanlu @zpinto and is ready to merge.
Final commit message: Implement the cross-zone-based stoppable check and add to_be_stopped_instances query parameter to the stoppable check API

@xyuanlu xyuanlu merged commit 4552f87 into apache:ApplicationClusterManager Oct 31, 2023
2 checks passed
asfgit pushed a commit that referenced this pull request Nov 13, 2023
Implement the cross-zone-based stoppable check and add to_be_stopped_instances query parameter to the stoppable check API
asfgit pushed a commit that referenced this pull request Dec 8, 2023
Implement the cross-zone-based stoppable check and add to_be_stopped_instances query parameter to the stoppable check API
asfgit pushed a commit that referenced this pull request Dec 13, 2023
Implement the cross-zone-based stoppable check and add to_be_stopped_instances query parameter to the stoppable check API
xyuanlu pushed a commit that referenced this pull request Dec 20, 2023
Implement the cross-zone-based stoppable check and add to_be_stopped_instances query parameter to the stoppable check API
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants