docs update

Signed-off-by: Sean Kao <[email protected]>
opensearch-project · Apr 27, 2023 · 00410d3 · 00410d3
1 parent bb66ca8
commit 00410d3
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/docs/user/ppl/admin/cross_cluster_search.rst b/docs/user/ppl/admin/cross_cluster_search.rst
@@ -43,7 +43,7 @@ Example search command ::
 
 Limitation
 ==========
-Since OpenSearch does not support cross cluster system index query, field mapping of a remote cluster index is not available to the local cluster.
+Since OpenSearch does not support cross cluster index metadata retrieval, field mapping of a remote cluster index is not available to the local cluster.
 (`[Feature] Cross cluster field mappings query #6573 <https://github.com/opensearch-project/OpenSearch/issues/6573>`_)
 Therefore, the query engine requires that for any remote cluster index that the users need to search,
 the local cluster keep a field mapping system index with the same index name.
@@ -64,7 +64,7 @@ Example: Create the ppl_role for test_user on local cluster and the ccs_role for
 
 1. On the local cluster, refer to `Security Settings <security.rst>`_ to create role and user for PPL plugin and index access permission.
 
-2. On the remote cluster, create a new role and grant permission to access index. Create a user the same as the local cluster, and map the user to this role::
+2. On the remote cluster, create a new role and grant permission to access index. Create a user with the same name and credentials as the local cluster, and map the user to this role::
 
     PUT _plugins/_security/api/roles/ccs_role
     {

diff --git a/docs/user/ppl/admin/security.rst b/docs/user/ppl/admin/security.rst
@@ -13,7 +13,7 @@ Security Settings
 Introduction
 ============
 
-User needs ``cluster:admin/opensearch/ppl`` permission to use PPL plugin. User also needs indices level permission ``indices:admin/mappings/get`` to get field mappings and ``indices:data/read/search*`` to search index.
+User needs ``cluster:admin/opensearch/ppl`` permission to use PPL plugin. User also needs indices level permission ``indices:admin/mappings/get`` to get field mappings, ``indices:monitor/settings/get`` to get cluster settings, and ``indices:data/read/search*`` to search index.
 
 Using Rest API
 ==============
@@ -34,7 +34,8 @@ Example: Create the ppl_role for test_user. then test_user could use PPL to quer
         ],
         "allowed_actions": [
           "indices:data/read/search*",
-          "indices:admin/mappings/get"
+          "indices:admin/mappings/get",
+          "indices:monitor/settings/get"
         ]
       }]
     }

diff --git a/docs/user/ppl/cmd/search.rst b/docs/user/ppl/cmd/search.rst
@@ -23,6 +23,11 @@ search source=[<remote-cluster>:]<index> [boolean-expression]
 * bool-expression: optional. any expression which could be evaluated to boolean value.
 
 
+Cross-Cluster Search
+====================
+Cross-cluster search lets any node in a cluster execute search requests against other clusters. Refer to `Cross-Cluster Search <admin/cross_cluster_search.rst>`_ for configuration.
+
+
 Example 1: Fetch all the data
 =============================
 

diff --git a/docs/user/ppl/index.rst b/docs/user/ppl/index.rst
@@ -38,7 +38,7 @@ The query start with search command and then flowing a set of command delimited
 
   - `Prometheus Connector <admin/prometheus_connector.rst>`_
 
-  - `Cross Cluster Search <admin/cross_cluster_search.rst>`_
+  - `Cross-Cluster Search <admin/cross_cluster_search.rst>`_
 
 * **Commands**