Skip to content

Commit

Permalink
Merge branch 'main' of github.com:elastic/docs-content into serverles…
Browse files Browse the repository at this point in the history
…s_intro_update
  • Loading branch information
florent-leborgne committed Nov 20, 2024
2 parents b9df63a + b18be69 commit a2a99ad
Show file tree
Hide file tree
Showing 25 changed files with 289 additions and 1,606 deletions.
Binary file added serverless/images/copy-connection-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added serverless/images/create-an-api-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added serverless/images/get-started-create-an-index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added serverless/images/getting-started-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 3 additions & 6 deletions serverless/index-serverless-elasticsearch.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[[what-is-elasticsearch-serverless]]
== {es}

== {es-serverless}
++++
<titleabbrev>{es}</titleabbrev>
++++
Expand All @@ -9,6 +8,8 @@ include::./pages/what-is-elasticsearch-serverless.asciidoc[leveloffset=+2]

include::./pages/get-started.asciidoc[leveloffset=+2]

include::./pages/connecting-to-es-endpoint.asciidoc[leveloffset=+2]

include::./pages/clients.asciidoc[leveloffset=+2]
include::./pages/clients-go-getting-started.asciidoc[leveloffset=+3]
include::./pages/clients-java-getting-started.asciidoc[leveloffset=+3]
Expand Down Expand Up @@ -39,10 +40,6 @@ include::./pages/search-your-data-semantic-search.asciidoc[leveloffset=+3]
include::./pages/search-your-data-semantic-search-elser.asciidoc[leveloffset=+4]

include::./pages/explore-your-data.asciidoc[leveloffset=+2]
include::./pages/explore-your-data-the-aggregations-api.asciidoc[leveloffset=+3]
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]

Expand Down
5 changes: 0 additions & 5 deletions serverless/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,3 @@ include::./index-serverless-elasticsearch.asciidoc[]
include::{observability-serverless}/index.asciidoc[]
include::{security-serverless}/index.asciidoc[]
include::./index-serverless-project-settings.asciidoc[]


// Hidden pages
include::./pages/explore-your-data-visualize-your-data-create-dashboards.asciidoc[leveloffset=+1]
include::./pages/explore-your-data-visualize-your-data-create-visualizations.asciidoc[leveloffset=+1]
91 changes: 91 additions & 0 deletions serverless/pages/connecting-to-es-endpoint.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
[[elasticsearch-connecting-to-es-serverless-endpoint]]
= Connecting to your Elasticsearch Serverless endpoint

[TIP]
====
This page assumes you have already <<elasticsearch-get-started-create-project,created an {es-serverless} project>>.
====

Learn how to securely connect to your Elasticsearch Serverless instance.

To connect to your Elasticsearch instance from your applications, client libraries, or tools like `curl`, you'll need two key pieces of information: an API key and your endpoint URL. This guide shows you how to get these connection details and verify they work.

[discrete]
[[elasticsearch-get-started-create-api-key]]
== Create a new API key

Create an API key to authenticate your requests to the {es} APIs. You'll need an API key for all API requests and client connections.

To create a new API key:

. On the **Getting Started** page, scroll to **Add an API Key** and select **New**. You can also search for *API keys* in the https://www.elastic.co/guide/en/kibana/current/kibana-concepts-analysts.html#_finding_your_apps_and_objects[global search field].
+
image::images/create-an-api-key.png[Create an API key.]
. In **Create API Key**, enter a name for your key and (optionally) set an expiration date.
. (Optional) Under **Control Security privileges**, you can set specific access permissions for this API key. By default, it has full access to all APIs.
. (Optional) The **Add metadata** section allows you to add custom key-value pairs to help identify and organize your API keys.
. Select **Create API Key** to finish.

After creation, you'll see your API key displayed as an encoded string.
Store this encoded API key securely. It is displayed only once and cannot be retrieved later.
You will use this encoded API key when sending API requests.

[NOTE]
====
You can't recover or retrieve a lost API key. Instead, you must delete the key and create a new one.
====

[discrete]
[[elasticsearch-get-started-endpoint]]
== Get your {es} endpoint URL

The endpoint URL is the address for your {es} instance.
You'll use this URL together with your API key to make requests to the {es} APIs.
To find the endpoint 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.

image::images/copy-connection-details.png[Copy your Elasticsearch endpoint.]

[discrete]
[[elasticsearch-get-started-test-connection]]
== Test connection

Use https://curl.se[`curl`] to verify your connection to {es}.

`curl` will need access to your Elasticsearch endpoint and `encoded` API key.
Within your terminal, assign these values to the `ES_URL` and `API_KEY` environment variables.

For example:

[source,bash]
----
export ES_URL="https://dda7de7f1d264286a8fc9741c7741690.es.us-east-1.aws.elastic.cloud:443"
export API_KEY="ZFZRbF9Jb0JDMEoxaVhoR2pSa3Q6dExwdmJSaldRTHFXWEp4TFFlR19Hdw=="
----

Then run the following command to test your connection:

[source,bash]
----
curl "${ES_URL}" \
-H "Authorization: ApiKey ${API_KEY}" \
-H "Content-Type: application/json"
----

You should receive a response similar to the following:

[source,json]
----
{
"name" : "serverless",
"cluster_name" : "dda7de7f1d264286a8fc9741c7741690",
"cluster_uuid" : "ws0IbTBUQfigmYAVMztkZQ",
"version" : { ... },
"tagline" : "You Know, for Search"
}
----

Now you're ready to start adding data to your {es-serverless} project.
2 changes: 1 addition & 1 deletion serverless/pages/developer-tools-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ GET /my-index-000001/_count
}
----

If the field is aggregatable, you can use <<elasticsearch-explore-your-data-aggregations,aggregations>>
If the field is aggregatable, you can use {ref}/search-aggregations.html[aggregations]
to check the field's values. For `keyword` fields, you can use a `terms`
aggregation to retrieve the field's most common values:

Expand Down
159 changes: 0 additions & 159 deletions serverless/pages/explore-your-data-alerting.asciidoc

This file was deleted.

Loading

0 comments on commit a2a99ad

Please sign in to comment.