From 2900fb3a371037c43d19f6591bbb48cd8239d143 Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Mon, 18 Nov 2024 09:16:58 +0100 Subject: [PATCH] Update variables, cleanup, remove `{es}` override (#196) --- .../index-serverless-elasticsearch.asciidoc | 4 +- serverless/index.asciidoc | 1 - serverless/pages/action-connectors.asciidoc | 4 +- .../apis-elasticsearch-conventions.asciidoc | 6 +- serverless/pages/apis-http-apis.asciidoc | 2 +- .../clients-dot-net-getting-started.asciidoc | 4 +- .../pages/clients-go-getting-started.asciidoc | 6 +- .../clients-java-getting-started.asciidoc | 4 +- .../clients-nodejs-getting-started.asciidoc | 4 +- .../clients-php-getting-started.asciidoc | 4 +- .../clients-python-getting-started.asciidoc | 6 +- .../clients-ruby-getting-started.asciidoc | 10 +- serverless/pages/clients.asciidoc | 2 +- .../developer-tools-troubleshooting.asciidoc | 8 +- .../elasticsearch-developer-tools.asciidoc | 4 +- .../pages/explore-your-data-alerting.asciidoc | 2 +- ...lore-your-data-discover-your-data.asciidoc | 2 +- ...xplore-your-data-ml-nlp-model-ref.asciidoc | 2 +- .../pages/explore-your-data-ml-nlp.asciidoc | 2 +- ...re-your-data-the-aggregations-api.asciidoc | 2 +- ...ore-your-data-visualize-your-data.asciidoc | 2 +- serverless/pages/explore-your-data.asciidoc | 2 +- serverless/pages/get-started.asciidoc | 22 +-- serverless/pages/ingest-pipelines.asciidoc | 2 +- ...t-data-through-integrations-beats.asciidoc | 4 +- ...ugh-integrations-connector-client.asciidoc | 6 +- ...ata-through-integrations-logstash.asciidoc | 10 +- serverless/pages/ingest-your-data.asciidoc | 2 +- .../manage-billing-monitor-usage.asciidoc | 4 +- .../manage-your-project-rest-api.asciidoc | 4 +- serverless/pages/manage-your-project.asciidoc | 4 +- serverless/pages/ml-nlp-auto-scale.asciidoc | 4 +- serverless/pages/pricing.asciidoc | 22 +-- .../project-and-management-settings.asciidoc | 2 +- serverless/pages/project-settings.asciidoc | 2 +- .../run-api-requests-in-the-console.asciidoc | 6 +- serverless/pages/search-playground.asciidoc | 2 +- ...h-your-data-semantic-search-elser.asciidoc | 2 +- .../pages/serverless-differences.asciidoc | 10 +- serverless/pages/sign-up.asciidoc | 10 +- .../technical-preview-limitations.asciidoc | 4 +- .../what-is-elasticsearch-serverless.asciidoc | 12 +- serverless/pages/what-is-serverless.asciidoc | 137 ++++++++++++++++++ .../partials/minimum-vcus-detail.asciidoc | 4 +- 44 files changed, 247 insertions(+), 111 deletions(-) create mode 100644 serverless/pages/what-is-serverless.asciidoc diff --git a/serverless/index-serverless-elasticsearch.asciidoc b/serverless/index-serverless-elasticsearch.asciidoc index e0165177..b1066d4e 100644 --- a/serverless/index-serverless-elasticsearch.asciidoc +++ b/serverless/index-serverless-elasticsearch.asciidoc @@ -1,8 +1,8 @@ [[what-is-elasticsearch-serverless]] -== Elasticsearch +== {es} ++++ -Elasticsearch +{es} ++++ include::./pages/what-is-elasticsearch-serverless.asciidoc[leveloffset=+2] diff --git a/serverless/index.asciidoc b/serverless/index.asciidoc index 63387cff..6c272995 100644 --- a/serverless/index.asciidoc +++ b/serverless/index.asciidoc @@ -11,7 +11,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :sec-badge: <> // The values of these attributes are different in stateful vs serverless -:es: Elasticsearch Serverless :observability: Elastic Observability Serverless :security: Elastic Security Serverless diff --git a/serverless/pages/action-connectors.asciidoc b/serverless/pages/action-connectors.asciidoc index 4c8d8d8a..704627a6 100644 --- a/serverless/pages/action-connectors.asciidoc +++ b/serverless/pages/action-connectors.asciidoc @@ -17,7 +17,7 @@ The list of available connectors varies by project type. * {kibana-ref}/email-action-type.html[*Email*^]: Send email from your server. * {kibana-ref}/gemini-action-type.html[*Google Gemini*^]: Send a request to Google Gemini. * {kibana-ref}/resilient-action-type.html[*IBM Resilient*^]: Create an incident in IBM Resilient. -* {kibana-ref}/index-action-type.html[*Index*^]: Index data into Elasticsearch. +* {kibana-ref}/index-action-type.html[*Index*^]: Index data into {es}. * {kibana-ref}/jira-action-type.html[*Jira*^]: Create an incident in Jira. * {kibana-ref}/teams-action-type.html[*Microsoft Teams*^]: Send a message to a Microsoft Teams channel. * {kibana-ref}/obs-ai-assistant-action-type.html[*Observability AI Assistant*^]: Add AI-driven insights and custom actions to your workflow. @@ -75,7 +75,7 @@ Actions are instantiations of a connector that are linked to rules and run as ba |---|---| | Email | Send email from your server. | | {ibm-r} | Create an incident in {ibm-r}. | -| Index | Index data into Elasticsearch. | +| Index | Index data into {es}. | | Jira | Create an incident in Jira. | | Microsoft Teams | Send a message to a Microsoft Teams channel. | | Opsgenie | Create or close an alert in Opsgenie. | diff --git a/serverless/pages/apis-elasticsearch-conventions.asciidoc b/serverless/pages/apis-elasticsearch-conventions.asciidoc index 91287b54..c23a9cca 100644 --- a/serverless/pages/apis-elasticsearch-conventions.asciidoc +++ b/serverless/pages/apis-elasticsearch-conventions.asciidoc @@ -1,7 +1,7 @@ [[elasticsearch-api-conventions]] -= Elasticsearch API conventions += {es} API conventions -// :description: The {es} REST APIs have conventions for headers and request bodies. +// :description: The {es-serverless} REST APIs have conventions for headers and request bodies. // :keywords: serverless, elasticsearch, API, reference preview:[] @@ -37,7 +37,7 @@ curl -X GET "${ES_URL}/_cat/indices?v=true" \ -H "Authorization: ApiKey ${API_KEY}" ---- -To get API keys or the Elasticsearch Endpoint (`${ES_URL}`) for a project, refer to <>. +To get API keys for the {es} endpoint (`${ES_URL}`) for a project, refer to <>. [discrete] [[elasticsearch-api-conventions-content-type]] diff --git a/serverless/pages/apis-http-apis.asciidoc b/serverless/pages/apis-http-apis.asciidoc index d60e8eda..937744c0 100644 --- a/serverless/pages/apis-http-apis.asciidoc +++ b/serverless/pages/apis-http-apis.asciidoc @@ -6,6 +6,6 @@ preview:[] -* <>: The {es} REST APIs have conventions for headers and request bodies. +* <>: The {es-serverless} REST APIs have conventions for headers and request bodies. * <>: The Management APIs for {serverless-short} have request header conventions. * https://www.elastic.co/docs/api/[API Reference]: Explore the reference information for Elastic Serverless REST APIs diff --git a/serverless/pages/clients-dot-net-getting-started.asciidoc b/serverless/pages/clients-dot-net-getting-started.asciidoc index 18f02162..929efc65 100644 --- a/serverless/pages/clients-dot-net-getting-started.asciidoc +++ b/serverless/pages/clients-dot-net-getting-started.asciidoc @@ -31,14 +31,14 @@ dotnet add package Elastic.Clients.Elasticsearch.Serverless [[elasticsearch-dot-net-client-getting-started-initialize-the-client]] == Initialize the client -Initialize the client using your API key and Elasticsearch Endpoint: +Initialize the client using your API key and {es} endpoint: [source,net] ---- var client = new ElasticsearchClient("", new ApiKey("")); ---- -To get API keys or the Elasticsearch Endpoint for a project, see <>. +To get API keys for the {es} endpoint for a project, see <>. [discrete] [[elasticsearch-dot-net-client-getting-started-using-the-api]] diff --git a/serverless/pages/clients-go-getting-started.asciidoc b/serverless/pages/clients-go-getting-started.asciidoc index b3612da1..c9c42e48 100644 --- a/serverless/pages/clients-go-getting-started.asciidoc +++ b/serverless/pages/clients-go-getting-started.asciidoc @@ -57,7 +57,7 @@ import ( [[elasticsearch-go-client-getting-started-initialize-the-client]] == Initialize the client -Initialize the client using your API key and Elasticsearch Endpoint: +Initialize the client using your API key and {es} endpoint: [source,go] ---- @@ -70,7 +70,7 @@ if err != nil { } ---- -To get API keys or the Elasticsearch Endpoint for a project, see <>. +To get API keys for the {es} endpoint for a project, see <>. [discrete] [[elasticsearch-go-client-getting-started-using-the-api]] @@ -125,7 +125,7 @@ if err != nil { fmt.Printf("Bulk: %#v\n", bulkRes.Items) ---- -When you use the client to make a request to {es}, it returns an API +When you use the client to make a request to {es-serverless}, it returns an API response object. You can access the body values directly as seen on the previous example with `bulkRes`. diff --git a/serverless/pages/clients-java-getting-started.asciidoc b/serverless/pages/clients-java-getting-started.asciidoc index 81ad5abc..7991aa02 100644 --- a/serverless/pages/clients-java-getting-started.asciidoc +++ b/serverless/pages/clients-java-getting-started.asciidoc @@ -72,7 +72,7 @@ the following to the `pom.xml` of your project: [[elasticsearch-java-client-getting-started-initialize-the-client]] == Initialize the client -Initialize the client using your API key and Elasticsearch Endpoint: +Initialize the client using your API key and {es} endpoint: [source,java] ---- @@ -96,7 +96,7 @@ ElasticsearchTransport transport = new RestClientTransport( ElasticsearchClient esClient = new ElasticsearchClient(transport); ---- -To get API keys or the Elasticsearch Endpoint for a project, see <>. +To get API keys for the {es} endpoint for a project, see <>. [discrete] [[elasticsearch-java-client-getting-started-using-the-api]] diff --git a/serverless/pages/clients-nodejs-getting-started.asciidoc b/serverless/pages/clients-nodejs-getting-started.asciidoc index 61edade9..c275c626 100644 --- a/serverless/pages/clients-nodejs-getting-started.asciidoc +++ b/serverless/pages/clients-nodejs-getting-started.asciidoc @@ -36,7 +36,7 @@ npm install @elastic/elasticsearch-serverless [[elasticsearch-nodejs-client-getting-started-initialize-the-client]] == Initialize the client -Initialize the client using your API key and Elasticsearch Endpoint: +Initialize the client using your API key and {es} endpoint: [source,js] ---- @@ -47,7 +47,7 @@ const client = new Client({ }) ---- -To get API keys or the URL for a project, see <>. +To get API keys for the URL for a project, see <>. [discrete] [[elasticsearch-nodejs-client-getting-started-using-the-api]] diff --git a/serverless/pages/clients-php-getting-started.asciidoc b/serverless/pages/clients-php-getting-started.asciidoc index 2821f30a..72815417 100644 --- a/serverless/pages/clients-php-getting-started.asciidoc +++ b/serverless/pages/clients-php-getting-started.asciidoc @@ -36,7 +36,7 @@ composer require elastic/elasticsearch-serverless [[elasticsearch-php-client-getting-started-initialize-the-client]] == Initialize the client -Initialize the client using your API key and Elasticsearch Endpoint: +Initialize the client using your API key and {es} endpoint: [source,php] ---- @@ -50,7 +50,7 @@ $client = ClientBuilder::create() ->build(); ---- -To get API keys or the Elasticsearch Endpoint for a project, see <>. +To get API keys for the {es} endpoint for a project, see <>. [discrete] [[elasticsearch-php-client-getting-started-using-the-api]] diff --git a/serverless/pages/clients-python-getting-started.asciidoc b/serverless/pages/clients-python-getting-started.asciidoc index 8799db8f..f7cac1d9 100644 --- a/serverless/pages/clients-python-getting-started.asciidoc +++ b/serverless/pages/clients-python-getting-started.asciidoc @@ -43,19 +43,19 @@ python -m pip install elasticsearch-serverless [[elasticsearch-python-client-getting-started-initialize-the-client]] == Initialize the client -Initialize the client using your API key and Elasticsearch Endpoint: +Initialize the client using your API key and {es} endpoint: [source,python] ---- from elasticsearch_serverless import Elasticsearch client = Elasticsearch( - "https://...", # Your project's Elasticsearch Endpoint + "https://...", # Your project's Elasticsearch endpoint api_key='api-key', # API key for your project ) ---- -To get API keys or the Elasticsearch Endpoint for a project, see <>. +To get API keys for the {es} endpoint for a project, see <>. [discrete] [[elasticsearch-python-client-getting-started-using-the-api]] diff --git a/serverless/pages/clients-ruby-getting-started.asciidoc b/serverless/pages/clients-ruby-getting-started.asciidoc index c35f38f8..b800c220 100644 --- a/serverless/pages/clients-ruby-getting-started.asciidoc +++ b/serverless/pages/clients-ruby-getting-started.asciidoc @@ -8,14 +8,14 @@ preview:[] This page guides you through the installation process Ruby client for {es3}, shows you how to initialize the client, and how to perform basic -{es} operations with it. +{es-serverless} operations with it. [discrete] [[elasticsearch-ruby-client-getting-started-requirements]] == Requirements * Ruby 3.0 or higher installed on your system. -* To use the `elasticsearch-serverless` gem, you must have an API key and Elasticsearch Endpoint for an {es3} project. +* To use the `elasticsearch-serverless` gem, you must have an API key and {es} endpoint for an {es3} project. [discrete] [[elasticsearch-ruby-client-getting-started-installation]] @@ -87,7 +87,7 @@ bundle exec rake console [[elasticsearch-ruby-client-getting-started-initialize-the-client]] == Initialize the client -Initialize the client using your API key and Elasticsearch Endpoint: +Initialize the client using your API key and {es} endpoint: [source,ruby] ---- @@ -97,7 +97,7 @@ client = ElasticsearchServerless::Client.new( ) ---- -To get API keys or the Elasticsearch Endpoint for a project, see <>. +To get API keys for the {es} endpoint for a project, see <>. [discrete] [[elasticsearch-ruby-client-getting-started-using-the-api]] @@ -147,7 +147,7 @@ index: # {"index"=>{"_index"=>"books", "_id"=>"Qtink4cBmDx329iqhzM2", "_version"=>1, "result"=>"created", "_shards"=>{"total"=>2, "successful"=>1, "failed"=>0}, "_seq_no"=>5, "_primary_term"=>1, "status"=>201}}] ---- -When you use the client to make a request to Elasticsearch, it returns an API +When you use the client to make a request to {es}, it returns an API response object. You can check the HTTP return code by calling `status` and the HTTP headers by calling `headers` on the response object. The response object also behaves as a Hash, so you can access the body values directly as seen on diff --git a/serverless/pages/clients.asciidoc b/serverless/pages/clients.asciidoc index 8f26ec9f..2338e88c 100644 --- a/serverless/pages/clients.asciidoc +++ b/serverless/pages/clients.asciidoc @@ -6,7 +6,7 @@ preview:[] -{es3} provides official language clients to use {es} REST APIs. +{es3} provides official language clients to use {es-serverless} REST APIs. Currently, the following language clients are supported: * <> | https://github.com/elastic/elasticsearch-serverless-go[Repository] diff --git a/serverless/pages/developer-tools-troubleshooting.asciidoc b/serverless/pages/developer-tools-troubleshooting.asciidoc index fea419dd..92b5f3dc 100644 --- a/serverless/pages/developer-tools-troubleshooting.asciidoc +++ b/serverless/pages/developer-tools-troubleshooting.asciidoc @@ -6,7 +6,7 @@ preview:[] -When you query your data, Elasticsearch may return an error, no search results, +When you query your data, {es} may return an error, no search results, or results in an unexpected order. This guide describes how to troubleshoot searches. @@ -14,7 +14,7 @@ searches. [[devtools-dev-tools-troubleshooting-ensure-the-data-stream-index-or-alias-exists]] == Ensure the data stream, index, or alias exists -Elasticsearch returns an `index_not_found_exception` when the data stream, index +{es} returns an `index_not_found_exception` when the data stream, index or alias you try to query does not exist. This can happen when you misspell the name or when the data has been indexed to a different data stream or index. @@ -221,12 +221,12 @@ GET /my-index-000001/_search?sort=@timestamp:desc&size=1 [[devtools-dev-tools-troubleshooting-validate-explain-and-profile-queries]] == Validate, explain, and profile queries -When a query returns unexpected results, Elasticsearch offers several tools to +When a query returns unexpected results, {es} offers several tools to investigate why. The https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-indices-validate-query[**Validate API**] enables you to validate a query. -Use the `rewrite` parameter to return the Lucene query an Elasticsearch query is +Use the `rewrite` parameter to return the Lucene query an {es} query is rewritten into: [source,js] diff --git a/serverless/pages/elasticsearch-developer-tools.asciidoc b/serverless/pages/elasticsearch-developer-tools.asciidoc index 1496cc21..76e8f23c 100644 --- a/serverless/pages/elasticsearch-developer-tools.asciidoc +++ b/serverless/pages/elasticsearch-developer-tools.asciidoc @@ -8,10 +8,10 @@ preview:[] A number of developer tools are available in your project's UI under the **Dev Tools** section. -* <>: Make API calls to your Elasticsearch instance using the Query DSL and view the responses. +* <>: Make API calls to your {es} instance using the Query DSL and view the responses. * <>: Inspect and analyze your search queries to identify performance bottlenecks. * <>: Build and debug grok patterns before you use them in your data processing pipelines. // ## Troubleshooting -// - : Debug your searches using various Elasticsearch APIs. +// - : Debug your searches using various {es} APIs. diff --git a/serverless/pages/explore-your-data-alerting.asciidoc b/serverless/pages/explore-your-data-alerting.asciidoc index d83297b4..12d2d230 100644 --- a/serverless/pages/explore-your-data-alerting.asciidoc +++ b/serverless/pages/explore-your-data-alerting.asciidoc @@ -42,7 +42,7 @@ When you click the **Create rule** button, it launches a flyout that guides you [role="screenshot"] image::images/alerting-overview.png[{rules-ui} app] -The rule types available in an {es} project are: +The rule types available in an {es-serverless} project are: * {kibana-ref}/rule-type-es-query.html[{es} query] * {kibana-ref}/rule-type-index-threshold.html[Index threshold] diff --git a/serverless/pages/explore-your-data-discover-your-data.asciidoc b/serverless/pages/explore-your-data-discover-your-data.asciidoc index bfa86933..cd86194b 100644 --- a/serverless/pages/explore-your-data-discover-your-data.asciidoc +++ b/serverless/pages/explore-your-data-discover-your-data.asciidoc @@ -52,7 +52,7 @@ image::images/create-data-view.png[Create a data view] . Click **Show advanced settings** to: + ** Display hidden and system indices. -** Specify your own data view name. For example, enter your Elasticsearch index alias name. +** Specify your own data view name. For example, enter your {es} index alias name. . Click **Save data view to {kib}**. . Adjust the time range to view data for the **Last 40 years** to view all your book data. + diff --git a/serverless/pages/explore-your-data-ml-nlp-model-ref.asciidoc b/serverless/pages/explore-your-data-ml-nlp-model-ref.asciidoc index 8eb65c1f..17a1099d 100644 --- a/serverless/pages/explore-your-data-ml-nlp-model-ref.asciidoc +++ b/serverless/pages/explore-your-data-ml-nlp-model-ref.asciidoc @@ -146,7 +146,7 @@ Using `DPREncoderWrapper`: == Expected model output Models used for each NLP task type must output tensors of a specific format to -be used in the Elasticsearch NLP pipelines. +be used in the {es} NLP pipelines. Here are the expected outputs for each task type. diff --git a/serverless/pages/explore-your-data-ml-nlp.asciidoc b/serverless/pages/explore-your-data-ml-nlp.asciidoc index 7d2ac257..d655cd41 100644 --- a/serverless/pages/explore-your-data-ml-nlp.asciidoc +++ b/serverless/pages/explore-your-data-ml-nlp.asciidoc @@ -22,7 +22,7 @@ WordPiece) and transformer models that conform to the standard BERT model interface. For the current list of supported architectures, refer to <>. -To incorporate transformer models and make predictions, {es} uses libtorch, +To incorporate transformer models and make predictions, {es-serverless} uses libtorch, which is an underlying native library for PyTorch. Trained models must be in a TorchScript representation for use with {stack} {ml} features. diff --git a/serverless/pages/explore-your-data-the-aggregations-api.asciidoc b/serverless/pages/explore-your-data-the-aggregations-api.asciidoc index 502994c0..7bd287c8 100644 --- a/serverless/pages/explore-your-data-the-aggregations-api.asciidoc +++ b/serverless/pages/explore-your-data-the-aggregations-api.asciidoc @@ -19,7 +19,7 @@ Aggregations help you answer questions like: * {ref}/search-aggregations-metrics.html[Metric] aggregations that calculate metrics, such as a sum or an average, from field values. Note that {ref}/search-aggregations-metrics-scripted-metric-aggregation.html[scripted metric aggregations] -are not available in serverless {es}. +are not available in {es-serverless}. * {ref}/search-aggregations-bucket.html[Bucket] aggregations that group documents into buckets, also called bins, based on field values, ranges, or other criteria. diff --git a/serverless/pages/explore-your-data-visualize-your-data.asciidoc b/serverless/pages/explore-your-data-visualize-your-data.asciidoc index 8aabda17..5c7a3396 100644 --- a/serverless/pages/explore-your-data-visualize-your-data.asciidoc +++ b/serverless/pages/explore-your-data-visualize-your-data.asciidoc @@ -13,7 +13,7 @@ These dashboards are loaded automatically when you install https://www.elastic.c You can also create new dashboards and visualizations based on your data views to get a full picture of your data. -In your {es} project, go to **Dashboards** to see existing dashboards or create your own. +In your {es-serverless} project, go to **Dashboards** to see existing dashboards or create your own. Notice you can filter the list of dashboards: diff --git a/serverless/pages/explore-your-data.asciidoc b/serverless/pages/explore-your-data.asciidoc index ecaa0dd6..e58339a9 100644 --- a/serverless/pages/explore-your-data.asciidoc +++ b/serverless/pages/explore-your-data.asciidoc @@ -8,7 +8,7 @@ preview:[] In addition to search, {es3} offers several options for analyzing and visualizing your data. -* <>: Use the {es} REST API to summarize your data as metrics, statistics, or other analytics. +* <>: Use the {es-serverless} REST API to summarize your data as metrics, statistics, or other analytics. * <>: Use the **Discover** UI to filter your data or learn about its structure. * <>: Build dynamic dashboards that visualize your data as charts, gauges, graphs, maps, and more. * <>: Create rules that trigger notifications based on your data. diff --git a/serverless/pages/get-started.asciidoc b/serverless/pages/get-started.asciidoc index f16055e9..5d8a1807 100644 --- a/serverless/pages/get-started.asciidoc +++ b/serverless/pages/get-started.asciidoc @@ -6,18 +6,18 @@ preview:[] -Follow along to set up your {es} project and get started with some sample documents. +Follow along to set up your {es-serverless} project and get started with some sample documents. Then, choose how to continue with your own data. [discrete] [[elasticsearch-get-started-create-project]] == Create project -Use your {ecloud} account to create a fully-managed {es} project: +Use your {ecloud} account to create a fully-managed {es-serverless} project: . Navigate to {ess-console}[cloud.elastic.co] and create a new account or log in to your existing account. . Within **Serverless Projects**, choose **Create project**. -. Choose the {es} project type. +. Choose the {es-serverless} project type. . Select a **configuration** for your project, based on your use case. + ** **General purpose**. For general search use cases across various data types. @@ -26,7 +26,7 @@ Use your {ecloud} account to create a fully-managed {es} project: Select **Create project** to continue. . Once the project is ready, select **Continue**. -You should now see **Get started with {es}**, and you're ready to continue. +You should now see **Get started with {es-serverless}**, and you're ready to continue. include::../partials/minimum-vcus-detail.asciidoc[] @@ -34,7 +34,7 @@ include::../partials/minimum-vcus-detail.asciidoc[] [[elasticsearch-get-started-create-api-key]] == Create API key -Create an API key, which will enable you to access the {es} API to ingest and search data. +Create an API key, which will enable you to access the {es-serverless} API to ingest and search data. . On the **Getting Started** page, scroll to **Add an API Key** and select **New**. . In **Create API Key**, enter a name for your key and (optionally) set an expiration date. @@ -56,10 +56,10 @@ You can't recover or retrieve a lost API key. Instead, you must delete the key a == Copy URL Next, copy the URL of your API endpoint. -You'll send all {es} API requests to this URL. +You'll send all {es-serverless} API requests to this URL. -. On the **Getting Started** page, scroll to **Copy your connection details** section, and find the **Elasticsearch endpoint** field. -. Copy the URL for the Elasticsearch endpoint. +. On the **Getting Started** page, scroll to **Copy your connection details** section, and find the **{es} endpoint** field. +. Copy the URL for the {es} endpoint. Store this value along with your `encoded` API key. You'll use both values in the next step. @@ -71,7 +71,7 @@ You'll use both values in the next step. We'll use the `curl` command to test your connection and make additional API requests. (See https://everything.curl.dev/get[Install curl] if you need to install this program.) -`curl` will need access to your Elasticsearch Endpoint and `encoded` API key. +`curl` will need access to your {es} endpoint and `encoded` API key. Within your terminal, assign these values to the `ES_URL` and `API_KEY` environment variables. For example: @@ -224,7 +224,7 @@ You should receive a response with the results: == Continue on your own Congratulations! -You've set up an {es} project, and you've ingested and searched some sample data. +You've set up an {es-serverless} project, and you've ingested and searched some sample data. Now you're ready to continue on your own. [discrete] @@ -241,7 +241,7 @@ By creating a data view, you can explore data using several UI tools, such as Di Ready to build your own solution? -To learn more about sending and syncing data to {es}, or the search API and its query DSL, check <> and <>. +To learn more about sending and syncing data to {es-serverless}, or the search API and its query DSL, check <> and <>. //// /* diff --git a/serverless/pages/ingest-pipelines.asciidoc b/serverless/pages/ingest-pipelines.asciidoc index a4a6cb47..69943721 100644 --- a/serverless/pages/ingest-pipelines.asciidoc +++ b/serverless/pages/ingest-pipelines.asciidoc @@ -21,7 +21,7 @@ TBD: Do these requirements apply in serverless? ## Prerequisites - Nodes with the ingest node role handle pipeline processing. To use ingest pipelines, your cluster must have at least one node with the ingest role. For heavy ingest loads, we recommend creating dedicated ingest nodes. -- If the Elasticsearch security features are enabled, you must have the manage_pipeline cluster privilege to manage ingest pipelines. To use Kibana’s Ingest Pipelines feature, you also need the cluster:monitor/nodes/info cluster privileges. +- If the {es} security features are enabled, you must have the manage_pipeline cluster privilege to manage ingest pipelines. To use Kibana’s Ingest Pipelines feature, you also need the cluster:monitor/nodes/info cluster privileges. - Pipelines including the enrich processor require additional setup. See Enrich your data. */ //// diff --git a/serverless/pages/ingest-your-data-ingest-data-through-integrations-beats.asciidoc b/serverless/pages/ingest-your-data-ingest-data-through-integrations-beats.asciidoc index d9af7cc1..9c80a9cb 100644 --- a/serverless/pages/ingest-your-data-ingest-data-through-integrations-beats.asciidoc +++ b/serverless/pages/ingest-your-data-ingest-data-through-integrations-beats.asciidoc @@ -38,10 +38,10 @@ Depending on what data you want to collect, you may need to install multiple shi {beats} can send data to {es} directly or through {ls}, where you can further process and enhance the data before visualizing it in {kib}. -.Authenticating with Elasticsearch +.Authenticating with {es} [NOTE] ==== -When you use {beats} to export data to an {es} project, the {beats} require an API key to authenticate with {es}. +When you use {beats} to export data to an {es-serverless} project, the {beats} require an API key to authenticate with {es}. Refer to <> for the steps to set up your API key, and to https://www.elastic.co/guide/en/beats/filebeat/current/beats-api-keys.html[Grant access using API keys] in the Filebeat documentation for an example of how to configure your {beats} to use the key. ==== diff --git a/serverless/pages/ingest-your-data-ingest-data-through-integrations-connector-client.asciidoc b/serverless/pages/ingest-your-data-ingest-data-through-integrations-connector-client.asciidoc index f3118a4a..ceb0700f 100644 --- a/serverless/pages/ingest-your-data-ingest-data-through-integrations-connector-client.asciidoc +++ b/serverless/pages/ingest-your-data-ingest-data-through-integrations-connector-client.asciidoc @@ -62,14 +62,14 @@ Connector clients are available for the following third-party data sources: [[elasticsearch-ingest-data-through-integrations-connector-client-overview]] == Overview -Because connector clients are self-managed on your own infrastructure, they run outside of your {es} serverless project. +Because connector clients are self-managed on your own infrastructure, they run outside of your {es-serverless} project. You can run them from source or in a Docker container. .Workflow [NOTE] ==== -In order to set up, configure, and run a connector you'll be moving between your third-party service, the {es} Serverless UI, and your terminal. +In order to set up, configure, and run a connector you'll be moving between your third-party service, the {es-serverless} Serverless UI, and your terminal. At a high-level, the workflow looks like this: . Satisfy any data source prerequisites (e.g., create an OAuth application). @@ -101,7 +101,7 @@ Follow these steps: . Add a name and optional description to identify the connector. . Copy the `connector_id`, `service_type`, and `elasticsearch.host` values printed to the screen. You'll need to update these values in your https://github.com/elastic/connectors/blob/main/config.yml[`config.yml`] file. -. Navigate to **Elasticsearch → Home**, and make a note of your **{es} endpoint** and **API key** values. You can create a new API key by clicking on **New** in the **API key** section. +. Navigate to **{es} → Home**, and make a note of your **{es} endpoint** and **API key** values. You can create a new API key by clicking on **New** in the **API key** section. . Run the connector code either from source or with Docker, following the instructions below. [discrete] diff --git a/serverless/pages/ingest-your-data-ingest-data-through-integrations-logstash.asciidoc b/serverless/pages/ingest-your-data-ingest-data-through-integrations-logstash.asciidoc index 8bf1a060..d2c109be 100644 --- a/serverless/pages/ingest-your-data-ingest-data-through-integrations-logstash.asciidoc +++ b/serverless/pages/ingest-your-data-ingest-data-through-integrations-logstash.asciidoc @@ -10,12 +10,12 @@ preview:[] It supports a wide variety of data sources, and can dynamically unify data from disparate sources and normalize the data into destinations of your choice. {ls} can collect data using a variety of {ls} {logstash-ref}/input-plugins.html[input plugins], enrich and transform the data with {ls} {logstash-ref}/filter-plugins.html[filter plugins], -and output the data to {es} using the {ls} {logstash-ref}/plugins-outputs-elasticsearch.html[Elasticsearch output plugin]. +and output the data to {es} using the {ls} {logstash-ref}/plugins-outputs-elasticsearch.html[{es} output plugin]. You can use {ls} to extend <> for advanced use cases, such as data routed to multiple destinations or when you need to make your data persistent. -.Logstash for Elasticsearch on serverless +.Logstash for {es-serverless} [NOTE] ==== {ls} is a powerful, versatile ETL (Extract, Transform, Load) engine that can play an important role in organizations of all sizes. @@ -51,8 +51,8 @@ To use {ls} to send data to {es3}, you must be using: [[elasticsearch-ingest-data-through-logstash-secure-connection]] == Secure connection -Serverless Elasticsearch simplifies secure communication between {ls} and {es}. -Configure the {logstash-ref}/plugins-outputs-elasticsearch.html[Elasticsearch output] plugin to use +{es-serverless} simplifies secure communication between {ls} and {es}. +Configure the {logstash-ref}/plugins-outputs-elasticsearch.html[{es} output] plugin to use {logstash-ref}/plugins-outputs-elasticsearch.html#plugins-outputs-elasticsearch-cloud_id[`cloud_id`] and {logstash-ref}/plugins-outputs-elasticsearch.html#plugins-outputs-elasticsearch-api_key[`api_key`]. No additional SSL configuration steps are needed. @@ -83,7 +83,7 @@ output { [discrete] [[elasticsearch-ingest-data-through-logstash-migrating-elasticsearch-data-using-ls]] -== Migrating Elasticsearch data using {ls} +== Migrating {es} data using {ls} You can use {ls} to migrate data from self-managed {es} or {ess} to {es3}, or to migrate data from one {es3} deployment to another. diff --git a/serverless/pages/ingest-your-data.asciidoc b/serverless/pages/ingest-your-data.asciidoc index 8b538ad2..88809992 100644 --- a/serverless/pages/ingest-your-data.asciidoc +++ b/serverless/pages/ingest-your-data.asciidoc @@ -1,7 +1,7 @@ [[elasticsearch-ingest-your-data]] = Ingest your data -// :description: Add data to your {es} project. +// :description: Add data to your {es-serverless} project. // :keywords: serverless, elasticsearch, ingest, overview preview:[] diff --git a/serverless/pages/manage-billing-monitor-usage.asciidoc b/serverless/pages/manage-billing-monitor-usage.asciidoc index 597c325f..b0add3f6 100644 --- a/serverless/pages/manage-billing-monitor-usage.asciidoc +++ b/serverless/pages/manage-billing-monitor-usage.asciidoc @@ -21,8 +21,8 @@ On the **Usage** page you can: The usage breakdown information is an estimate. To get the exact amount you owe for a given month, check your invoices in the <>. ==== -.Elasticsearch minimum runtime VCUs +.{es} minimum runtime VCUs [IMPORTANT] ==== -When you create an Elasticsearch Serverless project, a minimum number of VCUs are always allocated to your project to maintain basic ingest and search capabilities. These VCUs incur a minimum cost even with no active usage. Learn more about https://www.elastic.co/pricing/serverless-search#what-are-the-minimum-compute-resource-vcus-on-elasticsearch-serverless[minimum VCUs on Elasticsearch Serverless]. +When you create an {es-serverless} project, a minimum number of VCUs are always allocated to your project to maintain basic ingest and search capabilities. These VCUs incur a minimum cost even with no active usage. Learn more about https://www.elastic.co/pricing/serverless-search#what-are-the-minimum-compute-resource-vcus-on-elasticsearch-serverless[minimum VCUs on {es-serverless}]. ==== diff --git a/serverless/pages/manage-your-project-rest-api.asciidoc b/serverless/pages/manage-your-project-rest-api.asciidoc index d32f5af6..6b8ce3f9 100644 --- a/serverless/pages/manage-your-project-rest-api.asciidoc +++ b/serverless/pages/manage-your-project-rest-api.asciidoc @@ -71,7 +71,7 @@ export API_KEY="YOUR_GENERATED_API_KEY" [discrete] [[general-manage-project-with-api-create-a-serverless-elasticsearch-project]] -=== Create a serverless Elasticsearch project +=== Create an {es-serverless} project [source,bash] ---- @@ -89,7 +89,7 @@ curl -H "Authorization: ApiKey $API_KEY" \ <2> You can <>. The response from the create project request will include the created project details, such as the project ID, -the credentials to access the project, and the endpoints to access different apps such as Elasticsearch and Kibana. +the credentials to access the project, and the endpoints to access different apps such as {es} and Kibana. Example of `Create project` response: diff --git a/serverless/pages/manage-your-project.asciidoc b/serverless/pages/manage-your-project.asciidoc index ff59be18..ffcc25d9 100644 --- a/serverless/pages/manage-your-project.asciidoc +++ b/serverless/pages/manage-your-project.asciidoc @@ -18,7 +18,7 @@ From the project page, you can: * **Rename your project**. In the **Overview** section, click **Edit** next to the project's name. * **Manage data and integrations**. Update your project data, including storage settings, indices, and data views, directly in your project. -* **Manage API keys**. Access your project and interact with its data programmatically using Elasticsearch APIs. +* **Manage API keys**. Access your project and interact with its data programmatically using {es} APIs. * **Manage members**. Add members and manage their access to this project or other resources of your organization. [discrete] @@ -92,7 +92,7 @@ When enabled, this setting determines the default retention period that is autom | **Security Analytics Essentials** a| Standard security analytics, detections, investigations, and collaborations. Allows these add-ons: -* **Endpoint Protection Essentials**: Endpoint protections with {elastic-defend}. +* **Endpoint Protection Essentials**: endpoint protections with {elastic-defend}. * **Cloud Protection Essentials**: Cloud native security features. | **Security Analytics Complete** diff --git a/serverless/pages/ml-nlp-auto-scale.asciidoc b/serverless/pages/ml-nlp-auto-scale.asciidoc index 33fc2e0f..71c81b1c 100644 --- a/serverless/pages/ml-nlp-auto-scale.asciidoc +++ b/serverless/pages/ml-nlp-auto-scale.asciidoc @@ -4,7 +4,7 @@ // :keywords: serverless You can enable autoscaling for each of your trained model deployments. -Autoscaling allows Elasticsearch to automatically adjust the resources the model deployment can use based on the workload demand. +Autoscaling allows {es} to automatically adjust the resources the model deployment can use based on the workload demand. There are two ways to enable autoscaling: @@ -66,7 +66,7 @@ Increasing the number of threads will make the search processes more performant. == Enabling autoscaling in Kibana - adaptive resources You can enable adaptive resources for your models when starting or updating the model deployment. -Adaptive resources make it possible for Elasticsearch to scale up or down the available resources based on the load on the process. +Adaptive resources make it possible for {es} to scale up or down the available resources based on the load on the process. This can help you to manage performance and cost more easily. When adaptive resources are enabled, the number of VCUs that the model deployment uses is set automatically based on the current load. When the load is high, the number of VCUs that the process can use is automatically increased. diff --git a/serverless/pages/pricing.asciidoc b/serverless/pages/pricing.asciidoc index 34a35d92..51f0ed85 100644 --- a/serverless/pages/pricing.asciidoc +++ b/serverless/pages/pricing.asciidoc @@ -1,16 +1,16 @@ [[elasticsearch-billing]] -= Elasticsearch billing dimensions += {es} billing dimensions // :description: Learn about how Elasticsearch usage affects pricing. // :keywords: serverless, elasticsearch, overview preview:[] -Elasticsearch is priced based on the consumption of the underlying +{es} is priced based on the consumption of the underlying infrastructure used to support your use case, with the performance characteristics you need. We measure by Virtual Compute Units (VCUs), which is a slice of RAM, CPU and local disk for caching. The number of VCUs required will -depend on the amount and the rate of data sent to Elasticsearch and retained, +depend on the amount and the rate of data sent to {es} and retained, and the number of searches and latency you require for searches. In addition, if you required {ml} for inference or NLP tasks, those VCUs are also metered and billed. @@ -21,10 +21,10 @@ include::../partials/minimum-vcus-detail.asciidoc[] [[elasticsearch-billing-information-about-the-vcu-types-search-ingest-and-ml]] == Information about the VCU types (Search, Ingest, and ML) -There are three VCU types in Elasticsearch: +There are three VCU types in {es}: * **Indexing** — The VCUs used to index the incoming documents to be -stored in Elasticsearch. +stored in {es}. * **Search** — The VCUs used to return search results with the latency and Queries per Second (QPS) you require. * **Machine Learning** — The VCUs used to perform inference, NLP tasks, and other ML activities. @@ -33,24 +33,24 @@ Queries per Second (QPS) you require. [[elasticsearch-billing-information-about-the-search-ai-lake-dimension-gb]] == Information about the Search AI Lake dimension (GB) -For Elasticsearch, the Search AI Lake is where data is stored and retained. This is +For {es}, the Search AI Lake is where data is stored and retained. This is charged in GBs for the size of data at rest. Depending on the enrichment, vectorization and other activities during ingest, this size may be different from the original size of the source data. [discrete] [[elasticsearch-billing-managing-elasticsearch-costs]] -== Managing Elasticsearch costs +== Managing {es} costs You can control costs in a number of ways. Firstly there is the amount of -data that is retained. Elasticsearch will ensure that the most recent data is +data that is retained. {es} will ensure that the most recent data is cached, allowing for fast retrieval. Reducing the amount of data means fewer Search VCUs may be required. If you need lower latency, then more Search VCUs can be added by adjusting the Search Power. A further refinement is for data streams that can be used to store time series data. For that type of data, you can further define the number of days of data you want cacheable, which will affect the number of Search VCUs and -therefore the cost. Note that Elasticsearch Serverless maintains and bills for +therefore the cost. Note that {es-serverless} maintains and bills for https://www.elastic.co/pricing/serverless-search#what-are-the-minimum-compute-resource-vcus-on-elasticsearch-serverless[minimum compute resource Ingest and Search VCUs]. -For detailed Elasticsearch serverless project rates, check the -https://www.elastic.co/pricing/serverless-search[Elasticsearch Serverless pricing page]. +For detailed {es-serverless} project rates, check the +https://www.elastic.co/pricing/serverless-search[{es-serverless} pricing page]. diff --git a/serverless/pages/project-and-management-settings.asciidoc b/serverless/pages/project-and-management-settings.asciidoc index 7ef18ab6..a23249cd 100644 --- a/serverless/pages/project-and-management-settings.asciidoc +++ b/serverless/pages/project-and-management-settings.asciidoc @@ -6,7 +6,7 @@ preview:[] The documentation in this section describes shared capabilities that are available in multiple solutions. Look for the doc badge on each page to see if the page is valid for your solution: -* {es-badge} for the {es} solution +* {es-badge} for the {es-serverless} solution * {obs-badge} for the {observability} solution * {sec-badge} for the {elastic-sec} solution diff --git a/serverless/pages/project-settings.asciidoc b/serverless/pages/project-settings.asciidoc index 7e3cf642..c10545d2 100644 --- a/serverless/pages/project-settings.asciidoc +++ b/serverless/pages/project-settings.asciidoc @@ -33,7 +33,7 @@ To learn more about roles, refer to <>. | {es-badge}{sec-badge} | <> -| Manage the fields in the data views that retrieve your data from {es}. +| Manage the fields in the data views that retrieve your data from {es-serverless}. | {es-badge}{obs-badge}{sec-badge} | <> diff --git a/serverless/pages/run-api-requests-in-the-console.asciidoc b/serverless/pages/run-api-requests-in-the-console.asciidoc index eff6c45e..fd540cca 100644 --- a/serverless/pages/run-api-requests-in-the-console.asciidoc +++ b/serverless/pages/run-api-requests-in-the-console.asciidoc @@ -8,7 +8,7 @@ preview:[] This content applies to: {es-badge} {obs-badge} {sec-badge} -**Console** lets you interact with https://www.elastic.co/docs/api[Elasticsearch and Kibana serverless APIs] from your project. +**Console** lets you interact with https://www.elastic.co/docs/api[{es} and Kibana serverless APIs] from your project. Requests are made in the left pane, and responses are displayed in the right pane. @@ -17,7 +17,7 @@ image::images/console.png[Console request/response pair] To go to **Console**, find **Dev Tools** in the navigation menu or use the global search bar. -You can also find Console directly on your Elasticsearch serverless project pages, where you can expand it from the footer. This Console, called **Persistent Console**, has the same capabilities and shares the same history as the Console in **Dev Tools**. +You can also find Console directly on your {es-serverless} project pages, where you can expand it from the footer. This Console, called **Persistent Console**, has the same capabilities and shares the same history as the Console in **Dev Tools**. [discrete] [[devtools-run-api-requests-in-the-console-write-requests]] @@ -212,4 +212,4 @@ Go to the **Config** tab of **Console** to customize its display, autocomplete, [[devtools-run-api-requests-in-the-console-disable-console]] == Disable Console -You can disable the persistent console that shows in the footer of your {es} project pages. To do that, go to **Management** > **Advanced Settings**, and turn off the `devTools:enablePersistentConsole` setting. +You can disable the persistent console that shows in the footer of your {es-serverless} project pages. To do that, go to **Management** > **Advanced Settings**, and turn off the `devTools:enablePersistentConsole` setting. diff --git a/serverless/pages/search-playground.asciidoc b/serverless/pages/search-playground.asciidoc index d9e986a9..992ed6fb 100644 --- a/serverless/pages/search-playground.asciidoc +++ b/serverless/pages/search-playground.asciidoc @@ -9,7 +9,7 @@ preview:[] Use the Search Playground to test and edit {es} queries visually in the UI. Then use the Chat Playground to combine your {es} data with large language models (LLMs) for retrieval augmented generation (RAG). You can also view the underlying Python code that powers the chat interface, and use it in your own application. -Find Playground in the {es} serverless UI under **{es} > Build > Playground**. +Find Playground in the {es-serverless} UI under **{es} > Build > Playground**. [NOTE] ==== diff --git a/serverless/pages/search-your-data-semantic-search-elser.asciidoc b/serverless/pages/search-your-data-semantic-search-elser.asciidoc index c14dc046..eba40284 100644 --- a/serverless/pages/search-your-data-semantic-search-elser.asciidoc +++ b/serverless/pages/search-your-data-semantic-search-elser.asciidoc @@ -35,7 +35,7 @@ deploy the model. [NOTE] ==== The minimum dedicated ML node size for deploying and using the ELSER model -is 4 GB in Elasticsearch Service if +is 4 GB in {es} Service if {cloud}/ec-autoscaling.html[deployment autoscaling] is turned off. Turning on autoscaling is recommended because it allows your deployment to dynamically adjust resources based on demand. Better performance can be achieved by using diff --git a/serverless/pages/serverless-differences.asciidoc b/serverless/pages/serverless-differences.asciidoc index 6deffb93..e4a060b0 100644 --- a/serverless/pages/serverless-differences.asciidoc +++ b/serverless/pages/serverless-differences.asciidoc @@ -1,7 +1,7 @@ [[elasticsearch-differences]] -= Differences from other Elasticsearch offerings += Differences from other {es} offerings -// :description: Understand how serverless Elasticsearch differs from Elastic Cloud Hosted and self-managed offerings. +// :description: Understand how {es-serverless} differs from Elastic Cloud Hosted and self-managed offerings. // :keywords: serverless, elasticsearch ++++ @@ -10,13 +10,13 @@ preview:[] -Some features that are available in Elastic Cloud Hosted and self-managed offerings are not available in serverless {es}. +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: * **Index lifecycle management ({ilm-init})** is not available, in favor of <>. + In an Elastic Cloud Hosted or self-managed environment, {ilm-init} lets you automatically transition indices through data tiers according to your -performance needs and retention requirements. This allows you to balance hardware costs with performance. Serverless Elasticsearch eliminates this +performance needs and retention requirements. This allows you to balance hardware costs with performance. {es-serverless} eliminates this complexity by optimizing your cluster performance for you. + Data stream lifecycle is an optimized lifecycle tool that lets you focus on the most common lifecycle management needs, without unnecessary @@ -30,7 +30,7 @@ hide the details of complex, domain-specific detections, while providing a consi * Certain APIs, API parameters, index, cluster and node level settings are not available. Refer to our <> for a list of available APIs. + -Serverless Elasticsearch manages the underlying Elastic cluster for you, optimizing nodes, shards, and replicas for your use case. +{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. diff --git a/serverless/pages/sign-up.asciidoc b/serverless/pages/sign-up.asciidoc index b929833a..9cce6883 100644 --- a/serverless/pages/sign-up.asciidoc +++ b/serverless/pages/sign-up.asciidoc @@ -22,7 +22,7 @@ To learn more about serverless Elastic Cloud Hosted, check our https://www.elast Serverless projects package Elastic Stack features by type of solution: -* <> +* <> * <> * <> @@ -44,21 +44,21 @@ During the free 14 day trial, Elastic provides access to one hosted deployment a * You can have one active deployment at a time * The deployment size is limited to 8GB RAM and approximately 360GB of storage, depending on the specified hardware profile * Machine learning nodes are available up to 4GB RAM -* Custom Elasticsearch plugins are not enabled +* Custom {es} plugins are not enabled To learn more about serverless Elastic Cloud Hosted, check our https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html[Elasticsearch Service documentation]. **Serverless projects** * You can have one active serverless project at a time. -* Search Power is limited to 100. This setting only exists in Elasticsearch projects -* Search Boost Window is limited to 7 days. This setting only exists in Elasticsearch projects +* Search Power is limited to 100. This setting only exists in {es-serverless} projects +* Search Boost Window is limited to 7 days. This setting only exists in {es-serverless} projects **How to remove restrictions?** To remove limitations, subscribe to https://www.elastic.co/guide/en/cloud/current/ec-billing-details.html[Elastic Cloud]. Elastic Cloud subscriptions include the following benefits: -* Increased memory or storage for deployment components, such as Elasticsearch clusters, machine learning nodes, and APM server. +* Increased memory or storage for deployment components, such as {es} clusters, machine learning nodes, and APM server. * As many deployments and projects as you need. * Third availability zone for your deployments. * Access to additional features, such as cross-cluster search and cross-cluster replication. diff --git a/serverless/pages/technical-preview-limitations.asciidoc b/serverless/pages/technical-preview-limitations.asciidoc index 756ad413..a307e053 100644 --- a/serverless/pages/technical-preview-limitations.asciidoc +++ b/serverless/pages/technical-preview-limitations.asciidoc @@ -1,7 +1,7 @@ [[elasticsearch-technical-preview-limitations]] = Technical preview limitations -// :description: Review the limitations that apply to Elasticsearch projects. +// :description: Review the limitations that apply to {es-serverless} projects. // :keywords: serverless, elasticsearch preview:[] @@ -16,7 +16,7 @@ The following are currently not available: * Migrations from non-serverless {es} deployments. In the interim, you can <> to move data to and from serverless projects. * Custom roles * Audit logging -* Elasticsearch for Apache Hadoop +* {es} for Apache Hadoop Currently, workloads outside of the following ranges may experience higher latencies (greater than sub-second): diff --git a/serverless/pages/what-is-elasticsearch-serverless.asciidoc b/serverless/pages/what-is-elasticsearch-serverless.asciidoc index 61a8afc6..3eb6b4c9 100644 --- a/serverless/pages/what-is-elasticsearch-serverless.asciidoc +++ b/serverless/pages/what-is-elasticsearch-serverless.asciidoc @@ -2,24 +2,24 @@ To be rewritten/refined //// -// :description: Build search solutions and applications with {es}. +// :description: Build search solutions and applications with {es-serverless}. // :keywords: serverless, elasticsearch, overview preview:[] -Elasticsearch allows you to build custom applications. Whether you have structured or unstructured text, numerical data, or geospatial data, Elasticsearch can efficiently store and index it in a way that supports fast searches. +{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 Elasticsearch on serverless +.Understanding {es-serverless} [IMPORTANT] ==== -Refer to <> and <> for important details, including features and limitations specific to {es} on serverless. +Refer to <> and <> for important details, including features and limitations specific to {es-serverless}. ==== [discrete] == Get started -* <>: Create your first Elasticsearch project. -* <>: Learn how to get your data into Elasticsearch. +* <>: Create your first {es} project. +* <>: Learn how to get your data into {es}. [discrete] == How to diff --git a/serverless/pages/what-is-serverless.asciidoc b/serverless/pages/what-is-serverless.asciidoc new file mode 100644 index 00000000..8999cbd1 --- /dev/null +++ b/serverless/pages/what-is-serverless.asciidoc @@ -0,0 +1,137 @@ +[[general-what-is-serverless-elastic]] += What is serverless Elastic? + +// :keywords: serverless + +Serverless projects use the core components of the {stack}, such as {es} and {kib}, and are based on https://www.elastic.co/blog/elastic-serverless-architecture[an architecture that +decouples compute and storage]. Search and indexing operations are separated, which offers high flexibility for scaling your workloads while ensuring +a high level of performance. + +**Management free.** Elastic manages the underlying Elastic cluster, so you can focus on your data. With serverless projects, Elastic is responsible for automatic upgrades, data backups, +and business continuity. + +**Autoscaled.** To meet your performance requirements, the system automatically adjusts to your workloads. For example, when you have a short time spike on the +data you ingest, more resources are allocated for that period of time. When the spike is over, the system uses less resources, without any action +on your end. + +**Optimized data storage.** Your data is stored in cost-efficient, general storage. A cache layer is available on top of the general storage for recent and frequently queried data that provides faster search speed. +The size of the cache layer and the volume of data it holds depend on <> that you can configure for each project. + +**Dedicated experiences.** All serverless solutions are built on the Elastic Search Platform and include the core capabilities of the Elastic Stack. They also each offer a distinct experience and specific capabilities that help you focus on your data, goals, and use cases. + +**Pay per usage.** Each serverless project type includes product-specific and usage-based pricing. + +.Serverless billing starts June 1, 2024 +[IMPORTANT] +==== +Until May 31, 2024, your serverless consumption will not incur any charges, but will be visible along with your total Elastic Cloud consumption on the https://cloud.elastic.co/billing/usage[Billing Usage page]. Unless you are in a trial period, usage on or after June 1, 2024 will be deducted from your existing Elastic Cloud credits or be billed to your active payment method. +==== + +[discrete] +[[general-what-is-serverless-elastic-control-your-data-and-performance]] +== Control your data and performance + +Control your project data and query performance against your project data. + +**Data.** Choose the data you want to ingest, and the method to ingest it. By default, data is stored indefinitely in your project, +and you define the retention settings for your data streams. + +**Performance.** For granular control over costs and query performance against your project data, serverless projects come with a set of predefined <> that you can edit. + +.Some or all of these settings may not be available for all types of serverless projects. +[NOTE] +==== + +==== + +[discrete] +[[general-what-is-serverless-elastic-differences-between-serverless-projects-and-hosted-deployments-on-ecloud]] +== Differences between serverless projects and hosted deployments on {ecloud} + +You can run https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html[hosted deployments] of the {stack} on {ecloud}. These hosted deployments provide more provisioning and advanced configuration options. + +|=== +| Option| Serverless| Hosted + +| **Cluster management** +| Fully managed by Elastic. +| You provision and manage your hosted clusters. Shared responsibility with Elastic. + +| **Scaling** +| Autoscales out of the box. +| Manual scaling or autoscaling available for you to enable. + +| **Upgrades** +| Automatically performed by Elastic. +| You choose when to upgrade. + +| **Pricing** +| Individual per project type and based on your usage. +| Based on deployment size and subscription level. + +| **Performance** +| Autoscales based on your usage. +| Manual scaling. + +| **Solutions** +| Single solution per project. +| Full Elastic Stack per deployment. + +| **User management** +| Elastic Cloud-managed users. +| Elastic Cloud-managed users and native Kibana users. + +| **API support** +| Subset of https://www.elastic.co/docs/api[APIs]. +| All Elastic APIs. + +| **Backups** +| Projects automatically backed up by Elastic. +| Your responsibility with Snapshot & Restore. + +| **Data retention** +| Editable on data streams. +| Index Lifecycle Management. +|=== + +[discrete] +[[general-what-is-serverless-elastic-answers-to-common-serverless-questions]] +== Answers to common serverless questions + +**What Support is available for the serverless preview?** + +There is no official SLA for Support in Serverless until General Availability (GA). We’ll do our best to service customers and inquiries as we would any pre-GA product - at a Platinum/Enterprise Severity 3 (1 business day) SLA target. + +**Is there migration support between hosted deployments and serverless projects?** + +Migration paths between hosted deployments and serverless projects are currently unsupported. + +**How can I move data to or from serverless projects?** + +We are working on data migration tools! In the interim, you can <> with {es} input and output plugins to move data to and from serverless projects. + +**How does serverless ensure compatibility between software versions?** + +Connections and configurations are unaffected by upgrades. To ensure compatibility between software versions, quality testing and API versioning are used. + +**Can I convert a serverless project into a hosted deployment, or a hosted deployment into a serverless project?** + +Projects and deployments are based on different architectures, and you are unable to convert. + +**Can I convert a serverless project into a project of a different type?** + +You are unable to convert projects into different project types, but you can create as many projects as you’d like. You will be charged only for your usage. + +**How can I create serverless service accounts?** + +Create API keys for service accounts in your serverless projects. Options to automate the creation of API keys with tools such as Terraform will be available in the future. + +To raise a Support case with Elastic, raise a case for your subscription the same way you do today. In the body of the case, make sure to mention you are working in serverless to ensure we can provide the appropriate support. + +**Where can I learn about pricing for serverless?** + +See serverless pricing information for https://www.elastic.co/pricing/serverless-search[Search], https://www.elastic.co/pricing/serverless-observability[Observability], and https://www.elastic.co/pricing/serverless-security[Security]. + +**Can I request backups or restores for my projects?** + +It is not currently possible to request backups or restores for projects, but we are working on data migration tools to better support this. diff --git a/serverless/partials/minimum-vcus-detail.asciidoc b/serverless/partials/minimum-vcus-detail.asciidoc index 0d12fe9e..1c6cb428 100644 --- a/serverless/partials/minimum-vcus-detail.asciidoc +++ b/serverless/partials/minimum-vcus-detail.asciidoc @@ -1,11 +1,11 @@ .Minimum runtime VCUs [IMPORTANT] ==== -When you create an Elasticsearch Serverless project, a minimum number of VCUs are always allocated to your project to maintain basic capabilities. These VCUs are used for the following purposes: +When you create an {es-serverless} project, a minimum number of VCUs are always allocated to your project to maintain basic capabilities. These VCUs are used for the following purposes: * **Ingest**: Ensure constant availability for ingesting data into your project (4 VCUs). * **Search**: Maintain a data cache and support low latency searches (8 VCUs). These minimum VCUs are billed at the standard rate per VCU hour, incurring a minimum cost even when you're not actively using your project. -Learn more about https://www.elastic.co/pricing/serverless-search#what-are-the-minimum-compute-resource-vcus-on-elasticsearch-serverless[minimum VCUs on Elasticsearch Serverless]. +Learn more about https://www.elastic.co/pricing/serverless-search#what-are-the-minimum-compute-resource-vcus-on-elasticsearch-serverless[minimum VCUs on {es-serverless}]. ====