Big Data

Take handbook snapshots and restore in a unique area spanning throughout varied Areas and accounts in Amazon OpenSearch Service

12 October 2024

Snapshots are essential for knowledge backup and catastrophe restoration in Amazon OpenSearch Service. These snapshots let you generate backups of your area indexes and cluster state at particular moments and save them in a dependable storage location similar to Amazon Easy Storage Service (Amazon S3).

Snapshots play a essential position in offering the supply, integrity and skill to recuperate knowledge in OpenSearch Service domains. By implementing a sturdy snapshot technique, you possibly can mitigate dangers related to knowledge loss, streamline catastrophe restoration processes and preserve compliance with knowledge administration greatest practices.

This submit supplies an in depth walkthrough about methods to effectively seize and handle handbook snapshots in OpenSearch Service. It covers the important steps for taking snapshots of your knowledge, implementing secure switch throughout totally different AWS Areas and accounts, and restoring them in a brand new area. This information is designed that can assist you preserve knowledge integrity and continuity whereas navigating advanced multi-Area and multi-account environments in OpenSearch Service.

Consult with this developer information to grasp extra about index snapshots

Understanding handbook snapshots

Guide snapshots are point-in-time backups of your OpenSearch Service area which are initiated by the consumer. Opposite to automated snapshots, that are taken frequently in accordance with the required retention coverage by OpenSearch Service, handbook snapshots provide the capacity to take backups every time required, whether or not for the total cluster or for particular person indices. That is notably helpful once you wish to protect a selected state of your knowledge for future reference or earlier than implementing vital adjustments to your area.

Snapshots will not be instantaneous. They take time to finish and don’t signify good point-in-time views of the area. Whereas a snapshot is in progress, you possibly can nonetheless index paperwork and make different requests to the area, however new paperwork and updates to current paperwork typically aren’t included within the snapshot. The snapshot contains major shards as they existed once you provoke the snapshot course of.

The next are some eventualities the place handbook snapshots play an vital position:

Information restoration – The first function of snapshots, whether or not handbook or automated, is to offer a method of information restoration within the occasion of a failure or knowledge loss. If one thing goes flawed together with your area, you possibly can restore it to a earlier state utilizing a snapshot.
Migration – Guide snapshots will be helpful once you wish to migrate knowledge from one area to a different. You possibly can create a snapshot of the supply area after which restore it on the goal area.
Testing and improvement – You should use snapshots to create copies of your knowledge for testing or improvement functions. This lets you experiment together with your knowledge with out affecting the manufacturing surroundings.
Backup management – Guide snapshots offer you extra management over your backup course of. You possibly can select precisely when to create a snapshot, which will be helpful you probably have particular necessities that aren’t met by automated snapshots.
Lengthy-term archiving – Guide snapshots will be saved for so long as you need, which will be helpful for long-term archiving of information. Automated snapshots, then again, are sometimes deleted after a sure time frame.

Resolution overview

The next sections define the process for taking a handbook snapshot after which restoring it in a unique area, spanning throughout varied Areas and accounts. The high-level steps are as follows:

Create an AWS Id and Entry Administration (IAM) position and consumer.
Register a handbook snapshot repository.
Take handbook snapshots.
Arrange S3 bucket replication.
Create an IAM position and consumer within the goal account.
Add a bucket coverage.
Register the repository and restore snapshots within the goal area.

Prerequisite

This submit assumes you’ve gotten the next assets arrange:

An lively and operating OpenSearch Service area.
An S3 bucket to retailer the handbook snapshots of your OpenSearch Service area. The bucket must be in the identical Area the place the OpenSearch Service area is hosted.

Create an IAM position and consumer

Full the next steps to create your IAM position and consumer:

Create an IAM position to grant permissions to OpenSearch Service. For this submit, we identify the position TheSnapshotRole.
Create a brand new coverage utilizing the next code and fasten it to the position to permit entry to the S3 bucket.

{
  "Model": "2012-10-17",
  "Assertion": [
    {
      "Action": [
        "s3:ListBucket"
      ],
      "Impact": "Enable",
      "Useful resource": [
        "arn:aws:s3:::s3-bucket-name"
      ]
    },
    {
      "Motion": [
        "s3:GetObject",
        "s3:PutObject",
        "s3:DeleteObject",
        "iam:PassRole"
      ],
      "Impact": "Enable",
      "Useful resource": [
        "arn:aws:s3:::s3-bucket-name/*"
      ]
    }
  ]
}

