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

[DOCS] Fix S3 bucket names in S3 repo plugin docs #66521

Merged
merged 6 commits into from
Dec 17, 2020
Merged

[DOCS] Fix S3 bucket names in S3 repo plugin docs #66521

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a57b4aa
Update repository-s3.asciidoc
InbarShimshon Dec 17, 2020
e79f5dc
Fix up examples and param def
jrodewig Dec 17, 2020
86c5fff
more fixes
jrodewig Dec 17, 2020
d5cf55b
some more fixes
jrodewig Dec 17, 2020
ada56d8
add word
jrodewig Dec 17, 2020
c3c299d
update link
jrodewig Dec 17, 2020
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
22 changes: 13 additions & 9 deletions docs/plugins/repository-s3.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket"
"bucket": "my-bucket"
}
}
----
Expand All @@ -48,8 +48,8 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket",
"client": "my_alternate_client"
"bucket": "my-bucket",
"client": "my-alternate-client"
}
}
----
Expand Down Expand Up @@ -241,8 +241,8 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket_name",
"another_setting": "setting_value"
"bucket": "my-bucket",
"another_setting": "setting-value"
}
}
----
Expand All @@ -251,8 +251,12 @@ PUT _snapshot/my_s3_repository
The following settings are supported:

`bucket`::

The name of the bucket to be used for snapshots. (Mandatory)
(Required)
Name of the S3 bucket to use for snapshots.
+
The bucket name must adhere to Amazon's
https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules[S3
bucket naming rules].

`client`::

Expand Down Expand Up @@ -340,8 +344,8 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"client": "my_client_name",
"bucket": "my_bucket_name",
"client": "my-client",
"bucket": "my-bucket",
"endpoint": "my.s3.endpoint"
}
}
Expand Down