Merge pull request #375 from opensearch-project/index-apis

Add clone and split APIs and bug fixes

_dashboards/browser-compatibility.md

@@ -1,7 +1,6 @@
 ---
 layout: default
 title: Browser compatibility
-parent: OpenSearch Dashboards
 nav_order: 3
 ---
 

_opensearch/install/docker-security.md

@@ -86,7 +86,7 @@ services:
       - ./action_groups.yml:/usr/share/opensearch/plugins/opensearch-security/securityconfig/action_groups.yml
     networks:
       - opensearch-net
-  opensearch-dashboards
+  opensearch-dashboards:
     image: opensearchproject/opensearch-dashboards:{{site.opensearch_dashboards_version}}
     container_name: opensearch-dashboards
     ports:

_opensearch/rest-api/index-apis/clone.md

@@ -0,0 +1,71 @@
+---
+layout: default
+title: Clone index
+parent: Index APIs
+grand_parent: REST API reference
+nav_order: 70
+---
+
+# Clone index
+
+The clone index API operation clones all data in an existing read-only index into a new index. The new index cannot already exist.
+
+## Example
+
+```json
+PUT /sample-index1/_clone/cloned-index1
+{
+  "settings": {
+    "index": {
+      "number_of_shards": 2,
+      "number_of_replicas": 1
+    }
+  },
+  "aliases": {
+    "sample-alias1": {}
+  }
+}
+```
+
+## Path and HTTP methods
+
+```
+POST /<source-index>/_clone/<target-index>
+PUT /<source-index>/_clone/<target-index>
+```
+
+## Index naming restrictions
+
+OpenSearch indexes have the following naming restrictions:
+
+- All letters must be lowercase.
+- Index names can't begin with underscores (`_`) or hyphens (`-`).
+- Index names can't contain spaces, commas, or the following characters:
+
+  `:`, `"`, `*`, `+`, `/`, `\`, `|`, `?`, `#`, `>`, or `<`
+
+## URL parameters
+
+Your request must include the source and target indexes. All other clone index parameters are optional.
+
+Parameter | Type | Description
+:--- | :--- | :---
+&lt;source-index&gt; | String | The source index to clone.
+&lt;target-index&gt; | String | The index to create and add cloned data to.
+wait_for_active_shards | String | The number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the operation to succeed.
+master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`.
+timeout | Time | How long to wait for the request to return. Default is `30s`.
+
+## Request body
+
+The clone index API operation creates a new target index, so you can specify any [index settings]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/#index-settings) and [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias) to apply to the target index.
+
+## Response
+
+```json
+{
+    "acknowledged": true,
+    "shards_acknowledged": true,
+    "index": "cloned-index1"
+}
+```

_opensearch/rest-api/index-apis/create-index.md

@@ -47,7 +47,7 @@ PUT <index-name>
 
 ## Index naming restrictions
 
-OpenSearch indices have the following naming restrictions:
+OpenSearch indexes have the following naming restrictions:
 
 - All letters must be lowercase.
 - Index names can't begin with underscores (`_`) or hyphens (`-`).

_opensearch/rest-api/index-apis/split.md

@@ -0,0 +1,71 @@
+---
+layout: default
+title: Split index
+parent: Index APIs
+grand_parent: REST API reference
+nav_order: 80
+---
+
+# Split index
+
+The split index API operation splits an existing read-only index into a new index, cutting each primary shard into some amount of primary shards in the new index.
+
+## Example
+
+```json
+PUT /sample-index1/_split/split-index1
+{
+  "settings": {
+    "index": {
+      "number_of_shards": 4,
+      "number_of_replicas": 2
+    }
+  },
+  "aliases": {
+    "sample-alias1": {}
+  }
+}
+```
+
+## Path and HTTP methods
+
+```
+POST /<source-index>/_split/<target-index>
+PUT /<source-index>/_split/<target-index>
+```
+
+## Index naming restrictions
+
+OpenSearch indexes have the following naming restrictions:
+
+- All letters must be lowercase.
+- Index names can't begin with underscores (`_`) or hyphens (`-`).
+- Index names can't contain spaces, commas, or the following characters:
+
+  `:`, `"`, `*`, `+`, `/`, `\`, `|`, `?`, `#`, `>`, or `<`
+
+## URL parameters
+
+Your request must include the source and target indexes. All split index parameters are optional.
+
+Parameter | Type | Description
+:--- | :--- | :---
+&lt;source-index&gt; | String | The source index to split.
+&lt;target-index&gt; | String | The index to create.
+wait_for_active_shards | String | The number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the operation to succeed.
+master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`.
+timeout | Time | How long to wait for the request to return. Default is `30s`.
+
+## Request body
+
+The split index API operation creates a new target index, so you can specify any [index settings]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/#index-settings) and [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias) to apply to the target index.
+
+## Response
+
+```json
+{
+    "acknowledged": true,
+    "shards_acknowledged": true,
+    "index": "split-index1"
+}
+```