Edit the belief relationship of TheSnapshotRole to specify OpenSearch Service within the Principal assertion, as proven within the following instance. Below the Situation block, we advocate that you simply use the aws:SourceAccount and aws:SourceArn situation keys to guard your self towards the confused deputy downside. The supply account is the proprietor and the supply ARN is the ARN of the OpenSearch Service area.

{
  "Model": "2012-10-17",
  "Assertion": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {
        "Service": "es.amazonaws.com"
      },
      "Action": "sts:AssumeRole",
      "Condition": {
        "StringEquals": {
          "aws:SourceAccount": "account-id"
        },
        "ArnLike": {
          "aws:SourceArn": "arn:aws:es:region:account-id:domain/domain-name"
        }
      }
    }
  ]
}

Generate an IAM consumer to register the snapshot repository. For this submit, we identify the consumer TheSnapUser.
To register a snapshot repository, it is advisable to move TheSnapshotRole to OpenSearch Service. You additionally want entry to the es:ESHttpPut To grant each of those permissions, connect the next coverage to the IAM position whose credentials are getting used to signal the request.

{
  "Model": "2012-10-17",
  "Assertion": [
    {
      "Effect": "Allow",
      "Action": "iam:PassRole",
      "Resource": "arn:aws:iam::123456789012:role/TheSnapshotRole"
    },
    {
      "Effect": "Allow",
      "Action": "es:ESHttpPut",
      "Resource": "arn:aws:es:region:123456789012:domain/domain-name/*"
    }
  ]
}

Register a handbook snapshot repository

Full the next steps to map the snapshot position and the consumer in OpenSearch Dashboards (if utilizing fine-grained entry management):

Navigate to the OpenSearch Dashboards endpoint linked to your OpenSearch Service area.
Check in with the admin consumer or a consumer with the security_manager position
From the primary menu, select Safety, Roles, and choose the manage_snapshots position
Select Mapped customers, then select Handle mapping.
Add the ARN of TheSnapshotRole for Backend position and the ARN of TheSnapUser for Person:
1. arn:aws:iam::123456789123:position/TheSnapshotRole
2. arn:aws:iam::123456789123:consumer/TheSnapUser
Select Map and make sure the consumer and position reveals up below Mapped customers.
To register a snapshot repository, ship a PUT request to the OpenSearch Service area endpoint via an API platform like Postman or Insomnia. For extra particulars, see Registering a handbook snapshot repository.

Observe: Whereas utilizing Postman or Insomnia to run the API calls talked about all through this weblog, select AWS IAM v4 because the authentication methodology and enter your IAM credentials within the Authorization part. Make sure you use the credentials of an OpenSearch consumer who has the ‘all_access’ OpenSearch position assigned on the area.

curl -XPUT domain-endpoint/_snapshot/my-snapshot-repo-name
{
  "sort": "s3",
  "settings": {
    "bucket": "s3-bucket-name",
    "area": "area",
    "role_arn": "arn:aws:iam::123456789012:position/TheSnapshotRole"
  }
}

In case your area resides inside a digital personal cloud (VPC), you should be linked to the VPC for the request to efficiently register the snapshot repository. Accessing a VPC varies by community configuration, however seemingly includes connecting to a VPN or company community. To verify that you would be able to attain the OpenSearch Service area, navigate to https://.es.amazonaws.com in an internet browser and confirm that you simply obtain the default JSON response.

Take handbook snapshots

Taking a snapshot isn’t doable if one other snapshot is at the moment in progress. The Ultrawarm storage tier migration course of additionally makes use of snapshots to maneuver knowledge between sizzling and heat storage, operating this course of within the background. Moreover, automated snapshots are taken primarily based on the schedule configured for the cluster by the service. See Defending knowledge with encryption for safeguarding your Amazon S3 knowledge.

To confirm, run the next command

curl -XGET 'domain-endpoint/_snapshot/_status

After you verify no snapshot is operating, run the next command to take a handbook snapshot

curl -XPUT 'domain-endpoint/_snapshot/repository-name/snapshot-name

Run the next command to confirm the state of all snapshots of your area

curl -XGET 'domain-endpoint/_snapshot/repository-name/_all?fairly

Arrange S3 bucket replication

Earlier than you begin, have the next in place:

