OpenSearch With Wasabi

How do I use OpenSearch with Wasabi?

OpenSearch has been validated for use with Wasabi. Follow the instructions below for more information.

Downloading and Configuring the OpenSearch Package

1. Download and extract the OpenSearch-Package.

    

   

2. Before running OpenSearch, be sure that the Linux parameter "vm.max_map_count" is at least 262144 and memory paging is Disabled. To stop memory paging, use the following command.

   sudo swapoff -a

3. To increase the amount of memory mappings available for OpenSearch, change the following "sysctl" configuration file by adding the following line "vm.max_map_count=262144" to the conf file and restart the Kernel.

   sudo vi /etc/sysctl.conf

4. To restart the kernel, execute the following command.

   sudo sysctl -p

5. Verify the changes by executing the following command.

   cat /proc/sys/vm/max_map_count

   

Installing the Plugin and Setting the Wasabi Repository

1. Install the repository-s3 plugin by navigating to the OpenSearch directory that has been extracted.

   ./bin/opensearch-plugin install repository-s3

   

2. Set a password for OpenSearch using the following command.

   export OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password>

   

3. Configure Wasabi account access keys and secret keys using the following commands. You will need to replace the access key and secret key with keys generated from your Wasabi account. For more information, refer to 3—Creating a User Account and Access Key.

   ./bin/opensearch-keystore add s3.client.default.access_key
   
   ./bin/opensearch-keystore add s3.client.default.secret_key
   

   

4. Open the configuration folder and edit the opensearch.yml config file with the following configuration. Set the default region and endpoint URL per the bucket region that was created in the Wasabi account.

   plugins.security.disabled: true 
   ### to disable the ssl plugin security
   
   s3.client.default.endpoint: s3.ca-central-1.wasabisys.com  
   ### endpoint url
   
   s3.client.default.region: ca-central-1 
   ### bucket region  

5. Start the OpenSearch by executing the startup script.

   ./opensearch-tar-install.sh

   

6. From another terminal session, check if the OpenSearch is started by executing the following CURL command on port 9200.

   curl -X GET http://localhost:9200

   

7. Register the Wasabi bucket as a repository in OpenSearch once it is up and running. Replace the repository name to identify this repository. Replace the bucket name with the name of the bucket that is created in the Wasabi account.

   curl -XPUT "http://localhost:9200/_snapshot/<repository-name> " -H 'Content-Type: application/json' -d'
   {
     "type": "s3",
     "settings": {
       "bucket": "<bucket-name>",
       "base_path": “<base path or object prefix>"
     }
   }'

   

8. The above CURL command returns the following output after successful execution.

   {"acknowledged": true}

   

Taking Snapshots

1. To take a snapshot and save in the Wasabi bucket, execute the following command by replacing the repository-name with the name configured in the previous step. The following snapshot includes all indexes and the cluster state.

   curl -XPUT "http://localhost:9200/_snapshot/<repository-name>/1"

   

   You can also add a request body to include or exclude certain indexes or specify other settings. Snapshots can take a while to complete, so consider using this option by adding the query parameters at the end.

   curl -XPUT "http://localhost:9200/_snapshot/<repository-name>/1?wait_for_completion=true"

2. To check the Snapshot status, execute the following command.

   curl -XGET "http://localhost:9200/_snapshot/_status"

3. Verify from the Wasabi Console that the snapshot is successfully saved to the bucket.

Restoring Snapshots

Create the new OpenSearch server and configure the repository to restore the snapshot.

1. Be sure that the basepath and repository name match the repository that was created initially. Once configured, execute the following command to check the list of snapshots that are available.

   curl -XGET "http://localhost:9200/_snapshot/<repository-name>/_all"

   

2. To restore the second snapshot, execute the following command by replacing the repository name. Before restoring, ensure that the indices in the snapshot have no naming conflict with the existing indices.

   curl -XPOST "http://localhost:9200/_snapshot/<repository-name>/2/_restore"

   

For additional questions, submit a request.