[CCI] Create index lifecycle guide #362

Nicksqain · 2023-04-08T18:57:41Z

Description

Create index lifecycle guide

Issues Resolved

closes [Guide] Index Lifecycle #349

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.

Signed-off-by: Alexei Karikov <[email protected]>

VachaShah · 2023-04-18T02:47:42Z

Thank you for contributing @Nicksqain! Can you add a Changelog entry for this? Also, I see you have 3 PRs for adding guides, you can also combine them into one with a single Changelog entry if that works.

Nicksqain · 2023-04-18T03:30:36Z

@VachaShah Hello! thanks for the feedback! I will definitely add an entry. If I add to one, will the others have a "skip changelog"?

codecov-commenter · 2023-04-18T17:05:06Z

Codecov Report

Merging #362 (a712305) into main (5fa4e8c) will not change coverage.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main     #362   +/-   ##
=======================================
  Coverage   72.01%   72.01%           
=======================================
  Files          77       77           
  Lines        7190     7190           
=======================================
  Hits         5178     5178           
  Misses       2012     2012

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

VachaShah · 2023-04-18T19:01:25Z

@VachaShah Hello! thanks for the feedback! I will definitely add an entry. If I add to one, will the others have a "skip changelog"?

If you keep the 3 separate PRs, then you can add Changelog entry in each PR. Or you can combine all 3 PRs into 1 and add a Changelog entry.

For Changelog, you can add an entry in the Added section for Unreleased.

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain · 2023-04-19T18:40:31Z

Thank you for contributing @Nicksqain! Can you add a Changelog entry for this? Also, I see you have 3 PRs for adding guides, you can also combine them into one with a single Changelog entry if that works.

Can we wait for the index lifecycle to merge first and then re-run the link checker?
I suggest simply doing a merge in the order of the tasks in #355 and adding the changelog entry one by one. What do you think?

VachaShah

Thank you @Nicksqain! I tried the code in the guide and had a few comments.

VachaShah · 2023-04-19T23:31:47Z

guides/index_lifecycle.md

+
+```python
+print(client.indices.exists(index='burner'))  # => False
+client.create(index='burner', body={'lorem': 'ipsum'})


This would be client.index with id parameter:

client.index(id='1', index='burner', body={'lorem': 'ipsum'})

VachaShah · 2023-04-19T23:46:48Z

guides/index_lifecycle.md

+We can also delete multiple indices at once:
+
+```python
+client.indices.delete(index=['movies', 'paintings', 'burner'], ignore=[404])


ignore is not an option for python. So this would be:

print(client.indices.delete(index=['paintings', 'burner']))

since movies is deleted in the previous line.

But other guides for clients have the presence of ignoring. This is part of the guide.
Did I make a mistake or is it just that there is no option to ignore the 404 error?

Looking at the code, the parameter available for ignoring non-existing indices is ignore_unavailable. I tried it and the following works:

print(client.indices.delete(index=['art', 'paintings', 'burner'], ignore_unavailable=True))

where art index does not exist. The response is:

{'acknowledged': True}

Lets change it to ignore_unavailable.

Yes, thanks for the correction! I had my doubts, as the rust client also had this option.

VachaShah · 2023-04-19T23:52:29Z

guides/index_lifecycle.md

