From 6befbde81ebe69555d7a1293854ef168a5472084 Mon Sep 17 00:00:00 2001
From: tejaksha <tejaksha@gmail.com>
Date: Sat, 9 Sep 2023 13:59:17 +0530
Subject: [PATCH] updated the snapshots

---
 guides/snapshots.md | 188 ++++++++++----------------------------------
 1 file changed, 42 insertions(+), 146 deletions(-)

diff --git a/guides/snapshots.md b/guides/snapshots.md
index dd86ba04..5b2b8e13 100644
--- a/guides/snapshots.md
+++ b/guides/snapshots.md
@@ -1,140 +1,3 @@
-# Advanced Index Actions
-
-To perform the advanced index actions using the OpenSearch Python client, you can use the `opensearch-py` library. Here's how you can do it:
-
-## Setup
-First, make sure you have the `opensearch-py` library installed. You can install it using pip:
-
-```bash
-pip install opensearch-py
-```
-Let's create an OpenSearch client instance with configuration
-
-
-Now, you can use the library to perform the advanced index actions:
-
-```python
-from opensearchpy import OpenSearch
-
-# Create an OpenSearch client instance
-client = OpenSearch(
-    hosts=['https://admin:admin@localhost:9200'],  # Replace with your OpenSearch URL and credentials
-    use_ssl=False,  # Set to True if using SSL
-    verify_certs=False  # Set to True to verify SSL certificates
-)
-```
-## API Actions
-
-### Create an index named 'movies'
-
-Establishing a structure for data storage, such as defining fields and mappings for the 'movies' dataset.
-
-```python
-client.indices.create(index='movies')
-```
-
-### Clear index cache
-
-Removing stored cache data related to the 'movies' index to improve query performance.
-
-```python
-client.indices.clear_cache(index='movies')
-```
-
-### Flush index
-
-Forcing the immediate write of pending data to the 'movies' index for data durability.
-```python
-client.indices.flush(index='movies')
-```
-
-### Refresh index
-
-Making recent changes in the 'movies' index immediately available for search.
-
-```python
-client.indices.refresh(index='movies')
-```
-
-### Close index and Reopen Index
-
-Temporarily suspending read and write operations on the 'movies' index, then resuming access.
-
-```python
-client.indices.close(index='movies')
-```
-
-```python
-client.indices.open(index='movies')
-```
-
-### Force merge index
-
-Reducing resource usage and improving performance by merging smaller segments in the 'movies' index.
-
-```python
-client.indices.forcemerge(index='movies')
-```
-### Setting a Write Block
-Setting a write block to 'True' for the 'movies' index, preventing write operations on the index, making it read-only.
-
-This action ensures that no new data can be added to the 'movies' index until the write block is set to 'False', providing data protection or a controlled environment for certain use cases.
-
-```python
-client.indices.put_settings(
-    index='movies',
-    body={
-        'index': {
-            'blocks': {
-                'write': True
-            }
-        }
-    }
-)
-```
-
-### Clone index
-
-Creating a new index ('movies_clone') identical to 'movies,' preserving its structure and data.
-
-```python
-client.indices.clone(index='movies', target='movies_clone')
-```
-
-### Split index
-
-Let's fist create an index with number of shards 5 and number of routing shards 30  
-```python
-client.indices.create(
-    index='books',
-    body={
-        'settings': {
-            'index.number_of_shards': 5,
-            'index.number_of_routing_shards': 30,
-            'index.blocks.write': True
-        }
-    }
-)
-```
-
-Dividing the 'books' index into a new 'bigger_books' index with more primary shards for scalability.
-
-```python
-client.indices.split(
-    index='books',
-    target='bigger_books',
-    body={'settings.index.number_of_shards': 10}
-)
-```
-
-### Delete indices
-
-Removing multiple indices ('movies,' 'books,' 'movies_clone,' 'bigger_books') to clean up and manage data.
-
-```python
-client.indices.delete(index=['movies', 'books', 'movies_clone', 'bigger_books'])
-```
-
 ## Snapshots
 To use a shared file system as a snapshot repository, add it to opensearch.yml:
 
@@ -150,21 +13,33 @@ volumes:
 
 
 ### Create Repository
-Define the repository name and snapshot name and create a repository (if it doesn't exist)
+Define the repository name and create a repository (if it doesn't exist)
+### Define a repository for storing snapshots in your file system
 ```python
 repository_name = "my_repository"
-snapshot_name = "my_snapshot"
-
-
-client.snapshot.create_repository(
-    repository=repository_name,
-    body={
+repository_settings = {
         "type": "fs",  # You can use other repository types like S3
         "settings": {
             "location": "/path/to/your/repository"  # Specify the path to your backup repository
         }
+}
+```
+
+### Define a repository for storing snapshots in cloud storage
+```python
+repository_name = "my_s3_repository"
+repository_settings = {
+    "type": "s3",
+    "settings": {
+        "bucket": "my-backup-bucket",
+        "region": "us-east-1",
+        "base_path": "opensearch-backups"
     }
-)
+}
+```
+### Create the repository
+```python
+client.snapshot.create_repository(repository=repository_name, body=repository_settings)
 ```
 
 ### Take Snapshot
@@ -172,6 +47,7 @@ client.snapshot.create_repository(
 Take a snapshot of the 'movies' index
 
 ```python
+snapshot_name = "my_snapshot"
 client.snapshot.create(
     repository=repository_name,
     snapshot=snapshot_name,
@@ -196,4 +72,24 @@ client.snapshot.restore(
         "rename_replacement": "restored_movies"  # Optional: New index name
     }
 )
-```
\ No newline at end of file
+```
+
+### List all snapshots in a repository
+```python
+snapshots = client.snapshot.get(repository=repository_name)
+print(snapshots)
+```
+
+### Delete a snapshot
+```python
+snapshot_to_delete = "old_snapshot"
+response = client.snapshot.delete(repository=repository_name, snapshot=snapshot_to_delete)
+print(response)
+```
+
+### Restore a snapshot
+```python
+snapshot_to_restore = "my_snapshot"
+response = client.snapshot.restore(repository=repository_name, snapshot=snapshot_to_restore)
+print(response)
+```