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.

Sign up for GitHub

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

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0e2f2bd
Update snapshot-restore.md
pjuri Nov 12, 2024
9e04018
Merge pull request #1 from pjuri/pjuri-patch-1
pjuri Nov 12, 2024
b8edeeb
Update _tuning-your-cluster/availability-and-recovery/snapshots/snaps…
pjuri Nov 12, 2024
e5d4d2f
Update _tuning-your-cluster/availability-and-recovery/snapshots/snaps…
pjuri Nov 12, 2024
9b09d78
Update _tuning-your-cluster/availability-and-recovery/snapshots/snaps…
pjuri Nov 13, 2024
d9d0423
Merge branch 'main' into main
kolchfa-aws Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,20 @@
sudo ./bin/opensearch-keystore add s3.client.default.secret_key
```

1. (Optional) If you're using a custom S3 endpoint (for example, MinIO), disable the Amazon 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.

```bash
export AWS_EC2_METADATA_DISABLED=true

Check warning on line 116 in _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.AcronymParentheses] 'EC2': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.

Raw Output:
{"message": "[OpenSearch.AcronymParentheses] 'EC2': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.", "location": {"path": "_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md", "range": {"start": {"line": 116, "column": 15}}}, "severity": "WARNING"}
```

If you're installing OpenSearch using Helm, update the following settings in your values file:

```yml
extraEnvs:
- name: AWS_EC2_METADATA_DISABLED

Check warning on line 123 in _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.AcronymParentheses] 'EC2': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.

Raw Output:
{"message": "[OpenSearch.AcronymParentheses] 'EC2': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.", "location": {"path": "_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md", "range": {"start": {"line": 123, "column": 18}}}, "severity": "WARNING"}
value: "true"
```

1. (Optional) If you're using temporary credentials, add your session token:

```bash
Expand Down
Loading