-
Notifications
You must be signed in to change notification settings - Fork 155
Updates Get started page #183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 33 commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
c3b534d
Updates Get started page
kosabogi fe6e543
Updating serverless docs (#172)
georgewallace ae4cbb0
[Serverless] Adds Trained model autoscaling page (#139)
kosabogi a390bdc
Updates Get started to align with the new user flow
kosabogi cab06c9
Update serverless/pages/get-started.asciidoc
kosabogi b7fd129
Update serverless/pages/get-started.asciidoc
kosabogi 0384cfd
Resolves comments
kosabogi e441ee7
Modifies Get started guide, renames and updates Create a new API key …
kosabogi 1832321
Update serverless/pages/connecting-to-es-endpoint.asciidoc
kosabogi 4d69b0f
Update serverless/pages/connecting-to-es-endpoint.asciidoc
kosabogi ce03fa6
Update serverless/pages/connecting-to-es-endpoint.asciidoc
kosabogi 5e0aedf
Update serverless/pages/connecting-to-es-endpoint.asciidoc
kosabogi 7e92800
Update serverless/pages/connecting-to-es-endpoint.asciidoc
kosabogi dd1f8d6
Update serverless/pages/connecting-to-es-endpoint.asciidoc
kosabogi 6d97fe6
Adds details about alternative methods
kosabogi 0845b96
Updates structure
kosabogi 9aba6f8
Merge remote-tracking branch 'origin/main' into update-get-started-page
kosabogi 1b2bb53
Merge branch 'main' into update-get-started-page
kosabogi 14c9f3e
Revert id
leemthompo 0bea4a1
fix other instance
leemthompo 660097d
Update serverless/pages/get-started.asciidoc
kosabogi 1b20770
Update serverless/pages/get-started.asciidoc
kosabogi 6572cbc
Update serverless/pages/get-started.asciidoc
kosabogi fe511c5
Update serverless/pages/connecting-to-es-endpoint.asciidoc
kosabogi f4c851b
Update serverless/pages/get-started.asciidoc
kosabogi 9ce292b
Updates page
kosabogi 6f814c7
Update serverless/pages/get-started.asciidoc
kosabogi 31bc23b
Update serverless/pages/get-started.asciidoc
kosabogi d6005f7
Update serverless/pages/get-started.asciidoc
kosabogi 2b83622
Update serverless/pages/get-started.asciidoc
kosabogi 97ef301
Update serverless/pages/get-started.asciidoc
kosabogi 2c5ca93
Update serverless/pages/get-started.asciidoc
kosabogi 4d4c7cd
Update serverless/pages/get-started.asciidoc
kosabogi dcedf12
Final fixes
kosabogi 5dfa344
Update serverless/pages/connecting-to-es-endpoint.asciidoc
kosabogi 36dd995
Update serverless/pages/get-started.asciidoc
kosabogi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
kosabogi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[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 ingest and search some sample documents. | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.