Find the vacation spot bucket the place the info might be replicated. In case you don’t have one, create a brand new S3 bucket in a definite area, separate from the area of the supply bucket.
To permit entry to things on this bucket by different AWS accounts (as a result of the vacation spot OpenSearch Service area is in a unique account), it is advisable to allow entry management lists (ACLs) on the bucket. ACLs might be used to specify and handle entry permissions for the bucket and its objects.

Full the next steps to arrange S3 bucket replication. For extra info, see Walkthroughs: Examples for configuring replication.

On the Amazon S3 console, select Buckets within the navigation pane.
Select the bucket you wish to replicate (the supply bucket with snapshots).
On the Administration tab, select Create replication rule.
Replication requires versioning to be enabled for the supply bucket, so select Allow bucket versioning and allow versioning.
Specify the next particulars:
1. For Rule ID, enter a reputation on your rule.
2. For Standing, select Enabled.
3. For Rule scope, specify the info to be replicated.
4. For Vacation spot S3 bucket, enter the goal bucket identify the place the info might be replicated.
5. For IAM position, select Create new position.
Select Save.
Within the Replicate current objects pop-up window, choose Sure, replicate current objects to begin replication.
Select Submit.

You will note a brand new lively replication rule within the replication desk on the Administration tab of the supply S3 bucket.

Create an IAM position and consumer within the goal account

Full the next steps to create your IAM position and consumer within the goal account.

Create an IAM position to grant permissions to the goal OpenSearch Service. For this submit, identify the position DestinationSnapshotRole.
Create a brand new coverage utilizing the next code and fasten it to the position DestinationSnapshotRole to permit entry to the goal S3 bucket

{
  "Model": "2012-10-17",
  "Assertion": [
    {
      "Action": [
        "s3:ListBucket"
      ],
      "Impact": "Enable",
      "Useful resource": [
        "arn:aws:s3:::s3-bucket-name" -> Replicated s3 bucket
      ]
    },
    {
      "Motion": [
        "s3:GetObject",
        "s3:PutObject",
        "s3:DeleteObject",
        "iam:PassRole"
      ],
      "Impact": "Enable",
      "Useful resource": [
        "arn:aws:s3:::s3-bucket-name/*" -> Replicated s3 bucket 
      ]
    }
  ]
}

Edit the belief relationship of DestinationSnapshotRole to specify OpenSearch Service within the Principal assertion as proven within the following instance.

{
  "Model":"2012-10-17",
  "Assertion":[
    {
      "Sid":"",
      "Effect":"Allow",
      "Principal":{
        "Service":"es.amazonaws.com"
      },
      "Action":"sts:AssumeRole",
      "Condition":{
        "StringEquals":{
          "aws:SourceAccount":"account-id" -> Target Account
        },
        "ArnLike":{
          "aws:SourceArn":"arn:aws:es:region:account-id:domain/domain-name/*" -> Target OpenSearch Domain
        }
      }
    }
  ]
}

Generate an IAM consumer to register the snapshot repository. For this submit, identify the consumer DestinationSnapUser.
To register a snapshot repository, it is advisable to move DestinationSnapshotRole to OpenSearch Service. You additionally want entry to the es:ESHttpPut To grant each of those permissions, connect the next coverage to the IAM position whose credentials are getting used to signal the request

{
  "Model":"2012-10-17",
  "Assertion":[
    {
      "Effect":"Allow",
      "Action":"iam:PassRole",
      "Resource":"arn:aws:iam::123456789012:role/DestinationSnapshotRole"
    },
    {
      "Effect":"Allow",
      "Action":"es:ESHttpPut",
      "Resource":"arn:aws:es:region:123456789012:domain/domain-name/*" -> Target OpenSearch Domain
    }
  ]
}

Full the next steps to map the snapshot position and consumer within the goal OpenSearch Dashboards (if utilizing fine-grained entry management).

Navigate to the OpenSearch Dashboard’s endpoint linked together with your OpenSearch Service area.
Check in with the admin consumer or a consumer with the security_manager position
From the primary menu, select Safety, Roles, and select the manage_snapshots position
Select Mapped customers, then select Handle mapping.
Add the ARN of TheSnapshotRole for Backend position and the ARN of TheSnapUser for Person:
1. arn:aws:iam::123456789123:position/DestinationSnapshotRole
2. arn:aws:iam::123456789123:consumer/DestinationSnapUser
Select Map and make sure the consumer and position reveals up below Mapped customers.

Add a bucket coverage

