It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Include additional Kibana plugins Snapshotting to Google Cloud Storage (GCS) for Elasticsearch 6.4 - 6.8 »

› ›

Manage snapshot repositories

edit

Manage snapshot repositories

edit

Snapshot repositories are managed for your entire Elastic Cloud Enterprise installation and can be specified for an Elasticsearch cluster when you create or manage it.

When a repository is specified, a snapshot is taken every 30 minutes by default, or at the interval that you specify. For Elastic Stack versions 7.6 and above, snapshots are configured and restored using Kibana’s snapshot and restore features. For Elastic Stack versions 7.5 and earlier, see the instructions for adjusting the snapshot interval.

Support for the following repositories is available through the Elastic core repository plugins:

In addition to enabling the official plugins, there are a few more things to consider, depending on which service you use. To configure Google Cloud Storage (GCS) as a snapshot repository, your Elasticsearch cluster must be version 6.0 or later and you must use Google Default Authentication. To learn more, see Snapshotting to Google Cloud Storage. To configure Microsoft Azure Storage as a snapshot repository, your Elasticsearch cluster must be version 5.X, 6.2.X, or later. To learn more, see Snapshotting to Azure Storage.

For more details about how snapshots are used with Elasticsearch, see Snapshot and Restore. You can also review the official documentation for these storage repository options:

If you are installing ECE without internet access (commonly called an offline or air-gapped installation), you will need to use an on-premise storage service. We suggest that you use Minio. For our installation notes, see Snapshotting to Minio On-Premise Storage.

Add snapshot repository configurations

edit

Before any snapshot or restore operation can be performed for Elasticsearch clusters, at least one snapshot repository configuration needs to be added to your Elastic Cloud Enterprise installation.

To add a snapshot repository:

Log into the Cloud UI.
From the Platform menu, select Repositories.
Click Add Repository to add an existing repository.
Provide a name for the repository configuration.
Select one of the supported repository types and specify the necessary settings:
- Amazon S3 configuration:
  
  All repository options must be specified, as there are no default values.
  
  Region
  
  The region where the bucket is located.
  
  Bucket
  
  The name of the bucket to be used for snapshots.
  
  Access key
  
  The access key to use for authentication.
  
  Secret key
  
  The secret key to use for authentication.
- Advanced configuration:
  
  Used for Microsoft Azure or for some Amazon S3 repositories where you need to provide additional configuration parameters not supported by the S3 repository option. Configurations must be specified in a valid JSON format. For example:
  
  Amazon S3 (see supported settings):
```
{
  "type": "s3",
  "settings": {
    "bucket": "my_bucket_name",
    "region": "us-west"
  }
}
```
Click Save.

Edit snapshot repository configurations

edit

To edit a snapshot repository configuration from your Elastic Cloud Enterprise installation:

Log into the Cloud UI.
From the Platform menu, select Repositories.
Click Edit to modify a snapshot repository configuration.

For available options that you can change, see Add Snapshot Repository Configurations.
Click Save.

Delete snapshot repository configurations

edit

Deleting a snapshot repository configuration does not remove the snapshot repository itself from S3. Only the configuration that enables Elastic Cloud Enterprise to access the repository is removed. Existing snapshots are also retained and need to be deleted separately if you no longer need them.

To delete a snapshot repository configuration from your Elastic Cloud Enterprise installation:

Log into the Cloud UI.
From the Platform menu, select Repositories.
Find the repository name that you want to remove.

Run the following command against the repository name:

curl -s -XDELETE -u USER:PASSWORD https://COORDINATOR_HOST:12443/api/v1/platform/configuration/snapshots/repositories/REPOSITORY_NAME

The user must have sufficient privileges, such as the admin user.

Manage Elasticsearch cluster repositories

edit

You might need to update existing Elasticsearch clusters to use a different snapshot repository for one of the following reasons:

If you do not want all snapshots for a specific Elasticsearch cluster to go into the same bucket as your other clusters, you can add a new snapshot repository configuration with separate permissions and then change your Elasticsearch cluster to use the new repository.
If you created an Elasticsearch cluster with no snapshot repository configured, you can add a repository later on. Elastic Cloud Enterprise will start taking snapshots of the cluster automatically.

To change the snapshot repository for an existing Elasticsearch cluster:

Log into the Cloud UI.
Optional: If you need to use a repository that is not yet listed, add a snapshot repository configuration first.
From the Deployments page, select your deployment.

Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
From the Elasticsearch menu, click Snapshots.
Under Snapshot repository, select a different repository and click Save repository.

Future snapshots will be sent to the new repository.

« Include additional Kibana plugins Snapshotting to Google Cloud Storage (GCS) for Elasticsearch 6.4 - 6.8 »