IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Repository Settings
editRepository Settings
editThe gcs
repository type supports a number of settings to customize how data
is stored in Google Cloud Storage.
These can be specified when creating the repository. For example:
PUT _snapshot/my_gcs_repository { "type": "gcs", "settings": { "bucket": "my_other_bucket", "base_path": "dev" } }
The following settings are supported:
-
bucket
- The name of the bucket to be used for snapshots. (Mandatory)
-
client
-
The name of the client to use to connect to Google Cloud Storage.
Defaults to
default
. -
base_path
- Specifies the path within bucket to repository data. Defaults to the root of the bucket.
-
chunk_size
-
Big files can be broken down into chunks during snapshotting if needed.
Specify the chunk size as a value and unit, for example:
10MB
or5KB
. Defaults to100MB
, which is the maximum permitted. -
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 tofalse
. -
max_restore_bytes_per_sec
-
Throttles per node restore rate. Defaults to
40mb
per second. -
max_snapshot_bytes_per_sec
-
Throttles per node snapshot rate. Defaults to
40mb
per second. -
readonly
-
Makes repository read-only. Defaults to
false
. -
application_name
- [6.3.0] Deprecated in 6.3.0. This setting is now defined in the client settings. Name used by the client when it uses the Google Cloud Storage service.
Recommended Bucket Permission
editThe service account used to access the bucket must have the "Writer" access to the bucket:
- Connect to the Google Cloud Platform Console.
- Select your project.
- Got to the Storage Browser.
- Select the bucket and "Edit bucket permission".
- The service account must be configured as a "User" with "Writer" access.