Updates Get started page (#183)

* Updates Get started page * Updating serverless docs (#172) * fixing exists API link * fixing images on index management page * [Serverless] Adds Trained model autoscaling page (#139) * Adds Trained model autoscaling page * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Changes paragraph placement * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: István Zoltán Szabó <[email protected]> * Update serverless/pages/ml-nlp-auto-scale.mdx Co-authored-by: Dima Arnautov <[email protected]> * Updates document based on feedback * mdx to asciidoc * Updates table --------- Co-authored-by: István Zoltán Szabó <[email protected]> Co-authored-by: Dima Arnautov <[email protected]> Co-authored-by: Colleen McGinnis <[email protected]> * Updates Get started to align with the new user flow * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Resolves comments * Modifies Get started guide, renames and updates Create a new API key page * Update serverless/pages/connecting-to-es-endpoint.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/connecting-to-es-endpoint.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/connecting-to-es-endpoint.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/connecting-to-es-endpoint.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/connecting-to-es-endpoint.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/connecting-to-es-endpoint.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Adds details about alternative methods * Updates structure * Revert id * fix other instance * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/connecting-to-es-endpoint.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Updates page * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Final fixes * Update serverless/pages/connecting-to-es-endpoint.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Update serverless/pages/get-started.asciidoc Co-authored-by: Liam Thompson <[email protected]> --------- Co-authored-by: George Wallace <[email protected]> Co-authored-by: István Zoltán Szabó <[email protected]> Co-authored-by: Dima Arnautov <[email protected]> Co-authored-by: Colleen McGinnis <[email protected]> Co-authored-by: Liam Thompson <[email protected]>
elastic · Nov 19, 2024 · 46c134e · 46c134e
1 parent 29ab92a
commit 46c134e
Show file tree

Hide file tree

Showing 7 changed files with 152 additions and 206 deletions.
diff --git a/serverless/images/copy-connection-details.png b/serverless/images/copy-connection-details.png
diff --git a/serverless/images/create-an-api-key.png b/serverless/images/create-an-api-key.png
diff --git a/serverless/images/get-started-create-an-index.png b/serverless/images/get-started-create-an-index.png
diff --git a/serverless/images/getting-started-page.png b/serverless/images/getting-started-page.png
diff --git a/serverless/index-serverless-elasticsearch.asciidoc b/serverless/index-serverless-elasticsearch.asciidoc
@@ -10,6 +10,8 @@ include::./pages/pricing.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]

diff --git a/serverless/pages/connecting-to-es-endpoint.asciidoc b/serverless/pages/connecting-to-es-endpoint.asciidoc
@@ -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.