Add administrator docs for cross-project search#5245
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
✅ Vale Linting ResultsNo issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
|
@naj-h @alisonelizabeth I don't expect you to have time to review these this week! 🙃 But here are the CPS administrator docs, if/when you do get a chance to review them. |
deploy-manage/cross-project-search-config/cps-config-access-and-scope.md
Outdated
Show resolved
Hide resolved
deploy-manage/cross-project-search-config/cps-config-access-and-scope.md
Outdated
Show resolved
Hide resolved
deploy-manage/cross-project-search-config/cps-config-access-and-scope.md
Show resolved
Hide resolved
deploy-manage/cross-project-search-config/cps-config-access-and-scope.md
Outdated
Show resolved
Hide resolved
deploy-manage/cross-project-search-config/cps-config-impacts-and-limitations.md
Outdated
Show resolved
Hide resolved
|
@marciw sorry for jumping the gun! Just realized that this is not ready for TW review. I'll come back later |
Co-authored-by: wajihaparvez <wajiha.parvez@elastic.co>
|
|
||
| To configure {{cps}}, make sure you meet these prerequisites: | ||
|
|
||
| - You must be an organization owner or project administrator. |
There was a problem hiding this comment.
We could add here that, to link projects together, you are expected to be either an organization owner, or a project administrator in the origin and all projects you plan to link to it
| @@ -0,0 +1,3 @@ | |||
| After you link projects, searches from the origin project run across the origin and all linked projects by default. | |||
| This default behavior provides a consistent experience for querying, analysis, and insights across linked projects. | |||
| Restricting search scope is always possible, by explicitly scoping the search request using [qualified expressions](/explore-analyze/cross-project-search/cross-project-search-search.md#search-expressions), the `_origin` identifier, or [routing parameters](/explore-analyze/cross-project-search/cross-project-search-project-routing.md). | |||
There was a problem hiding this comment.
| Restricting search scope is always possible, by explicitly scoping the search request using [qualified expressions](/explore-analyze/cross-project-search/cross-project-search-search.md#search-expressions), the `_origin` identifier, or [routing parameters](/explore-analyze/cross-project-search/cross-project-search-project-routing.md). | |
| Restricting search scope is always possible, by explicitly scoping the search request using [qualified expressions](/explore-analyze/cross-project-search/cross-project-search-search.md#search-expressions) or [project routing parameters](/explore-analyze/cross-project-search/cross-project-search-project-routing.md). |
There was a problem hiding this comment.
reason: the _origin identifier can be used either in qualified expressions or in project routing
There was a problem hiding this comment.
fixed in c1cc444
cc @szabosteve because this is an E&A snippet
|
|
||
| ::::{important} | ||
| :applies_to: serverless: preview | ||
| **Origin projects must be new**: During technical preview, only newly created projects can be origin projects for {{cps}}. Existing projects can be _linked_ to an origin project, but they can't serve as origin projects themselves. To get started, create a new {{serverless-short}} project and link it to your existing projects. |
There was a problem hiding this comment.
| **Origin projects must be new**: During technical preview, only newly created projects can be origin projects for {{cps}}. Existing projects can be _linked_ to an origin project, but they can't serve as origin projects themselves. To get started, create a new {{serverless-short}} project and link it to your existing projects. | |
| **Origin projects must be new**: During technical preview, only newly created projects can be origin projects for {{cps}}. Existing projects can be _linked_ by an origin project, but they can't serve as origin projects themselves. To get started, create a new {{serverless-short}} project and link it to your existing projects. |
There was a problem hiding this comment.
fixed in c1cc444 (but I went with "from" instead of "by")
|
|
||
| - {{es}} projects require the **Serverless Plus** add-on. | ||
| - {{sec-serverless}} and {{obs-serverless}} projects require the **Complete** feature tier. Projects on the **Essentials** tier are not compatible with {{cps}}. | ||
| - Workplace AI projects are not compatible with {{cps}}. |
There was a problem hiding this comment.
to be removed because Workplace AI projects are not released and will not be released when CPS is out
|
|
||
| You can link any combination of {{product.elasticsearch}}, {{product.observability}}, and {{product.security}} projects, with the following requirements and limitations: | ||
|
|
||
| - {{es}} projects require the **Serverless Plus** add-on. |
There was a problem hiding this comment.
there is no limitation in TP for ES3 projects. Serverless Plus is also still being discussed, so let's remove this until there's more clarity
| @@ -0,0 +1,12 @@ | |||
|
|
|||
| - **Maximum of 20 linked projects:** Each origin project can have up to 20 linked projects. A linked project can be associated with any number of origin projects. | |||
| - **Chaining/transitivity not supported:** If Project A links to Project B, and Project B links to Project C, Project A cannot automatically search Project C. Each link is independent. | |||
There was a problem hiding this comment.
this is a design choice, not a limitation per se. Not sure where to call it out.
There was a problem hiding this comment.
fixed in c1cc444; moved to new "How linking works" subsection in the Link and manage topic
|
|
||
| - **Maximum of 20 linked projects:** Each origin project can have up to 20 linked projects. A linked project can be associated with any number of origin projects. | ||
| - **Chaining/transitivity not supported:** If Project A links to Project B, and Project B links to Project C, Project A cannot automatically search Project C. Each link is independent. | ||
| - **Links are unidirectional:** Searches that run from a linked project do **not** run against the origin project. If you need bidirectional search, link the projects twice, in both directions. |
There was a problem hiding this comment.
this is a design choice, not a limitation per se. Not sure where to call it out.
There was a problem hiding this comment.
fixed in c1cc444 (moved to the the Link and manage page)
| - **Maximum of 20 linked projects:** Each origin project can have up to 20 linked projects. A linked project can be associated with any number of origin projects. | ||
| - **Chaining/transitivity not supported:** If Project A links to Project B, and Project B links to Project C, Project A cannot automatically search Project C. Each link is independent. | ||
| - **Links are unidirectional:** Searches that run from a linked project do **not** run against the origin project. If you need bidirectional search, link the projects twice, in both directions. | ||
| - **System indices are excluded:** System indices (such as `.security` and `.fleet-*`) are excluded from {{cps}}. |
There was a problem hiding this comment.
this is a design choice, not a limitation per se. Not sure where to call it out.
| - **Links are unidirectional:** Searches that run from a linked project do **not** run against the origin project. If you need bidirectional search, link the projects twice, in both directions. | ||
| - **System indices are excluded:** System indices (such as `.security` and `.fleet-*`) are excluded from {{cps}}. | ||
| - **Unavailable APIs:** `_transform` and `_fleet_search` requests do not support {{cps-init}}. | ||
| - **Workplace AI projects:** Workplace AI projects are not compatible with {{cps}}. |
There was a problem hiding this comment.
Workplace AI projects are not released in Serverless and have been deprioritized according to the latest info to date. Let's remove this
| - **Chaining/transitivity not supported:** If Project A links to Project B, and Project B links to Project C, Project A cannot automatically search Project C. Each link is independent. | ||
| - **Links are unidirectional:** Searches that run from a linked project do **not** run against the origin project. If you need bidirectional search, link the projects twice, in both directions. | ||
| - **System indices are excluded:** System indices (such as `.security` and `.fleet-*`) are excluded from {{cps}}. | ||
| - **Unavailable APIs:** `_transform` and `_fleet_search` requests do not support {{cps-init}}. |
There was a problem hiding this comment.
Let's remove this. Reason: The fleet search API is mostly an internal API that's used to search local/individual indices. Transform is already called out below in the ML and transforms bullet point
|
thanks for the write-up @marciw ! left comments in there, would be happy to review again afterwards |
Thanks @naj-h for all the improvements! I think I've addressed all your comments, whenever you have time to review again. All the previews still work and show the changes, so you can keep using those. PS: This PR won't actually be merged because we're working in a feature branch with combined writer updates (see #5498 -- not asking you to review that one yet though; we'll run it by you soon) |
|
closing this in favor of #5498 -- all changes have been applied to that branch |
Status
🟢 ready for SME/technical review
🚧 not ready for tech writer review
Summary
Fixes https://github.com/elastic/docs-content-internal/issues/30
Adds a CPS config topic under Deploy & manage. For more details, see the docs plan Gdoc
New pages:
🛑 Do not review the explore & analyze changes
they are for staging purposes only
What's next
Generative AI disclosure
Tool(s) and model(s) used:
Cursor auto, Claude Opus 4.6, gpt-5.3-codex