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 snapshot-restore.md #8734

Merged
merged 6 commits into from
Nov 13, 2024
Merged

Update snapshot-restore.md #8734

merged 6 commits into from
Nov 13, 2024

Conversation

pjuri
Copy link
Contributor

@pjuri pjuri commented Nov 12, 2024

Description

Documentation update. Helps user to avoid "Connect timed out" error when registering a custom S3 endpoint for snapshots.

Issues Resolved

Closes #16305
opensearch-project/OpenSearch#16305

Version

All

Frontend features

n/a

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.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @pjuri! A couple of suggestions.

pjuri and others added 2 commits November 12, 2024 15:37
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@pjuri @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

@@ -110,6 +110,20 @@ You will most likely not need to specify any parameters except for `location`. F
sudo ./bin/opensearch-keystore add s3.client.default.secret_key
```

1. (Optional) If you're using a custom S3 endpoint (for example, MinIO), disable AWS EC2 metadata connection:

Copy link
Collaborator

Choose a reason for hiding this comment

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

Line 113: The service is named "Amazon EC2" (never "AWS EC2"). Additionally, if these are the first appearances of these service names, they should be "Amazon Simple Storage Service (Amazon S3) endpoint" and "Amazon Elastic Compute Cloud (Amazon EC2) metadata connection". If these are not the first appearances, "S3 endpoint" and "EC2 metadata connection" are fine.

@kolchfa-aws kolchfa-aws added the backport 2.18 PR: Backport label for 2.18 label Nov 13, 2024
@kolchfa-aws kolchfa-aws merged commit 87a36f7 into opensearch-project:main Nov 13, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 13, 2024
* Update snapshot-restore.md

Adds info from: opensearch-project/OpenSearch#16305

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

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: pjuri <[email protected]>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: pjuri <[email protected]>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: pjuri <[email protected]>

---------

Signed-off-by: pjuri <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 87a36f7)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request Nov 13, 2024
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
* Update snapshot-restore.md

Adds info from: opensearch-project/OpenSearch#16305

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

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: pjuri <[email protected]>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: pjuri <[email protected]>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: pjuri <[email protected]>

---------

Signed-off-by: pjuri <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.18 PR: Backport label for 2.18
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants