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

Enable must_exist parameter for update aliases API #11210

Merged
merged 14 commits into from
Jan 9, 2024

Conversation

gaobinlong
Copy link
Collaborator

@gaobinlong gaobinlong commented Nov 15, 2023

Description

The parameter must_exist in update index aliases API exists in the code base but actually it doesn't work, IndicesAliasesRequest doesn't parse the parameter. This PR enables must_exist parameter and makes it work when removing aliases by update aliases API.

Another finding is that delete alias API also use the same TransportAction with update aliases API, which is TransportIndicesAliasesAction, the current behavior is that if all of the specified aliases are non-existing, it will throw 404 with aliases_not_found_exception, but if only some of the specified aliases are non-existing, it removes successfully, the non-existing aliases are ignored. So in order to make update aliases API consistent with the existing behavior and do not import breaking change, when all of the specified aliases are non-existing, no matter must_exist is true or false, we also throw 404 with aliases_not_found_exception, just like this:

  1. Delete an non-existing alias:
    Request:
POST _aliases
{
   "actions": [
    {
      "remove": {
        "index": "test",
        "aliases": ["testAlias"]
      }
    }
  ]
}

Response:

{
  "error": {
    "root_cause": [
      {
        "type": "aliases_not_found_exception",
        "reason": "aliases [testAlias] missing",
        "resource.id": "testAlias",
        "resource.type": "aliases"
      }
    ],
    "type": "aliases_not_found_exception",
    "reason": "aliases [testAlias] missing",
    "resource.id": "testAlias",
    "resource.type": "aliases"
  },
  "status": 404
}
  1. Add an alias:
POST test/_alias/testAlias
  1. Delete the existing alias with an non-existing alias, it executes successfully
POST _aliases
{
   "actions": [
    {
      "remove": {
        "index": "test",
        "aliases": ["testAlias", "testAlias1"]
      }
    }
  ]
}
  1. If must_exist is true, deleting an non-existing alias will throw aliases_not_found_exception
POST test/_alias/testAlias

POST _aliases
{
   "actions": [
    {
      "remove": {
        "index": "test",
        "aliases": ["testAlias", "testAlias1"],
        "must_exist":true
      }
    }
  ]
}

Related Issues

#2949

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)
  • Public documentation issue/PR created

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.

Copy link
Contributor

github-actions bot commented Nov 15, 2023

Compatibility status:

Checks if related components are compatible with change a93447f

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/performance-analyzer.git]

Copy link
Contributor

❌ Gradle check result for 51d0b36: null

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?

Copy link
Contributor

github-actions bot commented Jan 8, 2024

❌ Gradle check result for 97f3ff0: FAILURE

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?

Copy link
Contributor

github-actions bot commented Jan 8, 2024

❕ Gradle check result for 069675f: UNSTABLE

  • TEST FAILURES:
      1 org.opensearch.remotestore.RemoteIndexPrimaryRelocationIT.testPrimaryRelocationWhileIndexing

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

Copy link
Contributor

github-actions bot commented Jan 9, 2024

❕ Gradle check result for a93447f: UNSTABLE

  • TEST FAILURES:
      1 org.opensearch.remotestore.RemoteIndexPrimaryRelocationIT.testPrimaryRelocationWhileIndexing

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

@gaobinlong
Copy link
Collaborator Author

❕ Gradle check result for a93447f: UNSTABLE

  • TEST FAILURES:
      1 org.opensearch.remotestore.RemoteIndexPrimaryRelocationIT.testPrimaryRelocationWhileIndexing

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

testPrimaryRelocationWhileIndexing is a flaky test, there's an issue tracking it: #9191.

@reta reta merged commit a1e4602 into opensearch-project:main Jan 9, 2024
30 checks passed
@reta reta added backport 2.x Backport to 2.x branch bug Something isn't working v3.0.0 Issues and PRs related to version 3.0.0 v2.12.0 Issues and PRs related to version 2.12.0 labels Jan 9, 2024
@opensearch-trigger-bot
Copy link
Contributor

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:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-11210-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a1e4602b8dcd5676d1e7b410d86242d7a555d619
# Push it to GitHub
git push --set-upstream origin backport/backport-11210-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

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

@reta
Copy link
Collaborator

reta commented Jan 9, 2024

@gaobinlong could you please backport manually to 2.x? we also need documentation issue here https://github.com/opensearch-project/documentation-website/issues to update Index Aliases (see please https://opensearch.org/docs/latest/im-plugin/index-alias/#add-or-remove-indexes), thank you

gaobinlong added a commit to gaobinlong/OpenSearch that referenced this pull request Jan 10, 2024
…t#11210)

* Enable must_exist parameter for update aliases API

Signed-off-by: Gao Binlong <[email protected]>

* modify changelog

Signed-off-by: Gao Binlong <[email protected]>

* Fix test failure

Signed-off-by: Gao Binlong <[email protected]>

* Fix test failure

Signed-off-by: Gao Binlong <[email protected]>

* Remove silently when all aliases are non-existing and must_exist is false

Signed-off-by: Gao Binlong <[email protected]>

* Modify some comments to run gradle check again

Signed-off-by: Gao Binlong <[email protected]>

* Add more yaml test

Signed-off-by: Gao Binlong <[email protected]>

---------

Signed-off-by: Gao Binlong <[email protected]>
(cherry picked from commit a1e4602)
@gaobinlong
Copy link
Collaborator Author

@gaobinlong could you please backport manually to 2.x? we also need documentation issue here https://github.com/opensearch-project/documentation-website/issues to update Index Aliases (see please https://opensearch.org/docs/latest/im-plugin/index-alias/#add-or-remove-indexes), thank you

I've created a document issue yet, and the backport PR needs to be reviewed, thanks!

reta pushed a commit that referenced this pull request Jan 10, 2024
…1210) (#11833)

* Enable must_exist parameter for update aliases API (#11210)

* Enable must_exist parameter for update aliases API

Signed-off-by: Gao Binlong <[email protected]>

* modify changelog

Signed-off-by: Gao Binlong <[email protected]>

* Fix test failure

Signed-off-by: Gao Binlong <[email protected]>

* Fix test failure

Signed-off-by: Gao Binlong <[email protected]>

* Remove silently when all aliases are non-existing and must_exist is false

Signed-off-by: Gao Binlong <[email protected]>

* Modify some comments to run gradle check again

Signed-off-by: Gao Binlong <[email protected]>

* Add more yaml test

Signed-off-by: Gao Binlong <[email protected]>

---------

Signed-off-by: Gao Binlong <[email protected]>
(cherry picked from commit a1e4602)

* Update supported version to 2.12.0

Signed-off-by: Gao Binlong <[email protected]>

* Small change to rerun gradle check

Signed-off-by: Gao Binlong <[email protected]>

---------

Signed-off-by: Gao Binlong <[email protected]>
rayshrey pushed a commit to rayshrey/OpenSearch that referenced this pull request Mar 18, 2024
…t#11210)

* Enable must_exist parameter for update aliases API

Signed-off-by: Gao Binlong <[email protected]>

* modify changelog

Signed-off-by: Gao Binlong <[email protected]>

* Fix test failure

Signed-off-by: Gao Binlong <[email protected]>

* Fix test failure

Signed-off-by: Gao Binlong <[email protected]>

* Remove silently when all aliases are non-existing and must_exist is false

Signed-off-by: Gao Binlong <[email protected]>

* Modify some comments to run gradle check again

Signed-off-by: Gao Binlong <[email protected]>

* Add more yaml test

Signed-off-by: Gao Binlong <[email protected]>

---------

Signed-off-by: Gao Binlong <[email protected]>
shiv0408 pushed a commit to Gaurav614/OpenSearch that referenced this pull request Apr 25, 2024
…t#11210)

* Enable must_exist parameter for update aliases API

Signed-off-by: Gao Binlong <[email protected]>

* modify changelog

Signed-off-by: Gao Binlong <[email protected]>

* Fix test failure

Signed-off-by: Gao Binlong <[email protected]>

* Fix test failure

Signed-off-by: Gao Binlong <[email protected]>

* Remove silently when all aliases are non-existing and must_exist is false

Signed-off-by: Gao Binlong <[email protected]>

* Modify some comments to run gradle check again

Signed-off-by: Gao Binlong <[email protected]>

* Add more yaml test

Signed-off-by: Gao Binlong <[email protected]>

---------

Signed-off-by: Gao Binlong <[email protected]>
Signed-off-by: Shivansh Arora <[email protected]>
@reta reta mentioned this pull request Jul 17, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch backport-failed bug Something isn't working v2.12.0 Issues and PRs related to version 2.12.0 v3.0.0 Issues and PRs related to version 3.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants