Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions serverless/index-serverless-elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
++++

include::./pages/what-is-elasticsearch-serverless.asciidoc[leveloffset=+2]
include::./pages/serverless-differences.asciidoc[leveloffset=+2]

include::./pages/pricing.asciidoc[leveloffset=+2]

Expand Down Expand Up @@ -46,8 +47,4 @@ include::./pages/explore-your-data-discover-your-data.asciidoc[leveloffset=+3]
include::./pages/explore-your-data-visualize-your-data.asciidoc[leveloffset=+3]
include::./pages/explore-your-data-alerting.asciidoc[leveloffset=+3]

include::./pages/search-playground.asciidoc[leveloffset=+2]

include::./pages/serverless-differences.asciidoc[leveloffset=+2]

include::./pages/technical-preview-limitations.asciidoc[leveloffset=+2]
include::./pages/search-playground.asciidoc[leveloffset=+2]
148 changes: 131 additions & 17 deletions serverless/pages/serverless-differences.asciidoc
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.

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
Copy link
Collaborator

Choose a reason for hiding this comment

The 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.
====

[discrete]
[[elasticsearch-differences-serverless-api-availability]]
=== API availability

The following categories of operations are *unavailable* since they are managed by the serverless platform:

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:
** 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:
** 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:

[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:
Expand All @@ -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:

* {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.
* {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.

[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]
6 changes: 0 additions & 6 deletions serverless/pages/what-is-elasticsearch-serverless.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ preview:[]

{es} allows you to build custom applications. Whether you have structured or unstructured text, numerical data, or geospatial data, {es} can efficiently store and index it in a way that supports fast searches.

.Understanding {es-serverless}
[IMPORTANT]
====
Refer to <<elasticsearch-differences,Serverless differences>> and <<elasticsearch-technical-preview-limitations,Technical preview limitations>> for important details, including features and limitations specific to {es-serverless}.
====

[discrete]
== Get started

Expand Down