Within the vacation spot S3 bucket particulars web page, on the Permissions tab, select Edit, then add the next bucket coverage. This coverage permits the goal OpenSearch Service area from one other AWS account to entry the snapshot created by a unique AWS account.

{
  "Model":"2012-10-17",
  "Id":"Policy1568001010746",
  "Assertion":[
    {
      "Sid":"Stmt1568000712531",
      "Effect":"Allow",
      "Principal":{
        "AWS":"arn:aws:iam::Account B:role/cross" -> DestinationSnapshotRole
      },
      "Action":"s3:*",
      "Resource":"arn:aws:s3:::snapshot"
    },
    {
      "Sid":"Stmt1568001007239",
      "Effect":"Allow",
      "Principal":{
        "AWS":"arn:aws:iam::Account B:role/cross" -> DestinationSnapshotRole
      },
      "Action":[
        "s3:GetObject",
        "s3:PutObject",
        "s3:DeleteObject"
      ],
      "Useful resource":"arn:aws:s3:::snapshot/*"
    }
  ]
}

Register the repository and restore snapshots within the goal area

To finish this step, you want an lively and operating OpenSearch Service area within the goal account.

Establish the snapshot you wish to restore. Ensure all settings for this index, similar to customized analyzer packages or allocation requirement settings, and knowledge are suitable with the area. Then full the next steps

To register the repository within the goal OpenSearch Service area, run the next command.

curl -XPUT domain-endpoint/_snapshot/my-snapshot-repo-name
{
  "sort": "s3",
  "settings": {
    "bucket": "s3-bucket-name",
    "area": "area",
    "role_arn": "arn:aws:iam::123456789012:position/DestinationSnapshotRole"
  }
}

After you register the repository, run the next command to see all snapshots.

curl -XGET 'domain-endpoint/_snapshot/repository-name/_all?fairly

To revive a snapshot, run the next command.

curl -XPOST 'domain-endpoint/_snapshot/repository-name/snapshot-name/_restore

Alternately, you would possibly wish to restore all indexes besides the dashboards and fine-grained entry management indexes.

curl -XPOST 'domain-endpoint/_snapshot/repository-name/snapshot-name/_restore' 
-d '{"indices": "-.kibana*,-.opendistro*"}' 
-H 'Content material-Sort: utility/json'

Check in to OpenSearch Dashboards linked to the goal OpenSearch Service area and run the next command to verify if the info is getting restored.

curl -XGET _cat/indices?v

Run the next restoration command to verify the progress of the restore operation.

curl -XGET _cat/restoration?v

Troubleshooting

This re:Put up article addresses nearly all of widespread errors that come up when making an attempt to revive a handbook snapshot, together with efficient options to resolve them.

Conclusion

On this submit, we offered a process for taking handbook snapshots and restoring them in OpenSearch Service. With handbook snapshots, you’ve gotten the ability to handle your knowledge backups, preserving key moments in time, confidently experimenting with area modifications, and defending towards any knowledge loss. Moreover, with the ability to restore snapshots throughout varied domains, Areas, and accounts allows a brand new diploma of information portability and suppleness, supplying you with the liberty to raised handle and optimize your domains.

With nice knowledge safety comes nice innovation. Now that you simply’re geared up with this information, you possibly can discover the limitless potentialities that OpenSearch Service presents, assured in your capacity to safe, restore, and thrive within the dynamic world of cloud-based knowledge analytics and administration.

See weblog submit to grasp methods to use snapshot administration insurance policies to handle automated snapshot in OpenSearch Service.

You probably have suggestions about this submit, submit it within the feedback part. You probably have questions on this submit, begin a brand new thread on the Amazon OpenSearch Service discussion board or contact AWS Assist.

Keep tuned for extra thrilling updates and new options in Amazon OpenSearch Service.

Concerning the authors

Madhan Kumar Baskaran works as a Search Engineer at AWS, specializing in Amazon OpenSearch Service. His major focus includes helping clients in developing scalable search purposes and analytics options. Based mostly in Bellevue, Washington, Madhan has a eager curiosity in knowledge engineering and DevOps.

Priyanshi Omer is a Buyer Success Engineer at AWS OpenSearch, primarily based in Bengaluru. Her major focus includes helping clients in developing scalable search purposes and analytics options. She works intently with clients to assist them migrate their workloads and aids current clients in fine-tuning their clusters to attain higher efficiency and price financial savings. Outdoors of labor, she enjoys spending time together with her cats and enjoying video video games