-
Notifications
You must be signed in to change notification settings - Fork 163
[ES3] Consolidate tech preview limitations + serverless differences, … #194
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
Merged
Merged
Changes from 11 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
b808166
[ES3] Consolidate tech preview limitations + serverless differences, …
leemthompo b2dbceb
Add back front matter
leemthompo a0534e1
Use attributes
leemthompo f4cb76a
More attribute substitutions
leemthompo df71b52
Remove workloads info
leemthompo d2db2a4
Updates per Yaru
leemthompo 954a542
Merge branch 'main' into dedupe
leemthompo 4cd0e06
Add link to landing page
leemthompo 39002ab
Clarify first subheading
leemthompo d1cb2de
I thought I already deleted that
leemthompo 0b24e06
Delete period
leemthompo fe1fbb0
Apply suggestions from code reviewEdits per review
leemthompo 8ae2105
Apply suggestions from code review
leemthompo aa5f6c9
Further refinements per Shaina's review
leemthompo 9a690f6
Link earlier
leemthompo 2e8e122
Merge branch 'main' into dedupe
leemthompo 2244337
Delete whitespace
leemthompo 815b8b1
Add alerts link
leemthompo ca27163
Update serverless/pages/serverless-differences.asciidoc
shainaraskas e4d70bf
Conflicts
leemthompo 5ab476e
Clarify tech preview page is no longer in nav and will be redirected
leemthompo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,108 @@ | ||
[[elasticsearch-differences]] | ||
= Differences from other {es} offerings | ||
++++ | ||
<titleabbrev>Serverless differences</titleabbrev> | ||
++++ | ||
|
||
// :description: Understand how {es-serverless} differs from Elastic Cloud Hosted and self-managed offerings. | ||
// :keywords: serverless, elasticsearch | ||
|
||
++++ | ||
<titleabbrev>Serverless differences</titleabbrev> | ||
++++ | ||
<<what-is-elasticsearch-serverless,{es-serverless}>> abstracts away infrastructure management from users, providing a fully managed {es} service. | ||
|
||
If you've used {es} before, you'll notice some differences in how you work with the service on serverless, because a number of APIs and settings are not required for serverless projects. | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
This guide helps you understand what's different, what's available, and how to work effectively when running {es} on {serverless-full}. | ||
|
||
[discrete] | ||
[[elasticsearch-differences-serverless-infrastructure-management]] | ||
== Fully managed infrastructure | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. vv helpful section |
||
|
||
{es-serverless} manages all infrastructure automatically, including: | ||
|
||
* Cluster scaling and optimization | ||
* Node management and allocation | ||
* Shard distribution and replication | ||
* Resource utilization and monitoring | ||
|
||
This fully managed approach means many traditional {es} infrastructure APIs and settings are not available to end users, as detailed in the following sections. | ||
|
||
[discrete] | ||
[[elasticsearch-differences-serverless-aps-settings]] | ||
== APIs and settings | ||
|
||
Because {es-serverless} manages infrastructure automatically, certain APIs and settings are not available, while others remain fully accessible. | ||
|
||
[TIP] | ||
==== | ||
Refer to the {es-serverless} https://www.elastic.co/docs/api/[API Reference] for a complete list of available APIs. | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
==== | ||
|
||
[discrete] | ||
[[elasticsearch-differences-serverless-api-availability]] | ||
=== API availability | ||
|
||
The following categories of operations are *unavailable* since they are managed by the serverless platform: | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Infrastructure operations:: | ||
* All `_nodes/*` operations | ||
* All `_cluster/*` operations | ||
* Most `_cat/*` operations, except for index-related operations such as `/_cat/indices` and `/_cat/aliases` | ||
|
||
Storage and backup:: | ||
* All `_snapshot/*` operations | ||
* Repository management operations | ||
|
||
preview:[] | ||
Index management:: | ||
* `indices/close` operations | ||
* `indices/open` operations | ||
* Recovery and stats operations | ||
* Force merge operations | ||
|
||
[discrete] | ||
[[elasticsearch-differences-serverless-settings-availability]] | ||
=== Settings availability | ||
|
||
In {es-serverless}, you can only configure index-level settings. | ||
Cluster-level settings and node-level settings are not required by end users and the `elasticsearch.yml` file is fully managed by Elastic. | ||
|
||
Available settings:: | ||
* *Index-level settings*. Settings that control how {es} documents are processed, stored, and searched are available to end users, including: | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
** Analysis configuration | ||
** Mapping parameters | ||
** Search/query settings | ||
** Indexing settings such as `refresh_interval` | ||
|
||
Managed settings:: | ||
* *Infrastructure-related settings*. Settings that affect cluster resources or data distribution are not available to end users, including: | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
** Node configurations | ||
** Cluster topology | ||
** Shard allocation | ||
** Resource management | ||
|
||
[discrete] | ||
[[elasticsearch-differences-serverless-api-errors]] | ||
=== API error handling | ||
|
||
When attempting to use an unavailable API or setting, you'll receive a clear error message: | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
[source,json] | ||
---- | ||
{ | ||
"error": { | ||
"root_cause": [ | ||
{ | ||
"type": "api_not_available_exception", | ||
"reason": "Request for uri [/<API_ENDPOINT>] with method [<METHOD>] exists but is not available when running in serverless mode" | ||
} | ||
], | ||
"status": 410 | ||
} | ||
} | ||
---- | ||
|
||
[discrete] | ||
[[elasticsearch-differences-serverless-feature-categories]] | ||
== Feature availability | ||
|
||
Some features that are available in Elastic Cloud Hosted and self-managed offerings are not available in {es-serverless}. | ||
These features have either been replaced by a new feature, or are not applicable in the new Serverless architecture: | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
@@ -26,17 +120,37 @@ hardware-centric concepts like data tiers. | |
+ | ||
Kibana Alerts allows rich integrations across use cases like APM, metrics, security, and uptime. Prepackaged rule types simplify setup and | ||
hide the details of complex, domain-specific detections, while providing a consistent interface across Kibana. | ||
+ | ||
* Certain APIs, API parameters, index, cluster and node level settings are not available. Refer to our | ||
<<elasticsearch-http-apis,REST API references>> for a list of available APIs. | ||
+ | ||
{es-serverless} manages the underlying Elastic cluster for you, optimizing nodes, shards, and replicas for your use case. | ||
Because of this, various management and monitoring APIs, API parameters and settings are not available on Serverless. | ||
+ | ||
* {ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Scripted metric aggregations] are not available. | ||
|
||
.Other limitations | ||
[IMPORTANT] | ||
==== | ||
For serverless technical preview limitations, refer to <<elasticsearch-technical-preview-limitations,Technical preview limitations>>. | ||
==== | ||
[discrete] | ||
[[elasticsearch-differences-serverless-feature-planned]] | ||
=== Planned features | ||
|
||
The following features are planned for future support in all {serverless-full} projects: | ||
|
||
* Reindexing from remote clusters | ||
* Cross-project search and replication | ||
* Snapshot and restore | ||
* Migrations from non-serverless deployments | ||
* Audit logging | ||
* Authentication realms (native/SAML/OIDC/Kerberos/JWT) | ||
* Clone index API | ||
* Traffic filtering and VPCs | ||
|
||
The following _{es-serverless}_ project-specific features are planned for future support: | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
* {ref}/behavioral-analytics-overview.html[Behavioral Analytics] | ||
* {ref}/search-application-overview.html[Search Applications] | ||
* {enterprise-search-ref}/crawler.html[Managed web crawler] | ||
** You can use the https://github.com/elastic/crawler[self-managed web crawler] in the meantime. | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
* {ref}/es-native-connectors.html[Elastic managed Search connectors] | ||
** You can use the {ref}/es-build-connector.html[self-managed Search connectors] in the meantime. | ||
leemthompo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
[discrete] | ||
[[elasticsearch-differences-serverless-feature-unavailable]] | ||
=== Unplanned features | ||
|
||
The following features are not available in {es-serverless} and are not planned for future support: | ||
|
||
* https://www.elastic.co/guide/en/cloud/current/ec-custom-bundles.html[Custom plugins and bundles] | ||
* https://www.elastic.co/guide/en/elasticsearch/hadoop/current/reference.html[{es} for Apache Hadoop] | ||
* {ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Scripted metric aggregations] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.