Skip to content

Clarify integer settings for repository-s3 repos #114093

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

Merged
merged 1 commit into from
Oct 4, 2024
Merged

Clarify integer settings for repository-s3 repos #114093

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 7 additions & 14 deletions docs/reference/snapshot-restore/repository-s3.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,9 +296,8 @@ include::repository-shared-settings.asciidoc[]

`max_multipart_parts` ::

(<<number,integer>>) The maximum number of parts that {es} will write during a multipart upload
of a single object. Files which are larger than `buffer_size × max_multipart_parts` will be
chunked into several smaller objects. {es} may also split a file across multiple objects to
(integer) The maximum number of parts that {es} will write during a multipart upload of a single object. Files which are larger than
`buffer_size × max_multipart_parts` will be chunked into several smaller objects. {es} may also split a file across multiple objects to
satisfy other constraints such as the `chunk_size` limit. Defaults to `10000` which is the
https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html[maximum number of parts in a multipart upload in AWS S3].

Expand All @@ -321,20 +320,14 @@ include::repository-shared-settings.asciidoc[]

`delete_objects_max_size`::

(<<number,numeric>>) Sets the maxmimum batch size, betewen 1 and 1000, used
for `DeleteObjects` requests. Defaults to 1000 which is the maximum number
supported by the
https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html[AWS
DeleteObjects API].
(integer) Sets the maxmimum batch size, betewen 1 and 1000, used for `DeleteObjects` requests. Defaults to 1000 which is the maximum
number supported by the https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html[AWS DeleteObjects API].

`max_multipart_upload_cleanup_size`::

(<<number,numeric>>) Sets the maximum number of possibly-dangling multipart
uploads to clean up in each batch of snapshot deletions. Defaults to `1000`
which is the maximum number supported by the
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html[AWS
ListMultipartUploads API]. If set to `0`, {es} will not attempt to clean up
dangling multipart uploads.
(integer) Sets the maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions. Defaults to
`1000` which is the maximum number supported by the https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html[AWS
ListMultipartUploads API]. If set to `0`, {es} will not attempt to clean up dangling multipart uploads.

NOTE: The option of defining client settings in the repository settings as
documented below is considered deprecated, and will be removed in a future
Expand Down
Loading