Repository navigation
[New search IA] Adds Set up section #8603
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
base: main
Are you sure you want to change the base?
Changes from all commits
8f8c2b4
4d21214
081d6b2
bd01db1
37203ed
e28e7f1
8aefe45
203638d
e81c063
144cad3
6ae4d0c
d35b3cb
aa7ad99
b8dd1eb
a603afd
1d6e023
9356ff2
58d8669
fb00fcf
fcd6fff
23bc491
d30c78b
297ed1f
46fd1ba
307573a
58f3a35
fb3995e
f63b49c
5358030
ba5f472
9671e88
fd1b194
595430d
86077f6
947dcb4
621db33
ca11091
7eb6c32
2c83596
fe3478c
a2dff19
ac14a83
01171b2
a11f9ad
16d3190
9cf83d2
1ad85b2
ff936cf
af160e8
7ad41c0
110eb4c
24953b4
1a4d8bc
f0bc81a
c45235c
b55f17a
75c4f52
e563de7
ac3bd4d
f1ce3eb
724fca6
5ee388f
dc2da59
6133776
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,11 @@ | ||
| 1. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), select **Serverless**. | ||
| 2. Find your project and select **Manage**. | ||
| 3. Under **Application endpoints, cluster and component IDs**, select **{{es}}**. | ||
| 4. Copy the **Endpoint** value. | ||
| 1. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), find your project and select **Manage**. | ||
| 2. Under **Application endpoints**, select **{{es}}**. | ||
| 3. Copy the **Direct endpoint** value. | ||
|
|
||
| :::{image} /solutions/images/cloud-console-serverless-endpoint.png | ||
| :alt: The Elasticsearch panel on a Serverless project page in the Elastic Cloud Console, showing the Endpoint and AWS PrivateLink endpoint values with copy buttons | ||
| :alt: The Application endpoints panel in the {{ecloud}} Console, with {{es}} expanded to show the Direct endpoint and Direct Azure Private Link endpoint | ||
| :screenshot: | ||
| :width: 50% | ||
| ::: | ||
|
|
||
| If your project runs on AWS, the panel also lists an **AWS PrivateLink endpoint**. Use it only when you connect through AWS PrivateLink. To learn more, refer to [](/deploy-manage/security/private-connectivity-aws.md). | ||
| Azure and {{aws}} also offer an endpoint you can use to connect to the deployment over a private connection. [Learn more about private connectivity](/deploy-manage/security/private-connectivity.md). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| <!-- | ||
| This snippet is in use in the following locations: | ||
| - solutions/elasticsearch-solution-project/search-connection-details.md | ||
| - solutions/search/set-up/api-key-and-endpoints.md | ||
| --> | ||
|
|
||
| A personal API key authenticates your client with your own privileges when it sends requests to {{es}}. The following steps show you where to create one for your deployment type. | ||
|
|
||
| :::::{applies-switch} | ||
|
|
||
| ::::{applies-item} serverless: ga | ||
|
|
||
| Follow these steps to create an API key for your project. | ||
|
|
||
| 1. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), find your project and select **Open**. | ||
| 2. From the **Help menu** {icon}`question`, select **Connection details**. | ||
| 3. Select the **API key** tab. | ||
| 4. In the **API key name** field, enter a name, then select **Create API key**. | ||
| 5. Select an **API key format**: **Encoded** for {{es}} REST API requests, or **{{beats}}** or **{{ls}}** to configure those products. | ||
| 6. Copy the key. It isn't available after you close the panel. | ||
|
|
||
| Keys created here expire in 90 days and carry your own privileges. To set an expiration or restrict privileges, select **Manage API keys** and create the key there instead. | ||
|
|
||
| :::{note} | ||
| You can also use an [{{ecloud}} API key](/deploy-manage/api-keys/elastic-cloud-api-keys.md) to access {{es}}. Use it when the same key needs to access more than one project, or when you use [{{cps}}](/deploy-manage/cross-project-search-config/cps-config-access-and-scope.md#manage-user-and-api-key-access). | ||
| ::: | ||
| :::: | ||
|
|
||
| ::::{applies-item} ech: ga | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can we unify the tabs where the procedure is identical?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We discussed this and decided to keep separate tabs even where the steps are the same. The endpoint and API key sections use the same deployment tabs, and those tabs stay in sync. If a reader selects Elastic Cloud Hosted for the endpoint, the API key section switches to Elastic Cloud Hosted too, so they only see the steps for their deployment. Combining identical procedures into one tab would break that. |
||
|
|
||
| Follow these steps to create an API key for {{ech}}. | ||
|
|
||
| 1. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), find your deployment and select **Open**. | ||
| 2. From the **Help menu** {icon}`question`, select **Connection details**. | ||
| 3. Select the **API key** tab. | ||
| 4. In the **API key name** field, enter a name, then select **Create API key**. | ||
| 5. Select an **API key format**: **Encoded** for {{es}} REST API requests, or **{{beats}}** or **{{ls}}** to configure those products. | ||
| 6. Copy the key. It isn't available after you close the panel. | ||
|
|
||
| Keys created here expire in 90 days and carry your own privileges. To set an expiration or restrict privileges, select **Manage API keys** and create the key there instead. | ||
| :::: | ||
|
|
||
| ::::{applies-item} ece: ga | ||
|
|
||
| Follow these steps to create an API key for {{ece}}. | ||
|
|
||
| 1. Open {{kib}} for your deployment or project. | ||
| 2. From the **Help menu** {icon}`question`, select **Connection details**. | ||
| 3. Select the **API key** tab. | ||
| 4. In the **API key name** field, enter a name, then select **Create API key**. | ||
| 5. Select an **API key format**: **Encoded** for {{es}} REST API requests, or **{{beats}}** or **{{ls}}** to configure those products. | ||
| 6. Copy the key. It isn't available after you close the panel. | ||
|
|
||
| Keys created here expire in 90 days and carry your own privileges. To set an expiration or restrict privileges, select **Manage API keys** and create the key there instead. | ||
| :::: | ||
|
|
||
| ::::{applies-item} {"deployment": {"self": "ga"}} | ||
|
|
||
| Follow these steps to create an API key for a self-managed cluster, one you install and manage. | ||
|
|
||
| 1. Go to the **API keys** management page, using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md) to find it. | ||
| 2. Select **Create API key**. | ||
| 3. Enter a name, then select **Create API key**. | ||
| 4. Copy the key. It isn't available after you leave the page. | ||
|
|
||
| Keys created here don't expire unless you add an expiration date. | ||
| :::: | ||
|
|
||
| ::::{applies-item} {"deployment": {"eck": "ga"}} | ||
|
|
||
| Follow these steps to create an API key for {{eck}}. | ||
|
|
||
| 1. Go to the **API keys** management page, using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md) to find it. | ||
| 2. Select **Create API key**. | ||
| 3. Enter a name, then select **Create API key**. | ||
| 4. Copy the key. It isn't available after you leave the page. | ||
|
|
||
| Keys created here don't expire unless you add an expiration date. | ||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| For privileges and expiration options, refer to [](/deploy-manage/api-keys.md). | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| <!-- | ||
| This snippet is in use in the following locations: | ||
| - solutions/elasticsearch-solution-project/search-connection-details.md | ||
| - solutions/search/set-up/api-key-and-endpoints.md | ||
| --> | ||
|
|
||
| :::::::{applies-switch} | ||
|
|
||
| ::::::{applies-item} serverless: ga | ||
| Copy the {{es}} endpoint for your project from the project UI or the {{ecloud}} Console. | ||
|
|
||
| :::::{tab-set} | ||
|
|
||
| ::::{tab-item} Project UI | ||
|
|
||
| 1. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), find your project and select **Open**. | ||
| 2. From the **Help menu** {icon}`question` or the project selector in the header, select **Connection details**. | ||
| 3. On the **Endpoints** tab, copy the **{{es}} endpoint**. | ||
|
|
||
| :::{image} /solutions/images/kibana-connection-details-endpoints.png | ||
| :alt: The Connection details panel showing the {{es}} endpoint on the Endpoints tab, with the Show Cloud ID toggle and the API key tab | ||
| :screenshot: | ||
| :width: 50% | ||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ::::{tab-item} {{ecloud}} Console | ||
|
|
||
| 1. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), find your project and select **Manage**. | ||
| 2. Under **Application endpoints**, select **{{es}}**. | ||
| 3. Copy the **Direct endpoint** value. | ||
|
|
||
| :::{image} /solutions/images/cloud-console-serverless-endpoint.png | ||
| :alt: The Application endpoints panel in the {{ecloud}} Console, with {{es}} expanded to show the Direct endpoint and Direct Azure Private Link endpoint | ||
| :screenshot: | ||
| :width: 50% | ||
| ::: | ||
|
kosabogi marked this conversation as resolved.
|
||
|
|
||
| Azure and AWS also offer an endpoint you can use to connect to the deployment over a private connection. [Learn more about private connectivity](/deploy-manage/security/private-connectivity.md). | ||
|
|
||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| :::::: | ||
|
|
||
| ::::::{applies-item} ech: ga | ||
| Copy the {{es}} endpoint for {{ech}} from the deployment UI or the {{ecloud}} Console. | ||
|
|
||
| :::::{tab-set} | ||
|
|
||
| ::::{tab-item} {{kib}} UI | ||
|
|
||
| 1. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), find your deployment and select **Open**. | ||
| 2. From the **Help menu** {icon}`question`, select **Connection details**. | ||
| 3. On the **Endpoints** tab, copy the **{{es}} endpoint** value. | ||
|
|
||
| :::{image} /solutions/images/kibana-connection-details-endpoints.png | ||
| :alt: The Connection details panel showing the {{es}} endpoint on the Endpoints tab, with the Show Cloud ID toggle and the API key tab | ||
| :screenshot: | ||
| :width: 50% | ||
| ::: | ||
|
|
||
| :::{tip} | ||
| When the space uses the **{{es}}** solution view, the **Getting started** page shows the endpoint directly. | ||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ::::{tab-item} {{ecloud}} Console | ||
|
|
||
| 1. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), find your deployment and select **Manage**. | ||
| 2. Under **Application endpoints, cluster and component IDs**, select **{{es}}**. | ||
| 3. Copy the **Direct endpoint** value. | ||
|
|
||
| :::{image} /solutions/images/cloud-console-hosted-endpoint.png | ||
| :alt: The Application endpoints, cluster and component IDs panel in the {{ecloud}} Console, with {{es}} expanded to show the Endpoint, Direct endpoint, and Cluster ID | ||
| :screenshot: | ||
| :width: 50% | ||
| ::: | ||
|
kosabogi marked this conversation as resolved.
|
||
|
|
||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| :::::: | ||
|
|
||
| ::::::{applies-item} ece: ga | ||
|
|
||
| :::::{tab-set} | ||
|
|
||
| ::::{tab-item} {{kib}} | ||
|
|
||
| For {{ece}}, your endpoint details are in the **Connection details** panel in {{kib}}. | ||
|
kosabogi marked this conversation as resolved.
|
||
|
|
||
| 1. Open {{kib}} for your deployment. | ||
| 2. From the **Help menu** {icon}`question`, select **Connection details**. | ||
| 3. Copy the **{{es}} endpoint** from the **Endpoints** tab. | ||
|
|
||
| :::{image} /solutions/images/kibana-connection-details-endpoints.png | ||
| :alt: The Connection details panel showing the {{es}} endpoint on the Endpoints tab, with the Show Cloud ID toggle and the API key tab | ||
| :screenshot: | ||
| :width: 50% | ||
| ::: | ||
|
|
||
| :::{tip} | ||
| When the space uses the **{{es}}** solution view, the **Getting started** page shows the endpoint directly. | ||
|
kosabogi marked this conversation as resolved.
|
||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ::::{tab-item} Cloud UI | ||
|
|
||
| To connect to your {{es}} cluster, copy the **{{es}} endpoint** from the deployment page in the [Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). | ||
|
|
||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| :::::: | ||
|
|
||
| ::::{applies-item} {"deployment": {"self": "ga"}} | ||
| For a self-managed cluster, one you install and manage, your endpoint takes the form `<scheme>://<host>:<port>`. Each part comes from your cluster's HTTP settings: | ||
|
|
||
| * **Scheme**: `https` when TLS is enabled on the HTTP layer, and `http` when it isn't. TLS is enabled by default on first startup through [automatic security setup](/deploy-manage/security/self-auto-setup.md), unless the setup is [explicitly skipped](/deploy-manage/security/self-auto-setup.md#stack-skip-auto-configuration) or disabled, as in the local development quickstart. | ||
| * **Host**: The address clients use to reach the node, set by [`http.host` or `network.host`](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md). | ||
| * **Port**: The HTTP port, set by [`http.port`](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md). It defaults to the range `9200-9300`, and a node binds to the first free port in that range. | ||
|
|
||
| For example, a single-node cluster from the [local development quickstart](/deploy-manage/deploy/self-managed/local-development-installation-quickstart.md) runs without TLS on the default port, so its endpoint is `http://localhost:9200`. | ||
|
|
||
| If clients reach your cluster through a load balancer, reverse proxy, or ingress, use that address rather than the node address. | ||
| :::: | ||
|
|
||
| ::::{applies-item} {"deployment": {"eck": "ga"}} | ||
| The ECK operator automatically creates a service for your {{es}} cluster with TLS enabled. Your endpoint URL depends on where your application runs: | ||
|
|
||
| - **Inside the same Kubernetes namespace**: `https://<cluster-name>-es-http:9200` | ||
| - **In a different namespace**: `https://<cluster-name>-es-http.<namespace>.svc:9200` | ||
| - **Outside the Kubernetes cluster**: You need to expose the service first. Refer to [Access the endpoint](/deploy-manage/deploy/cloud-on-k8s/accessing-services.md#k8s-request-elasticsearch-endpoint) for setup steps. | ||
|
|
||
| To find your cluster name, run `kubectl get svc` and look for the service ending in `-es-http`. | ||
| :::: | ||
|
|
||
| ::::::: | ||
Uh oh!
There was an error while loading. Please reload this page.