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

Update searchable snapshot documentation to be more correct #4203

Merged
merged 2 commits into from
Jun 14, 2023

Conversation

adaisley
Copy link
Contributor

@adaisley adaisley commented May 30, 2023

This is more in-line with what is defined in the example Opensearch docker-compose.
I tried the current approach and it straight-up did not work in its current form.

Description

Give correct instructions in the Searchable Snapshots documentation page.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].
None

Checklist

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

This is more in-line with what is defined in the example Opensearch docker-compose
I tried the current approach and it straight-up did not work in it's current form.

Signed-off-by: adaisley <[email protected]>
@adaisley
Copy link
Contributor Author

adaisley commented May 30, 2023

I will say that the documentation surrounding the Searchable Snapshots feature and notably the Search node role is extremely limited right now. You cannot just 'add' that search node declaration to existing nodes as it seems to require the data/ folder for that node needs to not contain any data (and running the cleanup tool in Docker didn't seem to do anything only complain that the cluster isn't running, when I tried to run it when the cluster was up it said it needed to not be running...)

Tried the original method that the page describes i.e. add - node.roles: [ search ] to the docker-compose file but it complained about using : instead of = to add this. Then as an array I was getting weird behaviour so took that out and can observe a correctly-functioning test environment Search node that successfully pulls data from a remote snapshot repository.

@Naarcha-AWS Naarcha-AWS added backport 1.3 PR: Backport label for v1.3.x backport 2.8 PR: Backport label for 2.8 labels Jun 14, 2023
@Naarcha-AWS Naarcha-AWS merged commit 6bf867a into opensearch-project:main Jun 14, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 1.3 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-1.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-4203-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6bf867a200cfe71f1203c7350fd64f2b56d20085
# Push it to GitHub
git push --set-upstream origin backport/backport-4203-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-4203-to-1.3.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.8 failed:

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

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.8 2.8
# Navigate to the new working tree
pushd ../.worktrees/backport-2.8
# Create a new branch
git switch --create backport/backport-4203-to-2.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6bf867a200cfe71f1203c7350fd64f2b56d20085
# Push it to GitHub
git push --set-upstream origin backport/backport-4203-to-2.8
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.8

Then, create a pull request where the base branch is 2.8 and the compare/head branch is backport/backport-4203-to-2.8.

@adaisley adaisley deleted the patch-1 branch June 22, 2023 08:22
vagimeli pushed a commit that referenced this pull request Jun 22, 2023
* Update searchable_snapshot.md

This is more in-line with what is defined in the example Opensearch docker-compose
I tried the current approach and it straight-up did not work in it's current form.

Signed-off-by: adaisley <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: adaisley <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
vagimeli added a commit that referenced this pull request Jun 23, 2023
vagimeli pushed a commit that referenced this pull request Aug 24, 2023
* Update searchable_snapshot.md

This is more in-line with what is defined in the example Opensearch docker-compose
I tried the current approach and it straight-up did not work in it's current form.

Signed-off-by: adaisley <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: adaisley <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli added a commit that referenced this pull request Aug 24, 2023
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
…ch-project#4203)

* Update searchable_snapshot.md

This is more in-line with what is defined in the example Opensearch docker-compose
I tried the current approach and it straight-up did not work in it's current form.

Signed-off-by: adaisley <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: adaisley <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
* Update searchable_snapshot.md

This is more in-line with what is defined in the example Opensearch docker-compose
I tried the current approach and it straight-up did not work in it's current form.

Signed-off-by: adaisley <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: adaisley <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.3 PR: Backport label for v1.3.x backport 2.8 PR: Backport label for 2.8
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants