Skip to content
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

Adds Connection details for the Search landing page #194525

Merged
merged 8 commits into from
Oct 1, 2024
Binary file added docs/search/images/api-keys-search-bar.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 docs/search/images/click-api-keys.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 docs/search/images/click-create-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 docs/search/images/click-stack-management.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 docs/search/images/cloud-id.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 docs/search/images/manage-deployment.png
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.
69 changes: 69 additions & 0 deletions docs/search/search-connection-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,72 @@
<titleabbrev>Connection details</titleabbrev>
++++

To connect to your {es} deployment, you need either a Cloud ID or an {es} endpoint, depending on the
deployment type you use. For secure connections, it’s recommended to use an API key for authentication.

* Learn how to <<find-cloud-id-cloud-self-managed, obtain your Cloud ID>> for Elastic Cloud or self-hosted deployments.
kosabogi marked this conversation as resolved.
Show resolved Hide resolved
* Learn how to <<create-an-api-key-cloud-self-managed, create an API key>> for Elastic Cloud or self-hosted deployments.
* Learn how to <<find-cloud-id-serverless, obtain your {es} endpoint or Cloud ID>> for a serverless deployment.
kosabogi marked this conversation as resolved.
Show resolved Hide resolved
* Learn how to <<create-an-api-key-serverless, create an API key>> for a serverless deployment.

[float]
=== Elastic Cloud and self-hosted deployments

[float]
[[find-cloud-id-cloud-self-managed]]
==== Find your Cloud ID

. Navigate to the Elastic Cloud home page.
. In the main menu, click *Manage this deployment*.
+
[.screenshot]
image::manage-deployment.png[width=750]
. The Cloud ID is displayed on the right side of the page.

kosabogi marked this conversation as resolved.
Show resolved Hide resolved
[.screenshot]
image::cloud-id.png[width=750]

[float]
[[create-an-api-key-cloud-self-managed]]
==== Create an API key

. To navigate to *API keys*, use the <<kibana-navigation-search,*global search bar*>>.
+
[.screenshot]
image::api-keys-search-bar.png[width=750]
. Click *Create API key*.
+
[.screenshot]
image::click-create-api-key.png[width=750]
. Enter the API key details, and click *Create API key*.
. Copy and securely store the API key, as it will not be shown again.

[float]
=== Serverless deployment
kosabogi marked this conversation as resolved.
Show resolved Hide resolved

[float]
[[find-cloud-id-serverless]]
==== Find your Elasticsearch endpoint

. Navigate to the serverless project's home page.
. Scroll down to the *Copy your connection details* section, and copy the *Elasticsearch endpoint*.

kosabogi marked this conversation as resolved.
Show resolved Hide resolved
[.screenshot]
image::serverless-connection-details.png[width=750]

[NOTE]
====
The *Cloud ID* is also displayed in the Copy your connection details section, which you can use with specific client libraries and connectors.
====

[float]
[[create-an-api-key-serverless]]
==== Create an API key

. Navigate to the serverless project's home page.
. Scroll down to the *Add an API Key* section, and click *New*.
+
[.screenshot]
image::serverless-create-an-api-key.png[width=750]
. Enter the API key details, and click *Create API key*.
. Copy and securely store the API key, as it will not be shown again.