Skip to content

Commit a22d8b4

Browse files
committed
[DOCS] Add an example of creating S3 repository
1 parent e3d2216 commit a22d8b4

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,17 @@ The `gateway.s3.concurrent_streams` allow to throttle the number of streams (per
102102

103103
## S3 Repository
104104

105-
The S3 repository is using S3 to store snapshot. The following settings are supported:
105+
The S3 repository is using S3 to store snapshots. The S3 repository can be created using the following command:
106+
107+
$ curl -XPUT 'http://localhost:9200/_snapshot/my_s3_repository' -d '{
108+
"type": "s3",
109+
"settings": {
110+
"bucket": "my_backet_name",
111+
"region": "us-west"
112+
}
113+
}'
114+
115+
The following settings are supported:
106116

107117
* `bucket`: The name of the bucket to be used for snapshots. (Mandatory)
108118
* `region`: The region where bucket is located. Defaults to US Standard
@@ -111,6 +121,16 @@ The S3 repository is using S3 to store snapshot. The following settings are supp
111121
* `chunk_size`: Big files can be broken down into chunks during snapshotting if needed. The chunk size can be specified in bytes or by using size value notation, i.e. `1g`, `10m`, `5k`. Defaults to `100m`.
112122
* `compress`: When set to `true` metadata files are stored in compressed format. This setting doesn't affect index files that are already compressed by default. Defaults to `false`.
113123

124+
The S3 repositories are using the same credentials as the rest of the S3 services provided by this plugin (`discovery` and `gateway`). They can be configured the following way:
125+
126+
cloud:
127+
aws:
128+
access_key: AKVAIQBF2RECL7FJWGJQ
129+
secret_key: vExyMThREXeRMm/b/LRzEB8jWwvzQeXgjqMX+6br
130+
131+
132+
Multiple S3 repositories can be created as long as they share the same credential.
133+
114134
## Testing
115135

116136
Integrations tests in this plugin require working AWS configuration and therefore disabled by default. To enable tests prepare a config file elasticsearch.yml with the following content:

0 commit comments

Comments
 (0)