Add restore level safeguards to prevent file cache oversubscription

[kotwanikunal]

Description

• Follow up on Add safeguard limits for file cache during node level allocation #8208
• Adds changes to prevent oversubscription at the searchable snapshot restore operation, building on top of the allocation level logic
• Makes the value for subscription ratio configurable instead of the fixed value

Related Issues

Resolves #7033

• Add safeguards to prevent file cache over-subscription #7713 (comment)
• Add safeguard limits for file cache during node level allocation #8208

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff
• Commit changes are listed out in CHANGELOG.md file (See: Changelog)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[kotwanikunal]

Follow up PR: @andrross / @reta / @Bukhtawar

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: UNSTABLE ❕
• TEST FAILURES:

      1 org.opensearch.remotestore.SegmentReplicationRemoteStoreIT.testPrimaryStopped_ReplicaPromoted

• URL: https://build.ci.opensearch.org/job/gradle-check/19771/
• CommitID: 3d0464c
  Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

[andrross]

A new user-facing setting is worth a changelog entry I think.

[codecov]

Codecov Report

Merging #8606 (b936e9d) into main (883559c) will increase coverage by 0.05%.
The diff coverage is 84.78%.

@@             Coverage Diff              @@
##               main    #8606      +/-   ##
============================================
+ Coverage     71.01%   71.06%   +0.05%     
- Complexity    57178    57215      +37     
============================================
  Files          4763     4763              
  Lines        269964   270003      +39     
  Branches      39502    39508       +6     
============================================
+ Hits         191707   191875     +168     
+ Misses        62041    61971      -70     
+ Partials      16216    16157      -59     

Files Changed	Coverage Δ
...ster/snapshots/restore/RestoreSnapshotRequest.java	67.74% <ø> (-1.62%)	⬇️
...rg/opensearch/common/settings/ClusterSettings.java	93.18% <ø> (ø)
.../java/org/opensearch/snapshots/RestoreService.java	57.18% <82.50%> (+3.93%)	⬆️
...a/org/opensearch/cluster/routing/RoutingTable.java	94.82% <100.00%> (+0.44%)	⬆️
...uting/allocation/decider/DiskThresholdDecider.java	74.66% <100.00%> (-0.60%)	⬇️
...search/index/store/remote/filecache/FileCache.java	72.46% <100.00%> (+0.40%)	⬆️
server/src/main/java/org/opensearch/node/Node.java	86.04% <100.00%> (ø)

... and 465 files with indirect coverage changes

[kotwanikunal]

A new user-facing setting is worth a changelog entry I think.

Added in an entry.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21027/
• CommitID: 8e2e49e
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21029/
• CommitID: e917d1d
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21062/
• CommitID: e917d1d
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[kotwanikunal]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21062/
• CommitID: e917d1d
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

#8928

[kotwanikunal]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21029/
• CommitID: e917d1d
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

#8928

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21101/
• CommitID: e917d1d
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: null ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21108/
• CommitID: e917d1d
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[kotwanikunal]

• https://build.ci.opensearch.org/job/gradle-check/21108/

#8928

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21135/
• CommitID: e917d1d
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/21164/
• CommitID: 0be12e6
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: UNSTABLE ❕
• TEST FAILURES:

      1 org.opensearch.client.PitIT.testDeleteAllAndListAllPits

• URL: https://build.ci.opensearch.org/job/gradle-check/21180/
• CommitID: 0be12e6
  Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/21332/
• CommitID: b936e9d

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-8606-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a3aab67ee86bf171a7eb480f0933e0b955fbf4f3
# Push it to GitHub
git push --set-upstream origin backport/backport-8606-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-8606-to-2.x.

[Dileep-Dora]

Hi @kotwanikunal and @andrross from the implementation this is what I understood,

node.search.cache.size - setting to reserve Filecache on search node
cluster.filecache.remote_data_ratio - setting for ratio to allocate remote shards

for example if cluster.filecache.remote_data_ratio set to 5 and node.search.cache.size set to 100GB, can store 500GB of data per node.

If I set the cluster.filecache.remote_data_ratio to 10 , can store 1TB of data per node.

is may understanding correct?

and also when can we see expect the release in 2.8 version?

[andrross]

@Dileep-Dora Your understanding is correct. This feature will be released in the 2.10 version.