Skip to content

Commit

Permalink
[8.x] Adds Connection details for the Search landing page (#194525) (#…
Browse files Browse the repository at this point in the history
…194574)

# Backport

This will backport the following commits from `main` to `8.x`:
- [Adds Connection details for the Search landing page
(#194525)](#194525)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"kosabogi","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-01T13:10:12Z","message":"Adds
Connection details for the Search landing page (#194525)\n\n##
Overview\r\n\r\nThis update adds content for finding connection details
and creating an\r\nAPI key for Elastic Cloud, Self-managed, and
Serverless deployments.\r\n\r\n## Related
Issue\r\n\r\nhttps://github.com/elastic/search-docs-team/issues/179\r\n\r\n##
Preview\r\n\r\nFind your connection
details\r\n\r\n---------\r\n\r\nCo-authored-by: Liam Thompson
<[email protected]>","sha":"985984ec547a5b916242025e1479a2bb7a93019e","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","v8.16.0","backport:version"],"title":"Adds
Connection details for the Search landing page
","number":194525,"url":"https://github.com/elastic/kibana/pull/194525","mergeCommit":{"message":"Adds
Connection details for the Search landing page (#194525)\n\n##
Overview\r\n\r\nThis update adds content for finding connection details
and creating an\r\nAPI key for Elastic Cloud, Self-managed, and
Serverless deployments.\r\n\r\n## Related
Issue\r\n\r\nhttps://github.com/elastic/search-docs-team/issues/179\r\n\r\n##
Preview\r\n\r\nFind your connection
details\r\n\r\n---------\r\n\r\nCo-authored-by: Liam Thompson
<[email protected]>","sha":"985984ec547a5b916242025e1479a2bb7a93019e"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194525","number":194525,"mergeCommit":{"message":"Adds
Connection details for the Search landing page (#194525)\n\n##
Overview\r\n\r\nThis update adds content for finding connection details
and creating an\r\nAPI key for Elastic Cloud, Self-managed, and
Serverless deployments.\r\n\r\n## Related
Issue\r\n\r\nhttps://github.com/elastic/search-docs-team/issues/179\r\n\r\n##
Preview\r\n\r\nFind your connection
details\r\n\r\n---------\r\n\r\nCo-authored-by: Liam Thompson
<[email protected]>","sha":"985984ec547a5b916242025e1479a2bb7a93019e"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: kosabogi <[email protected]>
  • Loading branch information
kibanamachine and kosabogi authored Oct 1, 2024
1 parent 27b0605 commit e032b89
Show file tree
Hide file tree
Showing 9 changed files with 69 additions and 0 deletions.
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, find your Cloud ID>> for Elastic Cloud or self-hosted deployments.
* 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, find your {es} endpoint or Cloud ID>> for a serverless deployment.
* 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.
+
[.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 deployments

[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*.
+
[.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.

0 comments on commit e032b89

Please sign in to comment.