+client.indices.delete(index=['movies', 'paintings', 'burner'], ignore=[404])
+```
+
+Notice that we are passing `ignore: 404` to the request. This tells the client to ignore the `404` error if the index doesn't exist for deletion. Without it, the above `delete` request will throw an error because the `movies` index has already been deleted in the previous example.


This section is not applicable since ignore is not an option for this client.

But in the repository I found an application for ignoring the lack of an index.
(It takes an array of)
Still need to delete the section?

ignore_unavailable seems to be the correct option. See

opensearch-py/opensearchpy/client/indices.py

Line 295 in 03b72c3

:arg ignore_unavailable: Ignore unavailable indexes (default:

VachaShah · 2023-04-19T23:54:12Z

Thank you for contributing @Nicksqain! Can you add a Changelog entry for this? Also, I see you have 3 PRs for adding guides, you can also combine them into one with a single Changelog entry if that works.

Can we wait for the index lifecycle to merge first and then re-run the link checker? I suggest simply doing a merge in the order of the tasks in #355 and adding the changelog entry one by one. What do you think?

Sure, we can merge this PR first and you can fix the changelogs one by one for your PRs after that. I just added a few comments for this PR.

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain · 2023-04-20T19:00:14Z

@VachaShah I've added changes! Happy to help!
Looking forward to the following preferences :)

VachaShah

This looks good! Can you pull the latest changes from main and resolve the conflicts in the Changelog? We should be good to merge then!

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain · 2023-04-21T19:02:57Z

@VachaShah
Updated the branch!
I accidentally saved the breaks of my linter. Apologies for not rolling back and doing a force push

guides/index_lifecycle.md

Signed-off-by: Alexei Karikov <[email protected]>

* Create index lifecycle guide Signed-off-by: Alexei Karikov <[email protected]> * Add changelog entry Signed-off-by: Alexei Karikov <[email protected]> * Replace ignore param and add short corrections Signed-off-by: Alexei Karikov <[email protected]> * reset spaces Signed-off-by: Alexei Karikov <[email protected]> * Correct indents Signed-off-by: Alexei Karikov <[email protected]> --------- Signed-off-by: Alexei Karikov <[email protected]> Signed-off-by: Raman Saparkhan <[email protected]>

Create index lifecycle guide

2cf0732

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested review from VachaShah, dblock, harshavamsi, axeoman, deztructor and Shephalimittal as code owners April 8, 2023 18:57

Nicksqain mentioned this pull request Apr 8, 2023

[Guide] Index Lifecycle #349

Closed

harshavamsi added the CCI label Apr 18, 2023

Add changelog entry

7c4d0e2

Signed-off-by: Alexei Karikov <[email protected]>

VachaShah reviewed Apr 19, 2023

View reviewed changes

Replace ignore param and add short corrections

6629028

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested a review from VachaShah April 20, 2023 18:58

VachaShah reviewed Apr 21, 2023

View reviewed changes

Nicksqain added 2 commits April 22, 2023 00:58

Merge brain main into current and resolve the conflicts

2fc84cb

Signed-off-by: Alexei Karikov <[email protected]>

reset spaces

a712305

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested a review from VachaShah April 21, 2023 19:01

VachaShah reviewed Apr 21, 2023

View reviewed changes

guides/index_lifecycle.md Outdated Show resolved Hide resolved

Correct indents

b852a88

Signed-off-by: Alexei Karikov <[email protected]>

Nicksqain requested a review from VachaShah April 24, 2023 17:26

VachaShah approved these changes Apr 24, 2023

View reviewed changes

VachaShah merged commit 12b2748 into opensearch-project:main Apr 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CCI] Create index lifecycle guide #362

[CCI] Create index lifecycle guide #362

Nicksqain commented Apr 8, 2023 •

edited

Loading

VachaShah commented Apr 18, 2023

Nicksqain commented Apr 18, 2023

codecov-commenter commented Apr 18, 2023 •

edited

Loading

VachaShah commented Apr 18, 2023

Nicksqain commented Apr 19, 2023

VachaShah left a comment

VachaShah Apr 19, 2023

VachaShah Apr 19, 2023

Nicksqain Apr 20, 2023

VachaShah Apr 20, 2023

Nicksqain Apr 20, 2023

VachaShah Apr 19, 2023

Nicksqain Apr 20, 2023

VachaShah Apr 20, 2023

VachaShah commented Apr 19, 2023

Nicksqain commented Apr 20, 2023

VachaShah left a comment

Nicksqain commented Apr 21, 2023

[CCI] Create index lifecycle guide #362

[CCI] Create index lifecycle guide #362

Conversation

Nicksqain commented Apr 8, 2023 • edited Loading

Description

Issues Resolved

VachaShah commented Apr 18, 2023

Nicksqain commented Apr 18, 2023

codecov-commenter commented Apr 18, 2023 • edited Loading

Codecov Report

VachaShah commented Apr 18, 2023

Nicksqain commented Apr 19, 2023

VachaShah left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

VachaShah commented Apr 19, 2023

Nicksqain commented Apr 20, 2023

VachaShah left a comment

Choose a reason for hiding this comment

Nicksqain commented Apr 21, 2023

Nicksqain commented Apr 8, 2023 •

edited

Loading

codecov-commenter commented Apr 18, 2023 •

edited

Loading