OpenSearch/docs/plugins/repository-shared-settings.asciidoc

`max_restore_bytes_per_sec`::

    Throttles per node restore rate. Defaults to unlimited.
    Note that restores are also throttled through {ref}/recovery.html[recovery settings].

`max_snapshot_bytes_per_sec`::

    Throttles per node snapshot rate. Defaults to `40mb` per second.

`readonly`::

    Makes repository read-only.  Defaults to `false`.
[DOCS] Document common settings for snapshot repository plugins (#40475) (#40606) 2019-03-28 15:03:14 -04:00			`max_restore_bytes_per_sec`::

Account for recovery throttling when restoring snapshot (#58658) (#58811) Restoring from a snapshot (which is a particular form of recovery) does not currently take recovery throttling into account (i.e. the `indices.recovery.max_bytes_per_sec` setting). While restores are subject to their own throttling (repository setting `max_restore_bytes_per_sec`), this repository setting does not allow for values to be configured differently on a per-node basis. As restores are very similar in nature to peer recoveries (streaming bytes to the node), it makes sense to configure throttling in a single place. The `max_restore_bytes_per_sec` setting is also changed to default to unlimited now, whereas previously it was set to `40mb`, which is the current default of `indices.recovery.max_bytes_per_sec`). This means that no behavioral change will be observed by clusters where the recovery and restore settings were not adapted. Relates https://github.com/elastic/elasticsearch/issues/57023 Co-authored-by: James Rodewig <james.rodewig@elastic.co> 2020-07-01 12:19:29 +02:00			`Throttles per node restore rate. Defaults to unlimited.`
			`Note that restores are also throttled through {ref}/recovery.html[recovery settings].`
[DOCS] Document common settings for snapshot repository plugins (#40475) (#40606) 2019-03-28 15:03:14 -04:00
			`max_snapshot_bytes_per_sec`::

			Throttles per node snapshot rate. Defaults to `40mb` per second.

			`readonly`::

Account for recovery throttling when restoring snapshot (#58658) (#58811) Restoring from a snapshot (which is a particular form of recovery) does not currently take recovery throttling into account (i.e. the `indices.recovery.max_bytes_per_sec` setting). While restores are subject to their own throttling (repository setting `max_restore_bytes_per_sec`), this repository setting does not allow for values to be configured differently on a per-node basis. As restores are very similar in nature to peer recoveries (streaming bytes to the node), it makes sense to configure throttling in a single place. The `max_restore_bytes_per_sec` setting is also changed to default to unlimited now, whereas previously it was set to `40mb`, which is the current default of `indices.recovery.max_bytes_per_sec`). This means that no behavioral change will be observed by clusters where the recovery and restore settings were not adapted. Relates https://github.com/elastic/elasticsearch/issues/57023 Co-authored-by: James Rodewig <james.rodewig@elastic.co> 2020-07-01 12:19:29 +02:00			Makes repository read-only. Defaults to `false`.