search

opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
72 stars 474 forks source link

[DOC] Cross Cluster Search isn't covered by docs #4784

Open Yury-Fridlyand opened 1 year ago

Yury-Fridlyand commented 1 year ago

What do you want to do?

Tell us about your request. Provide a summary of the request and all versions that are affected.

Cross Cluster Search (CCS) isn't covered by docs. It should include:

  1. How to configure remote clusters
  2. How to verify connection and configuration
  3. How to make a CCS query
  4. Limitations
  5. etc

It is mentioned in PPL/Observability and slightly covered by security plugin doc, but it mostly covers how to configure permissions, rather how to configure remotes/CCS.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

hdhalter commented 10 months ago

Thanks for entering this issue, @Yury-Fridlyand ! Would you mind taking a crack at the initial documentation? It looks like some of it is covered here (https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/admin/cross_cluster_search.rst) but would be great to get complete coverage, as you say.

hdhalter commented 10 months ago

@praveensameneni - Do you know who might be able to support us with this update? Thanks!

hdhalter commented 6 months ago

Hi @ankitkala - We've made some changes to the cross-cluster search topic recently, and I came across this open PR on it. We moved the topic under the "Search" category, but didn't address the above items. We only addressed some feedback that we received from the community.

Do you want to provide some details that we can add to this topic after we merge these initial changes? https://github.com/opensearch-project/documentation-website/pull/6657. Thanks in advance.

ankitkala commented 6 months ago

How to configure remote clusters

https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/getting-started/#set-up-a-cross-cluster-connection

Do you want to provide some details that we can add to this topic after we merge these initial changes?

I don't have a good reference to share around this. Let me collect the data and update here.