Skip to content

Commit d7bdaa4

Browse files
mergify[bot]karenzonerobbavey
authored
Doc: Update svrless docs to use endpoint url (#18773) (#18791)
(cherry picked from commit b39e61e) Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com> Co-authored-by: Rob Bavey <rob.bavey@elastic.co>
1 parent 2c2ee7e commit d7bdaa4

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

docs/reference/connecting-to-serverless.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,29 @@ Set the value to port :443 instead.
2525
## Communication between {{ls}} and {{es-serverless}} [connecting-to-elasticsearch-serverless]
2626

2727
[{{es-serverless}}](docs-content://solutions/search/serverless-elasticsearch-get-started.md) simplifies safe, secure communication between {{ls}} and {{es}}.
28-
When you configure the Elasticsearch output plugin to use [`cloud_id`](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-cloud_id) and an [`api_key`](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-api_key), no additional SSL configuration is needed.
28+
To send data to a {{serverless-short}} project, configure the {{ls}} {{es}} output plugin to connect using the project's **{{es}} endpoint URL** and an **API key**.
2929

30-
Example:
30+
```ruby
31+
output {elasticsearch { hosts => "ELASTICSEARCH_ENDPOINT_URL" api_key => "<api key>" } }
32+
```
3133

32-
* `output {elasticsearch { cloud_id => "<cloud id>" api_key => "<api key>" } }`
34+
The value of the [`api_key` option](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-api_key) is in the format `id:api_key`, where `id` and `api_key` are the values returned by the [Create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key).
3335

34-
Note that the value of the [`api_key` option](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-api_key) is in the format `id:api_key`, where `id` and `api_key` are the values returned by the [Create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key).
3536

37+
### {{es}} endpoint URL
3638

37-
### Cloud ID [cloud-id]
39+
1. Log in to [Elastic Cloud](https://cloud.elastic.co/).
3840

39-
{{ls}} uses the Cloud ID, found in the Elastic Cloud web console, to build the Elasticsearch and Kibana hosts settings. It is a base64 encoded text value of about 120 characters made up of upper and lower case letters and numbers. If you have several Cloud IDs, you can add a label, which is ignored internally, to help you tell them apart. To add a label, prefix your Cloud ID with a label and a `:` separator in this format "<label>:<cloud-id>".
41+
2. Find your **{{es}} endpoint URL**:
4042

43+
Select **Manage** next to your project. Then find the {{es}} endpoint under **Application endpoints, cluster and component IDs**.
4144

42-
### API key [api-key]
45+
Alternatively, open your project, select the help icon, then select **Connection details**.
46+
47+
48+
### API key [api-key]
49+
50+
Create an **API key** with the appropriate privileges. Refer to [Create API key](docs-content://solutions/search/search-connection-details.md#create-an-api-key-serverless) for detailed steps. For information on the required privileges, refer to [Grant access using API keys](/reference/secure-connection.md#ls-create-api-key).
4351

4452
When you create an API key for {{ls}}, select **Logstash** from the **API key format** dropdown.
4553
This option formats the API key in the correct `id:api_key` format required by {{ls}}.
@@ -50,24 +58,18 @@ This option formats the API key in the correct `id:api_key` format required by {
5058
:width: 400px
5159
:::
5260

53-
The UI for API keys may look different depending on the deployment type.
54-
55-
## Using Cloud ID with plugins [cloud-id-serverless]
56-
57-
The Elasticsearch input, output, and filter plugins, as well as the Elastic_integration filter plugin, support cloud_id in their configurations.
58-
59-
* [Elasticsearch input plugin](logstash-docs-md://lsr/plugins-inputs-elasticsearch.md#plugins-inputs-elasticsearch-cloud_id)
60-
* [Elasticsearch filter plugin](logstash-docs-md://lsr/plugins-filters-elasticsearch.md#plugins-filters-elasticsearch-cloud_id)
61-
* [Elasticsearch output plugin](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-cloud_id)
62-
* [Elastic_integration filter plugin](logstash-docs-md://lsr/plugins-filters-elastic_integration.md#plugins-filters-elastic_integration-cloud_id)
63-
64-
61+
:::{note}
62+
The [Elasticsearch input](logstash-docs-md://lsr/plugins-inputs-elasticsearch.md#plugins-inputs-elasticsearch-api_key),
63+
[Elasticsearch output](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-api_key), and
64+
[Elasticsearch filter](logstash-docs-md://lsr/plugins-filters-elasticsearch.md#plugins-filters-elasticsearch-api_key) plugins, as well as the
65+
[Elastic_integration filter](logstash-docs-md://lsr/plugins-filters-elastic_integration.md#plugins-filters-elastic_integration-api_key) plugin, all support the `api_key` option in their configurations.
66+
:::
6567

6668
## Using {{ls}} Central Pipeline Management with {{es-serverless}} [cpm-serverless]
6769

68-
This setting in the `logstash.yml` config file can help you get set up to use Central Pipeline management in Elastic Cloud:
69-
70-
* `xpack.management.elasticsearch.cloud_id`
71-
72-
You can use the `xpack.management.elasticsearch.cloud_id` setting as an alternative to `xpack.management.elasticsearch.hosts`.
70+
To set up Central Pipeline management in {{es-serverless}}, update the `logstash.yml` config file to provide the API key and set the value for `xpack.management.elasticsearch.hosts` to your Elasticsearch endpoint URL.
7371

72+
```ruby
73+
xpack.management.elasticsearch.hosts: "ELASTICSEARCH_ENDPOINT_URL" # Use the `hosts` option with the Elasticsearch endpoint URL to connect to Elasticsearch Serverless
74+
xpack.management.elasticsearch.api_key: "<api_key>" # API key formatted for Logstash: `id:api_key`
75+
```

0 commit comments

Comments
 (0)