Skip to content

Commit

Permalink
Update variables, cleanup, remove {es} override (#196)
Browse files Browse the repository at this point in the history
  • Loading branch information
leemthompo authored and georgewallace committed Nov 18, 2024
1 parent 39353b9 commit 2900fb3
Show file tree
Hide file tree
Showing 44 changed files with 247 additions and 111 deletions.
4 changes: 2 additions & 2 deletions serverless/index-serverless-elasticsearch.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[[what-is-elasticsearch-serverless]]
== Elasticsearch
== {es}

++++
<titleabbrev>Elasticsearch</titleabbrev>
<titleabbrev>{es}</titleabbrev>
++++

include::./pages/what-is-elasticsearch-serverless.asciidoc[leveloffset=+2]
Expand Down
1 change: 0 additions & 1 deletion serverless/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:sec-badge: <<what-is-security-serverless,image:images/sec-badge.svg[Security]>>

// The values of these attributes are different in stateful vs serverless
:es: Elasticsearch Serverless
:observability: Elastic Observability Serverless
:security: Elastic Security Serverless

Expand Down
4 changes: 2 additions & 2 deletions serverless/pages/action-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -75,7 +75,7 @@ Actions are instantiations of a connector that are linked to rules and run as ba
|---|---|
| <DocLink id="enKibanaEmailActionType">Email</DocLink> | Send email from your server. |
| <DocLink id="enKibanaResilientActionType">{ibm-r}</DocLink> | Create an incident in {ibm-r}. |
| <DocLink id="enKibanaIndexActionType">Index</DocLink> | Index data into Elasticsearch. |
| <DocLink id="enKibanaIndexActionType">Index</DocLink> | Index data into {es}. |
| <DocLink id="enKibanaJiraActionType">Jira</DocLink> | Create an incident in Jira. |
| <DocLink id="enKibanaTeamsActionType">Microsoft Teams</DocLink> | Send a message to a Microsoft Teams channel. |
| <DocLink id="enKibanaOpsgenieActionType">Opsgenie</DocLink> | Create or close an alert in Opsgenie. |
Expand Down
6 changes: 3 additions & 3 deletions serverless/pages/apis-elasticsearch-conventions.asciidoc
Original file line number Diff line number Diff line change
@@ -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:[]
Expand Down Expand Up @@ -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 <<elasticsearch-get-started>>.
To get API keys for the {es} endpoint (`${ES_URL}`) for a project, refer to <<elasticsearch-get-started>>.

[discrete]
[[elasticsearch-api-conventions-content-type]]
Expand Down
2 changes: 1 addition & 1 deletion serverless/pages/apis-http-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@

preview:[]

* <<elasticsearch-api-conventions>>: The {es} REST APIs have conventions for headers and request bodies.
* <<elasticsearch-api-conventions>>: The {es-serverless} REST APIs have conventions for headers and request bodies.
* <<elasticsearch-kibana-api-conventions>>: 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
4 changes: 2 additions & 2 deletions serverless/pages/clients-dot-net-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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("<CLOUD_ID>", new ApiKey("<API_KEY>"));
----

To get API keys or the Elasticsearch Endpoint for a project, see <<elasticsearch-get-started>>.
To get API keys for the {es} endpoint for a project, see <<elasticsearch-get-started>>.

[discrete]
[[elasticsearch-dot-net-client-getting-started-using-the-api]]
Expand Down
6 changes: 3 additions & 3 deletions serverless/pages/clients-go-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -70,7 +70,7 @@ if err != nil {
}
----

To get API keys or the Elasticsearch Endpoint for a project, see <<elasticsearch-get-started>>.
To get API keys for the {es} endpoint for a project, see <<elasticsearch-get-started>>.

[discrete]
[[elasticsearch-go-client-getting-started-using-the-api]]
Expand Down Expand Up @@ -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`.

Expand Down
4 changes: 2 additions & 2 deletions serverless/pages/clients-java-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -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 <<elasticsearch-get-started>>.
To get API keys for the {es} endpoint for a project, see <<elasticsearch-get-started>>.

[discrete]
[[elasticsearch-java-client-getting-started-using-the-api]]
Expand Down
4 changes: 2 additions & 2 deletions serverless/pages/clients-nodejs-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -47,7 +47,7 @@ const client = new Client({
})
----

To get API keys or the URL for a project, see <<elasticsearch-get-started>>.
To get API keys for the URL for a project, see <<elasticsearch-get-started>>.

[discrete]
[[elasticsearch-nodejs-client-getting-started-using-the-api]]
Expand Down
4 changes: 2 additions & 2 deletions serverless/pages/clients-php-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -50,7 +50,7 @@ $client = ClientBuilder::create()
->build();
----

To get API keys or the Elasticsearch Endpoint for a project, see <<elasticsearch-get-started>>.
To get API keys for the {es} endpoint for a project, see <<elasticsearch-get-started>>.

[discrete]
[[elasticsearch-php-client-getting-started-using-the-api]]
Expand Down
6 changes: 3 additions & 3 deletions serverless/pages/clients-python-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<elasticsearch-get-started>>.
To get API keys for the {es} endpoint for a project, see <<elasticsearch-get-started>>.

[discrete]
[[elasticsearch-python-client-getting-started-using-the-api]]
Expand Down
10 changes: 5 additions & 5 deletions serverless/pages/clients-ruby-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down Expand Up @@ -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]
----
Expand All @@ -97,7 +97,7 @@ client = ElasticsearchServerless::Client.new(
)
----

To get API keys or the Elasticsearch Endpoint for a project, see <<elasticsearch-get-started>>.
To get API keys for the {es} endpoint for a project, see <<elasticsearch-get-started>>.

[discrete]
[[elasticsearch-ruby-client-getting-started-using-the-api]]
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion serverless/pages/clients.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

* <<elasticsearch-go-client-getting-started,Go>> | https://github.com/elastic/elasticsearch-serverless-go[Repository]
Expand Down
8 changes: 4 additions & 4 deletions serverless/pages/developer-tools-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

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.

[discrete]
[[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.

Expand Down Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions serverless/pages/elasticsearch-developer-tools.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ preview:[]

A number of developer tools are available in your project's UI under the **Dev Tools** section.

* <<devtools-run-api-requests-in-the-console,Console>>: Make API calls to your Elasticsearch instance using the Query DSL and view the responses.
* <<devtools-run-api-requests-in-the-console,Console>>: Make API calls to your {es} instance using the Query DSL and view the responses.
* <<devtools-profile-queries-and-aggregations,Search Profiler>>: Inspect and analyze your search queries to identify performance bottlenecks.
* <<devtools-debug-grok-expressions,Grok Debugger>>: Build and debug grok patterns before you use them in your data processing pipelines.

// ## Troubleshooting

// - <DocLink id="serverlessDevtools" text="Troubleshooting"/>: Debug your searches using various Elasticsearch APIs.
// - <DocLink id="serverlessDevtools" text="Troubleshooting"/>: Debug your searches using various {es} APIs.
2 changes: 1 addition & 1 deletion serverless/pages/explore-your-data-alerting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion serverless/pages/explore-your-data-ml-nlp.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
<<elasticsearch-explore-your-data-ml-nlp-model-reference,Compatible third party NLP models>>.

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion serverless/pages/explore-your-data.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ preview:[]

In addition to search, {es3} offers several options for analyzing and visualizing your data.

* <<elasticsearch-explore-your-data-aggregations,Aggregations>>: Use the {es} REST API to summarize your data as metrics, statistics, or other analytics.
* <<elasticsearch-explore-your-data-aggregations,Aggregations>>: Use the {es-serverless} REST API to summarize your data as metrics, statistics, or other analytics.
* <<elasticsearch-explore-your-data-discover-your-data,Discover>>: Use the **Discover** UI to filter your data or learn about its structure.
* <<elasticsearch-explore-your-data-visualize-your-data,Visualizations>>: Build dynamic dashboards that visualize your data as charts, gauges, graphs, maps, and more.
* <<elasticsearch-explore-your-data-alerting,Alerts>>: Create rules that trigger notifications based on your data.
Loading

0 comments on commit 2900fb3

Please sign in to comment.