Create a Repository | Elasticsearch Plugins and Integrations [5.0]

You are looking at documentation for an older release. Not what you want? See the current release documentation.

» » »

Once everything is installed and every node is started, you can create a new repository that uses Google Cloud Storage to store snapshots:

PUT _snapshot/my_gcs_repository
{
  "type": "gcs",
  "settings": {
    "bucket": "my_bucket",
    "service_account": "service_account.json"
  }
}

The following settings are supported:

bucket: The name of the bucket to be used for snapshots. (Mandatory)
service_account: The service account to use. It can be a relative path to a service account JSON file or the value _default_ that indicate to use built-in Compute Engine service account.
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. The chunk size can be specified in bytes or by using size value notation, i.e. 1g, 10m, 5k. Defaults to 100m.
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.
application_name: Name used by the plugin when it uses the Google Cloud JSON API. Setting a custom name can be useful to authenticate your cluster when requests statistics are logged in the Google Cloud Platform. Default to repository-gcs