Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create documentation for cross-cluster search #12585

Closed
tylersmalley opened this issue Jun 30, 2017 · 8 comments
Closed

Create documentation for cross-cluster search #12585

tylersmalley opened this issue Jun 30, 2017 · 8 comments
Labels
PR sent Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Team:Docs v5.5.0

Comments

@tylersmalley
Copy link
Contributor

Original PR: #11114
Elasticsearch Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html

@tbragin
Copy link
Contributor

tbragin commented Jun 30, 2017

Agreed, it would be useful to add some information on how to configure Kibana to take advantage of the new cross-cluster support in 5.5.

I would assume it would live somewhere in this section:
https://www.elastic.co/guide/en/kibana/5.5/tribe.html

Perhaps we can base it on an example such as this
screen shot 2017-06-29 at 5 18 48 pm

screen shot 2017-06-29 at 5 18 54 pm

@alexfrancoeur alexfrancoeur added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v5.5.0 labels Jun 30, 2017
@alexfrancoeur
Copy link

@tbragin @tylersmalley I think having it's own page makes sense. It would be nice to reference with a URL pointing to the new Cross Cluster Search page in both the index pattern management docs as well as the console docs.

I added a 5.5 label as I think it makes sense to introduce this documentation with the release. As I understand it, documentation updates are not necessarily tied to a release - this is more of a forcing function to get them in as soon as possible.

@alexfrancoeur
Copy link

@epixa @spalger is there any chance we can get some Kibana documentation on CCS for the 5.5 release?

@tbragin
Copy link
Contributor

tbragin commented Jun 30, 2017

We should also mark it "beta" if Elasticsearch keeps their "beta" label for cross-cluster search in 5.5: https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-cross-cluster-search.html

@epixa
Copy link
Contributor

epixa commented Jun 30, 2017

@alexfrancoeur I'm not sure why we'd specifically call out cross cluster search in the console docs since we don't call out any other Elasticsearch APIs in particular. I don't think the console docs should start regurgitating Elasticsearch API documentation.

@alexfrancoeur
Copy link

alexfrancoeur commented Jun 30, 2017

@epixa I wasn't thinking about API's here. A lot of customers have requested support for tribe in console to make requests across multiple clusters. Given the fact that CCS addresses this, I thought it would be nice to have a note that Console now supports multiple clusters with CCS.

@epixa
Copy link
Contributor

epixa commented Jun 30, 2017

@alexfrancoeur I hear that, but I think the right approach here is highlighting that distinction from the tribe docs itself, since this is a sort of special case for folks that have already experienced the pains of tribe in Kibana.

@epixa
Copy link
Contributor

epixa commented Jun 30, 2017

@spalger I assigned #12599 to you for review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR sent Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Team:Docs v5.5.0
Projects
None yet
Development

No branches or pull requests

4 participants